Skip to main content
GET
Fetch an invoice refund

Authorizations

Authorization
string
header
required

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

Path Parameters

pk
integer
required

Response

200 - application/json

OK

amount
integer
required

The amount refunded, 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.

currency
enum<string>
required

The currency of the refund.

Available options:
USD,
CAD
id
integer
required

The unique identifier for the invoice refund.

invoice_id
integer
required

The ID of the invoice this refund is associated with.

invoice_payment_id
integer
required

The ID of the invoice payment this refund is against.

modified
string<date-time>
required

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

refund_type
enum<string>
required

The type of refund (e.g. credit card, store credit, external).

Available options:
CLIENT_CREDIT,
STRIPE,
EXTERNAL