POST /sale-invoice-payments.json

application/json

Body Required

amount number Required

Amount

Default value is 0.
exchangeRate number(float) Required

Exchange rate

Default value is 1.
externalId string | null

External
paidAt string(date-time) Required

Paid at

Default value is {} (empty).
paymentMethodId integer(int32) | null

Payment method
reference string | null

Reference
saleInvoiceId integer(int32) Required

Sale invoice
xeroId string | null

Xero

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- amount number Required
  
  Amount
  
  Default value is 0.
- createdAt string(date-time) | null
  
  Created at
- exchangeRate number(float) Required
  
  Exchange rate
  
  Default value is 1.
- externalId string | null
  
  External
- id integer(int32)
  
  Id
- paidAt string(date-time) Required
  
  Paid at
  
  Default value is {} (empty).
- paymentMethodId integer(int32) | null
  
  Payment method
- reference string | null
  
  Reference
- saleInvoiceId integer(int32) Required
  
  Sale invoice
- updatedAt string(date-time) | null
  
  Updated at
- xeroId string | null
  
  Xero

POST /sale-invoice-payments.json

curl \
 --request POST 'http://api.example.com/v1/sale-invoice-payments.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"amount":0,"exchangeRate":1,"externalId":"string","paidAt":{},"paymentMethodId":42,"reference":"string","saleInvoiceId":42,"xeroId":"string"}'

Request examples

{
  "amount": 0,
  "exchangeRate": 1,
  "externalId": "string",
  "paidAt": {},
  "paymentMethodId": 42,
  "reference": "string",
  "saleInvoiceId": 42,
  "xeroId": "string"
}

Response examples (200)

{
  "amount": 0,
  "createdAt": "2025-05-04T09:42:00Z",
  "exchangeRate": 1,
  "externalId": "string",
  "id": 42,
  "paidAt": {},
  "paymentMethodId": 42,
  "reference": "string",
  "saleInvoiceId": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "xeroId": "string"
}