Invoice data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
paid_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
refunded_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
cancelled_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
posted_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
invoice_numberstring
External identifier (ie. reference) for this invoice
referencestring
contact_idstring
(reference to AccountingContact)
currencystring
notesstring
refund_reasonstring
lineitems array
status enum
Valid values:
"DRAFT"
"VOIDED"
"AUTHORIZED"
"PAID"
"PARTIALLY_PAID"
urlstring
The public URL for the invoice to send to a customer to view or pay.
payment_collection_method enum
Valid values:
"send_invoice"
"charge_automatically"
When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.
type enum
Valid values:
"BILL"
"INVOICE"
"CREDITMEMO"
@deprecated; for bills, use AccountingBill instead
attachments array
sendboolean
organization_idstring
Are we missing anything? Let us know
Was this page helpful?