Skip to main content
PUT
Update Invoice

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Body

lines
object[]
required
invoice_date
string<date>
required
due_date
string<date>
required
entity
integer
required
invoice_number
string
revenue_transactions
integer[]
write-only
item_date
string<date> | null
migrated_journal_id
integer | null
write-only
department
integer | null
write-only
department_name
string | null
write-only
tags
integer[]
write-only
chat_uuid
string<uuid>
write-only
auto_send_invoice
boolean | null
auto_send_invoice_at
string<date> | null
reminder_sent_dates
any

Dictionary tracking when reminders were sent for each day overdue (e.g., {'5': '2024-01-15', '10': '2024-01-20'})

pre_due_reminder_sent_dates
any

Dictionary tracking when pre-due reminders were sent for each day before due date (e.g., {'3': '2024-01-10', '7': '2024-01-06'})

billing_address
string | null
billing_addressee
string | null
Maximum string length: 255
shipping_address
string | null
shipping_addressee
string | null
Maximum string length: 255
terms
  • custom - Custom
  • net_5 - Net 5
  • net_7 - Net 7
  • net_10 - Net 10
  • net_15 - Net 15
  • net_20 - Net 20
  • net_30 - Net 30
  • net_40 - Net 40
  • net_45 - Net 45
  • net_60 - Net 60
  • net_90 - Net 90
  • net_105 - Net 105
  • net_120 - Net 120
  • due_on_receipt - Due on Receipt
Available options:
custom,
net_5,
net_7,
net_10,
net_15,
net_20,
net_30,
net_40,
net_45,
net_60,
net_90,
net_105,
net_120,
due_on_receipt
ref_number
string | null
Maximum string length: 120
purchase_order_number
string | null
Maximum string length: 120
shipping_date
string<date> | null
paid_date
string<date> | null
uncollectible_date
string<date> | null
period_start
string<date> | null
period_end
string<date> | null
location_of_sale
string | null
message_on_invoice
string | null
ita_allocation_number
string | null
Maximum string length: 9
Pattern: ^\d{9}$
payment_status
  • draft - Draft
  • open - Open
  • sent - Sent
  • partial - Partially Paid
  • paid - Paid
  • uncollectible - Uncollectible
  • voided - Voided
Available options:
draft,
open,
sent,
partial,
paid,
uncollectible,
voided
anrok_transaction_id
string | null

ID of the transaction in Anrok (set when transaction is created)

Maximum string length: 255
warning_message
string | null
currency
string
Maximum string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
integration_id
string | null
Maximum string length: 250
integration_context
unknown
vat_number
string | null
Maximum string length: 250
discount
number<double> | null

Discount amount for the invoice

Required range: -1000000000000000000 < x < 1000000000000000000
payment_term_applied_discount
number<double> | null

Discount amount applied based on payment term early payment discount

Required range: -1000000000000000000 < x < 1000000000000000000
use_stripe_auto_bill
boolean | null
Maximum string length: 500
stripe_payment_intent_id
string | null
Maximum string length: 500
stripe_invoice_id
string | null
Maximum string length: 500
stripe_pdf_url
string | null
Maximum string length: 500
Maximum string length: 500
source
string | null
Maximum string length: 250
source_id
string | null
is_migrated
boolean

True for invoices imported via opening balance migration (no finalization JE).

voided_date
string<date> | null
invoice_labels
unknown
invoice_language
string | null
Maximum string length: 10
chat_id
integer | null
Required range: -2147483648 <= x <= 2147483647
client
integer | null
payment_term
integer | null
contract
integer | null
avalara_connection
integer | null
sphere_connection
integer | null
anrok_connection
integer | null
tax_rate
integer | null
stripe_connection
integer | null
source_file
integer | null

Response

200 - application/json
id
integer
required
read-only
lines
object[]
required
emails
object[]
required
read-only
payments
object[]
required
read-only
payment_journal_entries
integer[]
required
read-only
journal_entry_intercompany
string
required
read-only
client_name
string
required
read-only
client_campfire_id
string | null
required
read-only
client_email
string
required
read-only
anrok_customer_id
string
required
read-only
client_invoice_message
string
required
read-only
client_use_stripe_auto_bill
boolean
required
read-only
public_invoice_payment_url
string | null
required
read-only
status
string
required
read-only
past_due_days
integer | null
required
read-only
entity_name
string
required
read-only
entity_currency
string
required
read-only
entity_invoice_message
string | null
required
read-only
total_amount
number<double>
required
read-only
Required range: -1000000000000000000 < x < 1000000000000000000
amount_paid
number<double>
required
read-only
Required range: -1000000000000000000 < x < 1000000000000000000
amount_due
number<double>
required
read-only
withholding_info
object | null
required
read-only

Withholding context for the invoice's entity.

