API referencePay Out endpointsBills

List bills by organization

Retrieve a list of bills for an organization. Use filters to limit results.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

orgIdintegerRequired
The numeric identifier for organization, assigned by Payabli.

Query parameters

fromRecordintegerOptionalDefaults to 0
The number of records to skip before starting to collect the result set.
limitRecordintegerOptionalDefaults to 20

Max number of records to return for the query. Use 0 or negative value to return all records.

parametersmap from strings to optional stringsOptional
Collection of field names, conditions, and values used to filter the query <Info> **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: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20 should become: --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20 </Info> See [Filters and Conditions Reference](/developer-guides/reporting-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) - parentOrgId (ne, eq, nin, in) - approvalUserId (eq, ne) - 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
sortBystringOptional

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
pageidentifierstringOptional
Auxiliary validation used internally by payment pages and components.
pageSizeintegerOptional
Number of records on each response page.
Recordslist of objectsOptional
total2approvalintegerOptional
totalactiveintegerOptional
totalAmountdoubleOptional
Total amount of bills in response.
totalamount2approvaldoubleOptional
totalamountactivedoubleOptional
totalamountapproveddoubleOptional
The total amount of approved bills.
totalamountcanceldoubleOptional
totalamountdisapproveddoubleOptional
The total amount of disapproved bills.
totalamountintransitdoubleOptional
totalamountoverduedoubleOptional
The total amount of bills that are overdue.
totalamountpaiddoubleOptional
The total amount of paid bills.
totalamountsent2approvaldoubleOptional
totalapprovedintegerOptional
The total number of bills that were approved.
totalcancelintegerOptional
totaldisapprovedintegerOptional
The number of bills that were disapproved.
totalintransitintegerOptional
totaloverdueintegerOptional
The number of bills that are overdue.
totalPagesintegerOptional
Total number of pages in response.
totalpaidintegerOptional
The total number of paid bills.
totalRecordsintegerOptional
Total number of records in response.
totalsent2approvalintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error