Jetti

GET /purchase-invoice-payments/{id}.json

GET /purchase-invoice-payments/{id}.json
Bearer auth

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

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

    • purchaseInvoiceId integer(int32) Required

      Purchase invoice

    • purchaseItemId integer(int32) | null

      Purchase item

    • reference string | null

      Reference

    • status string | null Required

      Status

      Values are active or cancelled. Default value is active.

    • totals object | null | array | boolean | integer | number | string

      Totals

      Any of:
      object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
    • transferId string | null

      Transfer

    • type string | null Required

      Type

      Values are payment, overpayment, correction, refund, or refundCommission. Default value is payment.

    • updatedAt string(date-time) | null

      Updated at

    • xeroId string | null

      Xero
GET /purchase-invoice-payments/{id}.json 
curl \
 --request GET 'http://api.example.com/v1/purchase-invoice-payments/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
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"
}