GET /sale-invoices/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- accountingIntegrationExternalId boolean | null
  
  Accounting integration external
- accountingProblem object | null | array | boolean | integer | number | string
  
  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
  
  Accounting problem
  
  Accounting problem
  
  Accounting problem
  
  Accounting problem
  
  Accounting problem
  
  Accounting problem
- 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

curl \
 -X GET http://api.example.com/v1/sale-invoices/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "accountingIntegrationExternalId": true,
  "accountingProblem": {},
  "createdAt": "2024-05-04T09:42:00+00:00",
  "externalId": "string",
  "finalized": false,
  "id": 42,
  "paid": 0,
  "paymentStatus": "notPaid",
  "quickbooksId": "string",
  "reference": "string",
  "saleId": 42,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "xeroId": "string"
}

GET /sale-invoices/{id}.json

Path parameters

Responses

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