estimated_withholding_amount covers only the remaining amount due (null once fully paid); withheld_to_date is the signed sum of posted withholding, so actuals replace the estimate as receipts come in. Certificate-based schemes estimate from the entity certificate's rate (falling back to the scheme default); rules-based schemes sum each line's selected rate over the line amount, scaled by the remaining-due proportion.

contract_name
string
required
read-only
attachments
object[]
required
read-only
stripe_connection_name
string
required
read-only
stripe_connection_entity
integer
required
read-only
stripe_connection_billing_portal_enabled
boolean
required
read-only
avalara_connection_name
string
required
read-only
avalara_connection_company
string
required
read-only
tax_rate_name
string
required
read-only
tax_rate_value
number<double>
required
read-only
Required range: -1000000 < x < 1000000
payment_term_name
string
required
read-only
voided_journal_entry_order
integer | null
required
read-only
contract_custom_fields
object[]
required
read-only
last_modified_at
string<date-time>
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
search_vector
string | null
required
read-only
search_text
string | null
required
read-only
auto_sent_at
string<date-time> | null
required
read-only
invoice_date
string<date>
required
due_date
string<date>
required
sent_date
string<date> | null
required
read-only
created_at
string<date-time>
required
read-only
last_sent_at
string<date-time> | null
required
read-only
customer
integer
required
read-only
entity
integer
required
bad_debt_journal_entry
integer | null
required
read-only
journal_entry
integer | null
required
read-only
ar_account
integer | null
required
read-only

Accounts Receivable account for this invoice. Populated for single-AR and migrated invoices. NULL for multi-AR invoices (aging uses ChartTransactions instead).

voided_journal_entry
integer | null
required
read-only
entity_transfer_journal_entry
integer | null
required
read-only
invoice_number
string
item_date
string<date> | null
auto_send_invoice
boolean | null
auto_send_invoice_at
string<date> | null
reminder_sent_dates
any

Dictionary tracking when reminders were sent for each day overdue (e.g., {'5': '2024-01-15', '10': '2024-01-20'})

pre_due_reminder_sent_dates
any

Dictionary tracking when pre-due reminders were sent for each day before due date (e.g., {'3': '2024-01-10', '7': '2024-01-06'})

billing_address
string | null
billing_addressee
string | null
Maximum string length: 255
shipping_address
string | null
shipping_addressee
string | null
Maximum string length: 255
terms
  • custom - Custom
  • net_5 - Net 5
  • net_7 - Net 7
  • net_10 - Net 10
  • net_15 - Net 15
  • net_20 - Net 20
  • net_30 - Net 30
  • net_40 - Net 40
  • net_45 - Net 45
  • net_60 - Net 60
  • net_90 - Net 90
  • net_105 - Net 105
  • net_120 - Net 120
  • due_on_receipt - Due on Receipt
Available options:
custom,
net_5,
net_7,
net_10,
net_15,
net_20,
net_30,
net_40,
net_45,
net_60,
net_90,
net_105,
net_120,
due_on_receipt
ref_number
string | null
Maximum string length: 120
purchase_order_number
string | null
Maximum string length: 120
shipping_date
string<date> | null
paid_date
string<date> | null
uncollectible_date
string<date> | null
period_start
string<date> | null
period_end
string<date> | null
location_of_sale
string | null
message_on_invoice
string | null
ita_allocation_number
string | null
Maximum string length: 9
Pattern: ^\d{9}$
payment_status
  • draft - Draft
  • open - Open
  • sent - Sent
  • partial - Partially Paid
  • paid - Paid
  • uncollectible - Uncollectible
  • voided - Voided
Available options:
draft,
open,
sent,
partial,
paid,
uncollectible,
voided
anrok_transaction_id
string | null

ID of the transaction in Anrok (set when transaction is created)

Maximum string length: 255
warning_message
string | null
currency
string
Maximum string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
integration_id
string | null
Maximum string length: 250
integration_context
unknown
vat_number
string | null
Maximum string length: 250
discount
number<double> | null

Discount amount for the invoice

Required range: -1000000000000000000 < x < 1000000000000000000
payment_term_applied_discount
number<double> | null

Discount amount applied based on payment term early payment discount

Required range: -1000000000000000000 < x < 1000000000000000000
use_stripe_auto_bill
boolean | null
Maximum string length: 500
stripe_payment_intent_id
string | null
Maximum string length: 500
stripe_invoice_id
string | null
Maximum string length: 500
stripe_pdf_url
string | null
Maximum string length: 500
Maximum string length: 500
source
string | null
Maximum string length: 250
source_id
string | null
is_migrated
boolean

True for invoices imported via opening balance migration (no finalization JE).

voided_date
string<date> | null
invoice_labels
unknown
invoice_language
string | null
Maximum string length: 10
chat_id
integer | null
Required range: -2147483648 <= x <= 2147483647
client
integer | null
payment_term
integer | null
contract
integer | null
avalara_connection
integer | null
sphere_connection
integer | null
anrok_connection
integer | null
tax_rate
integer | null
stripe_connection
integer | null
source_file
integer | null