List Refunds

GET /accounting/refunds

Group: Accounting › Refunds · Operation ID: listRefunds

Returns a list of refunds. To match multiple approval statuses or filter in a request body, use POST accounting/refunds/search.

The item schema here is the same as GET accounting/refunds/:id and POST accounting/refunds/search. Filtering by several statuses at once, or by the refund's id, is only on POST accounting/refunds/search.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
status query string no Limits results to refunds in this approval state. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'. Omit to return every state.
paymentId query string no Limits results to refunds against this source payment. Omit to return every payment. See id on GET accounting/payments/:id.
customerId query string no Limits results to refunds for this customer. Omit to return every customer. See id on GET accounting/customers/:id.
refundDateFrom query string no Limits results to refunds issued on or after this date, inclusive. Format YYYY-MM-DD.
refundDateTo query string no Limits results to refunds issued on or before this date, inclusive. Format YYYY-MM-DD.
modifiedFrom query string no Limits results to refunds changed at or after this time, inclusive. In UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
modifiedTo query string no Limits results to refunds changed at or before this time, inclusive. In UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
cursor query string no The cursor from the previous response's pagination.nextCursor. Omit for the first page.
pageSize query number no The number of refunds per page. Defaults to 50. A value above 200 is treated as 200, not rejected.

Response

200 Success

Under data (listRefundsOutput):

Field Type Required Description
items array of object yes The refunds that match, most recently created first. An empty array when nothing matches.
items[].id string yes The unique identifier for the refund.
items[].refundNumber string no The refund number, unique within the tenant, for example 'REF-1042'.
items[].refundDate string (date) yes The date the refund was issued. Format YYYY-MM-DD.
items[].approvalStatus string no The approval status. Possible values: 'draft', 'pendingApproval', 'revise', 'approved', 'rejected'.
items[].refundType string yes The payment method used for the refund. Possible values: 'check', 'ach', 'wire', 'creditCard', 'directDebit', 'sepaCreditTransfer'.
items[].currency string yes The currency of the refund. Every amount on it is in this currency. Format ISO 4217, for example 'USD'.
items[].amount string (decimal) yes The refund amount, in the refund currency.
items[].unappliedAmount string (decimal) no The unapplied balance remaining on the source payment, in the refund currency.
items[].refundNote string no A free-form note attached to the refund. Absent when none was set.
items[].customerId string yes The customer receiving the refund. See id on GET accounting/customers/:id.
items[].customerName string no The name of the customer receiving the refund.
items[].entityId string yes The legal entity issuing the refund. See id on GET base/entities.
items[].paymentId string yes The source payment being refunded. See id on GET accounting/payments/:id.
items[].paymentNumber string no The number of the source payment being refunded.
items[].lastModifiedDate string (date-time) yes The date and time the refund last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
pagination object yes The pagination cursor for this page.
pagination.nextCursor string no The cursor for the next page. Pass it as the cursor input. Absent on the last page.
pagination.hasMore boolean yes True when more refunds remain beyond this page.

Statuses