PUT /sale-invoices/{id}.json

PUT /sale-invoices/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

  • accountingIntegrationExternalId boolean | null

    Accounting integration external

  • createdAt string(date-time) | null

    Created at

  • externalId string | null

    External

  • finalized boolean | null Required

    Finalized

    Default value is false.

  • id integer(int32)

    Id

  • paid number Required

    Paid

    Default value is 0.

  • paymentStatus string Required

    Payment status

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

  • quickbooksId string | null

    Quickbooks

  • reference string Required

    Reference

  • saleId integer(int32) Required

    Sale

  • updatedAt string(date-time) | null

    Updated at

  • xeroId string | null

    Xero

PUT /sale-invoices/{id}.json
curl \
 --request PUT 'http://api.example.com/v1/sale-invoices/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"accountingIntegrationExternalId":true,"accountingProblem":{},"createdAt":"2025-05-04T09:42:00Z","externalId":"string","finalized":false,"id":42,"paid":0,"paymentStatus":"notPaid","quickbooksId":"string","reference":"string","saleId":42,"updatedAt":"2025-05-04T09:42:00Z","xeroId":"string"}'
Request examples
{
  "accountingIntegrationExternalId": true,
  "accountingProblem": {},
  "createdAt": "2025-05-04T09:42:00Z",
  "externalId": "string",
  "finalized": false,
  "id": 42,
  "paid": 0,
  "paymentStatus": "notPaid",
  "quickbooksId": "string",
  "reference": "string",
  "saleId": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "xeroId": "string"
}