PUT /purchase-invoice-payments/{id}.json
Path parameters
-
Numeric ID of the instance
Minimum value is
1.
Body Required
-
Amount
Default value is
0. -
createdAt string(date-time) | null
Created at
-
Exchange rate
Default value is
1. -
externalId string | null
External
-
id integer(int32)
Id
-
Paid at
Default value is
{}(empty). -
paymentMethodId integer(int32) | null
Payment method
-
Purchase invoice
-
purchaseItemId integer(int32) | null
Purchase item
-
reference string | null
Reference
-
Status
Values are
activeorcancelled. Default value isactive. -
transferId string | null
Transfer
-
Type
Values are
payment,overpayment,correction,refund, orrefundCommission. Default value ispayment. -
updatedAt string(date-time) | null
Updated at
-
xeroId string | null
Xero
PUT /purchase-invoice-payments/{id}.json
curl \
-X PUT http://api.example.com/v1/purchase-invoice-payments/{id}.json \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"amount":0,"createdAt":"2024-05-04T09:42:00+00:00","exchangeRate":1,"externalId":"string","id":42,"paidAt":{},"paymentMethodId":42,"purchaseInvoiceId":42,"purchaseItemId":42,"reference":"string","status":"active","totals":{},"transferId":"string","type":"payment","updatedAt":"2024-05-04T09:42:00+00:00","xeroId":"string"}'
Request example
{
"amount": 0,
"createdAt": "2024-05-04T09:42:00+00:00",
"exchangeRate": 1,
"externalId": "string",
"id": 42,
"paidAt": {},
"paymentMethodId": 42,
"purchaseInvoiceId": 42,
"purchaseItemId": 42,
"reference": "string",
"status": "active",
"totals": {},
"transferId": "string",
"type": "payment",
"updatedAt": "2024-05-04T09:42:00+00:00",
"xeroId": "string"
}