Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • accountingError string | null

    Accounting error

  • accountingIntegrationExternalId boolean | null

    Accounting integration external

  • accountingProblem object | null | array | boolean | integer | number | string

    Accounting problem

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  • adjustment number | null

    Adjustment

  • adjustmentReason string | null

    Adjustment reason

  • commissionMethod string | null Required

    Commission method

    Values are retained or reverse. Default value is retained.

  • createdAt string(date-time) | null

    Created at

  • externalId string | null

    External

  • files object | null | array | boolean | integer | number | string

    Files

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  • finalized boolean | null Required

    Finalized

    Default value is false.

  • id integer(int32)

    Id

  • invoiceShippingProblem object | null | array | boolean | integer | number | string

    Invoice shipping problem

    Any of:

    object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  • invoiceShippingSource string | null

    Invoice shipping source

    Values are shippingRate, dropshipment, customer, or transaction.

  • invoicingStage string | null Required

    Invoicing stage

    Values are beforeShipping, afterShipping, delivered, or manual. Default value is manual.

  • paid number Required

    Paid

    Default value is 0.

  • paymentStatus string Required

    Payment status

    Values are notPaid, partiallyPaid, or paid. Default value is notPaid.

  • purchaseId integer(int32) Required

    Purchase

  • quickbooksId string | null

    Quickbooks

  • reference string Required

    Reference

  • saleReturnId integer(int32) | null

    Sale return

  • saleReturnInvoiceShippingSource string | null

    Sale return invoice shipping source

    Value is transaction.

  • saleReturnItemId integer(int32) | null

    Sale return item

  • source string | null Required

    Source

    Values are manual, automated, or catchup. Default value is automated.

  • transactionId integer(int32) | null

    Transaction

  • updatedAt string(date-time) | null

    Updated at

  • xeroId string | null

    Xero