v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Receivable

Partial Update Invoice

    Performs a partial update of an existing accounting invoice using PATCH semantics.

    This endpoint allows selective modification of invoice fields without requiring
    a complete invoice replacement. You can update specific aspects of the invoice while
    leaving other fields unchanged.

    **Updatable Fields:**
    - Invoice metadata (dates, terms, descriptions, client, entity, currency)
    - Line items (amounts, accounts, descriptions, departments, products)
    - Payment terms and due dates
    - Tax calculations and allocations
    - Custom fields and tags
    - Contract and purchase order associations
    - Exchange rates and currency information

patch/coa/api/v1/invoice/{id}/

Path parameters

idinteger required

Request body

idinteger

emailsobject[]

payment_journal_entriesinteger[]

journal_entry_intercompanystring

client_namestring

client_campfire_idstring nullable

client_emailstring

anrok_customer_idstring

client_invoice_messagestring

client_use_stripe_auto_billboolean

public_invoice_payment_urlstring nullable

statusstring

past_due_daysinteger nullable

entity_namestring

entity_currencystring

entity_invoice_messagestring nullable

total_amountnumber double

amount_paidnumber double

amount_duenumber double

withholding_infoobject nullable

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_namestring

invoice_numberstring

stripe_connection_namestring

stripe_connection_entityinteger

stripe_connection_billing_portal_enabledboolean

avalara_connection_namestring

avalara_connection_companystring

tax_rate_namestring

tax_rate_valuenumber double

payment_term_namestring

revenue_transactionsinteger[]

item_datestring date nullable

migrated_journal_idinteger nullable

voided_journal_entry_orderinteger nullable

contract_custom_fieldsobject[]

departmentinteger nullable

department_namestring nullable

tagsinteger[]

last_modified_atstring date-time

is_deletedboolean

deleted_atstring date-time nullable

chat_uuidstring uuid

search_vectorstring nullable

search_textstring nullable

auto_send_invoiceboolean nullable

auto_send_invoice_atstring date nullable

auto_sent_atstring date-time nullable

{"stackTrail":"components:schemas:PatchedAccountingInvoice:properties:reminder_sent_dates","oasType":"schema","type":"unknown","description":"Dictionary tracking when reminders were sent for each day overdue (e.g., {'5': '2024-01-15', '10': '2024-01-20'})"}

