POST /sale-invoices.json
POST
/sale-invoices.json
Body Required
-
accountingIntegrationExternalId boolean | null
Accounting integration external
-
externalId string | null
External
-
finalized boolean | null Required
Finalized
Default value is
false
. -
paid number Required
Paid
Default value is
0
. -
paymentStatus string Required
Payment status
Values are
notPaid
,partiallyPaid
, orpaid
. Default value isnotPaid
. -
quickbooksId string | null
Quickbooks
-
reference string Required
Reference
-
saleId integer(int32) Required
Sale
-
xeroId string | null
Xero
POST /sale-invoices.json
curl \
-X POST http://api.example.com/v1/sale-invoices.json \
-H "Content-Type: application/json" \
-d '{"accountingIntegrationExternalId":true,"externalId":"string","finalized":false,"paid":0,"paymentStatus":"notPaid","quickbooksId":"string","reference":"string","saleId":42,"xeroId":"string"}'
Request example
{
"accountingIntegrationExternalId": true,
"externalId": "string",
"finalized": false,
"paid": 0,
"paymentStatus": "notPaid",
"quickbooksId": "string",
"reference": "string",
"saleId": 42,
"xeroId": "string"
}
Response examples (200)
{
"accountingIntegrationExternalId": true,
"createdAt": "2023-05-04T09:42:00+00:00",
"externalId": "string",
"finalized": false,
"id": 42,
"paid": 0,
"paymentStatus": "notPaid",
"quickbooksId": "string",
"reference": "string",
"saleId": 42,
"updatedAt": "2023-05-04T09:42:00+00:00",
"xeroId": "string"
}