Skip to main content
GET
Fetch an invoice payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_payment_id
integer
required

The ID of the invoice payment to fetch

Response

200 - application/json

OK

An invoice payment represents a payment applied toward a specific invoice. Each invoice payment records the amount applied to that invoice.

amount
integer
required

The payment amount applied to the invoice, in cents.

clinic_client_id
integer
required

The ID of the client (pet parent) on the invoice.

clinic_id
integer
required

The ID of the clinic that issued the invoice.

created
string<date-time>
required

The datetime this object was created.

id
integer
required

The unique identifier for the invoice payment.

invoice_id
integer
required

The ID of the invoice this payment is applied to.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

payment_id
integer | null
required

The ID of the payment this invoice payment is linked to, if any.