{"stackTrail":"components:schemas:PatchedAccountingInvoice:properties:pre_due_reminder_sent_dates","oasType":"schema","type":"unknown","description":"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_addressstring nullable

billing_addresseestring nullable

shipping_addressstring nullable

shipping_addresseestring nullable

ref_numberstring nullable

purchase_order_numberstring nullable

invoice_datestring date

due_datestring date

shipping_datestring date nullable

paid_datestring date nullable

uncollectible_datestring date nullable

sent_datestring date nullable

period_startstring date nullable

period_endstring date nullable

location_of_salestring nullable

message_on_invoicestring nullable

ita_allocation_numberstring nullable

anrok_transaction_idstring nullable

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

warning_messagestring nullable

created_atstring date-time

currencystring

exchange_ratenumber double nullable

exchange_rate_booknumber double nullable

last_sent_atstring date-time nullable

integration_idstring nullable

{"stackTrail":"components:schemas:PatchedAccountingInvoice:properties:integration_context","oasType":"schema","type":"unknown","nullable":true}

vat_numberstring nullable

discountnumber double nullable

Discount amount for the invoice

payment_term_applied_discountnumber double nullable

Discount amount applied based on payment term early payment discount

use_stripe_auto_billboolean nullable

stripe_payment_link_idstring nullable

stripe_payment_intent_idstring nullable

stripe_invoice_idstring nullable

stripe_pdf_urlstring nullable

stripe_payment_linkstring nullable

sourcestring nullable

source_idstring nullable

is_migratedboolean

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

voided_datestring date nullable

{"stackTrail":"components:schemas:PatchedAccountingInvoice:properties:invoice_labels","oasType":"schema","type":"unknown","nullable":true}

invoice_languagestring nullable

chat_idinteger nullable

customerinteger

entityinteger

clientinteger nullable

payment_terminteger nullable

bad_debt_journal_entryinteger nullable

journal_entryinteger nullable

ar_accountinteger nullable

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

voided_journal_entryinteger nullable

entity_transfer_journal_entryinteger nullable

contractinteger nullable

avalara_connectioninteger nullable

sphere_connectioninteger nullable

anrok_connectioninteger nullable

tax_rateinteger nullable

stripe_connectioninteger nullable

source_fileinteger nullable

Response

idinteger required

emailsobject[] required

payment_journal_entriesinteger[] required

journal_entry_intercompanystring required

client_namestring required

client_campfire_idstring nullable required

client_emailstring required

anrok_customer_idstring required

client_invoice_messagestring required

client_use_stripe_auto_billboolean required

public_invoice_payment_urlstring nullable required

statusstring required

past_due_daysinteger nullable required

entity_namestring required

entity_currencystring required

entity_invoice_messagestring nullable required

total_amountnumber double required

amount_paidnumber double required

amount_duenumber double required

withholding_infoobject nullable required

Withholding context for the invoice's entity.

contract_namestring required

invoice_numberstring

stripe_connection_namestring required

stripe_connection_entityinteger required

stripe_connection_billing_portal_enabledboolean required

avalara_connection_namestring required

avalara_connection_companystring required

tax_rate_namestring required

tax_rate_valuenumber double required

payment_term_namestring required

revenue_transactionsinteger[]

item_datestring date nullable

migrated_journal_idinteger nullable

voided_journal_entry_orderinteger nullable required

contract_custom_fieldsobject[] required

departmentinteger nullable

department_namestring nullable

tagsinteger[]

last_modified_atstring date-time required

is_deletedboolean required

deleted_atstring date-time nullable required

chat_uuidstring uuid

search_vectorstring nullable required

search_textstring nullable required

auto_send_invoiceboolean nullable

auto_send_invoice_atstring date nullable

auto_sent_atstring date-time nullable required

{"stackTrail":"components:schemas:AccountingInvoice:properties:reminder_sent_dates","oasType":"schema","type":"unknown","description":"Dictionary tracking when reminders were sent for each day overdue (e.g., {'5': '2024-01-15', '10': '2024-01-20'})"}

{"stackTrail":"components:schemas:AccountingInvoice:properties:pre_due_reminder_sent_dates","oasType":"schema","type":"unknown","description":"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_addressstring nullable

billing_addresseestring nullable

shipping_addressstring nullable

shipping_addresseestring nullable

ref_numberstring nullable

purchase_order_numberstring nullable

invoice_datestring date required

due_datestring date required

shipping_datestring date nullable

paid_datestring date nullable

uncollectible_datestring date nullable

sent_datestring date nullable required

period_startstring date nullable

period_endstring date nullable

location_of_salestring nullable

message_on_invoicestring nullable

ita_allocation_numberstring nullable

anrok_transaction_idstring nullable

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

warning_messagestring nullable

created_atstring date-time required

currencystring

exchange_ratenumber double nullable

exchange_rate_booknumber double nullable

last_sent_atstring date-time nullable required

integration_idstring nullable

{"stackTrail":"components:schemas:AccountingInvoice:properties:integration_context","oasType":"schema","type":"unknown","nullable":true}

vat_numberstring nullable

discountnumber double nullable

Discount amount for the invoice

payment_term_applied_discountnumber double nullable

Discount amount applied based on payment term early payment discount

use_stripe_auto_billboolean nullable

stripe_payment_link_idstring nullable

stripe_payment_intent_idstring nullable

stripe_invoice_idstring nullable

stripe_pdf_urlstring nullable

stripe_payment_linkstring nullable

sourcestring nullable

source_idstring nullable

is_migratedboolean

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

voided_datestring date nullable

{"stackTrail":"components:schemas:AccountingInvoice:properties:invoice_labels","oasType":"schema","type":"unknown","nullable":true}

invoice_languagestring nullable

chat_idinteger nullable

customerinteger required

entityinteger required

clientinteger nullable

payment_terminteger nullable

bad_debt_journal_entryinteger nullable required

journal_entryinteger nullable required

ar_accountinteger nullable required

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

voided_journal_entryinteger nullable required

entity_transfer_journal_entryinteger nullable required

contractinteger nullable

avalara_connectioninteger nullable

sphere_connectioninteger nullable

anrok_connectioninteger nullable

tax_rateinteger nullable

stripe_connectioninteger nullable

source_fileinteger nullable