Sign in
Invoice

Partially update an invoice

patch/api/invoices/{invoiceId}

Path parameters

invoiceIdstring required

Response

Invoice item

idstring required

Unique id associated to this entity.

numberinteger required

Number

status'new' | 'needsApproval' | 'approved' | 'issued' | 'paid' required

Invoice status

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.

externalReferencesobject nullable

External references associated with this entity.

paymentTermsIdstring nullable

Payment terms key identifier. Please reference /api/payment-terms endpoint.

companyInfoIdstring nullable

Company Information Id;

salesOrderIdstring nullable

Sales order identifier. Please reference /api/sales-orders endpoint.

customerPONumberstring nullable

Customer PO number.

dueDatestring date-time nullable

Invoice due date.

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.

isDepositboolean

Is deposit invoice

deletedboolean

Indicates whether this invoice has been deleted

Changes

Changed in 2 of the 23 revisions of this API.12

  • d743ab8b105f11See the full diff
    • ▲

      the / request property type changed from string to no type

      request-property-type-changed

    • ○

      added the new optional request property /

      new-optional-request-property

  • c002514312371See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added