List bills by paypoint
Retrieve a list of bills for an entrypoint. Use filters to limit results.
Path parameters
The paypoint’s entrypoint identifier. Learn more
Headers
Query parameters
The number of records to skip before starting to collect the result set.
Max number of records to return for the query. Use 0 or negative value to return all records.
Collection of field names, conditions, and values used to filter the query
You must remove parameters= from the request before you send it, otherwise Payabli will ignore the filters.
Because of a technical limitation, you can’t make a request that includes filters from the API console on this page. The response won’t be filtered. Instead, copy the request, remove parameters= and run the request in a different client.
For example:
should become:
—url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
See Filters and Conditions Reference for help.
List of field names accepted:
- frequency (in, nin, ne, eq)
- method (in, nin, eq, ne)
- event (in, nin, eq, ne)
- target (ct, nct, eq, ne)
- status (eq, ne)
- approvalUserId (eq, ne)
- parentOrgId (ne, eq, nin, in)
- approvalUserEmail (eq, ne)
List of comparison accepted - enclosed between parentheses:
- eq or empty => equal
- gt => greater than
- ge => greater or equal
- lt => less than
- le => less or equal
- ne => not equal
- ct => contains
- nct => not contains
- in => inside array
- nin => not inside array
List of parameters accepted:
- limitRecord : max number of records for query (default=“20”, “0” or negative value for all)
- fromRecord : initial record in query
Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.00
The field name to use for sorting results. Use desc(field_name) to sort descending by field_name, and use asc(field_name) to sort ascending by field_name.
Response
Success
Auxiliary validation used internally by payment pages and components.
Number of records on each response page.
Total amount of bills in response.
The total amount of approved bills.
The total amount of disapproved bills.
The total amount of bills that are overdue.
The total amount of paid bills.
The total number of bills that were approved.
The number of bills that were disapproved.
The number of bills that are overdue.
Total number of pages in response.
The total number of paid bills.
Total number of records in response.