Get a list of refunds

get/refunds
SecuritybearerAuth
Request
query Parameters
customerId
integer <int64> (IdParam) >= 1

Customer identifier

Example: customerId=1
invoiceId
integer <int64> (IdParam) >= 1

Invoice identifier

Example: invoiceId=1
billRunType
string (BillRunType)

Bill Run Type

Enum: "NORMAL" "ADHOC"
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "invoiceId": 1,
    • "customerId": 1,
    • "billRunType": "NORMAL",
    • "thirdPartyRefundStatus": "CREATED",
    • "description": "string",
    • "errorInfo": "string",
    • "paymentMethod": "CHEQUE",
    • "amountInMajorCurrency": 10.5
    }
]