Body
Required
-
Amount
Default value is
0
. -
Exchange rate
Default value is
1
. -
External
-
Paid at
Default value is
{}
(empty). -
Payment method
-
Purchase invoice
-
Purchase item
-
Reference
-
Status
Values are
active
orcancelled
. Default value isactive
. -
Transfer
-
Type
Values are
payment
,overpayment
,correction
,refund
, orrefundCommission
. Default value ispayment
. -
Xero
POST
/purchase-invoice-payments.json
curl \
--request POST 'http://api.example.com/v1/purchase-invoice-payments.json' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"amount":0,"exchangeRate":1,"externalId":"string","paidAt":{},"paymentMethodId":42,"purchaseInvoiceId":42,"purchaseItemId":42,"reference":"string","status":"active","totals":{},"transferId":"string","type":"payment","xeroId":"string"}'
Request examples
{
"amount": 0,
"exchangeRate": 1,
"externalId": "string",
"paidAt": {},
"paymentMethodId": 42,
"purchaseInvoiceId": 42,
"purchaseItemId": 42,
"reference": "string",
"status": "active",
"totals": {},
"transferId": "string",
"type": "payment",
"xeroId": "string"
}
Response examples (200)
{
"amount": 0,
"createdAt": "2025-05-04T09:42:00Z",
"exchangeRate": 1,
"externalId": "string",
"id": 42,
"paidAt": {},
"paymentMethodId": 42,
"purchaseInvoiceId": 42,
"purchaseItemId": 42,
"reference": "string",
"status": "active",
"totals": {},
"transferId": "string",
"type": "payment",
"updatedAt": "2025-05-04T09:42:00Z",
"xeroId": "string"
}