idstring required
Unique id associated to this entity.
status'new' | 'needsApproval' | 'approved' | 'issued' | 'paid' required
customerIdstring required
The id of the customer that the invoice is for. Please reference /api/customers endpoint.
issueDatestring date-time nullable
Invoice issued date indicates when the invoice was sent to the customer.
issuedByUserIdstring nullable
The id of the user who first issued the invoice; a later re-issue does not replace it.
Null when the invoice has never been issued. Please reference /api/users endpoint.
externalReferencesobject nullable
External references associated with this entity.
paymentTermsIdstring nullable
Payment terms key identifier. Please reference /api/payment-terms endpoint.
companyInfoIdstring nullable
salesOrderIdstring nullable
Sales order identifier. Please reference /api/sales-orders endpoint.
customerPONumberstring nullable
dueDatestring date-time nullable
totalnumber double required
The final amount due, calculated as the sum of all item costs, taxes, fees, and any discounts applied in primary currency.
subtotalnumber double required
The sum of the line items this invoice bills, in primary currency, before tax, the discount,
the deposit adjustment, the progress-billing adjustment and any refund are applied. On a
deposit invoice this is the sum of its deposit lines.
lineItemsTotalnumber double
The summation of the line item amounts due.
notesToCustomerstring nullable
A field for the seller to provide additional details or instructions for the customer relating to the order.
customFieldsobject nullable
Custom fields that have been defined on this entity.
deletedboolean
Indicates whether this invoice has been deleted