Get a list of customer or invoice payments

get/customer-payments
SecuritybearerAuth
Request
query Parameters
customer_id
required
integer <int64> (IdParam) >= 1

Customer identifier

Example: customer_id=1
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
filter
string (StringFilterParam)

Filter by text

Example: filter=xyz | in:x,y | like:xyz
customerPaymentType
string (StringFilterParam)

Filter by customer payment type

Example: customerPaymentType=xyz | in:x,y | like:xyz
excludeDebits
string (StringFilterParam)

Filter out negative payments

Example: excludeDebits=xyz | in:x,y | like:xyz
excludeCredits
string (StringFilterParam)

Filter out zero and positive payments

Example: excludeCredits=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "customerId": 1,
    • "amountInMajorCurrency": 10.5,
    • "resultingCustomerBalance": 10.5,
    • "currencyId": 1,
    • "description": "string",
    • "reference": "string",
    • "type": "CHEQUE",
    • "paymentDate": "2019-08-24",
    • "customerPaymentType": "CUSTOMER",
    • "txnType": "INVOICE_CREATED",
    • "invoiceNumber": "string",
    • "invoiceId": 0,
    • "billRunType": "NORMAL"
    }
]