Get a list of available adhoc invoice payments

get/adhoc-invoice-payments
SecuritybearerAuth
Request
query Parameters
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
adhocBillRunId
string (StringFilterParam)

Filter by adhoc bill run id

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

Filter by customer payment type

Example: customerPaymentType=xyz | in:x,y | like:xyz
customerPaymentId
string (IdFilterParam)

Customer payment id

Example: customerPaymentId=0
generatedAdhocInvoiceId
string (IdFilterParam)

Adhoc invoice id

Example: generatedAdhocInvoiceId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "generatedAdhocInvoiceId": 1,
    • "thirdPartyPaymentStatus": "NEW",
    • "amountInMajorCurrency": 10.5,
    • "currencyId": 1,
    • "description": "string",
    • "metaData": "string",
    • "errorInfo": "string",
    • "paymentMethod": "CHEQUE",
    • "paymentDate": "2019-08-24",
    • "customerPaymentType": "CUSTOMER",
    • "customerPaymentId": 1
    }
]