PUT /purchase-return-payments/{id}.json

PUT /purchase-return-payments/{id}.json

Bearer auth

Path parameters

• id integer(int64) Required

  Numeric ID of the instance

  Minimum value is 1.

application/json

Body Required

• 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).

• purchaseReturnId integer(int32) Required

  Purchase return

• reference string | null

  Reference

• updatedAt string(date-time) | null

  Updated at

• xeroId string | null

  Xero

PUT /purchase-return-payments/{id}.json

curl \
 --request PUT 'http://api.example.com/v1/purchase-return-payments/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"amount":0,"createdAt":"2025-05-04T09:42:00Z","exchangeRate":1,"externalId":"string","id":42,"paidAt":{},"purchaseReturnId":42,"reference":"string","updatedAt":"2025-05-04T09:42:00Z","xeroId":"string"}'

Request examples

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