API referencePay Out endpointsBills

List bills by organization

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

Path parameters

orgIdintegerRequired
The numeric identifier for organization, assigned by Payabli.

Headers

requestTokenstringRequired

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

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

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)
  • 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
pageidentifierstring or null
Auxiliary validation used internally by payment pages and components.
pageSizeinteger or null
Number of records on each response page.
Recordslist of objects or null
total2approvalinteger or null
totalactiveinteger or null
totalAmountdouble or null
Total amount of bills in response.
totalamount2approvaldouble or null
totalamountactivedouble or null
totalamountapproveddouble or null
The total amount of approved bills.
totalamountcanceldouble or null
totalamountdisapproveddouble or null
The total amount of disapproved bills.
totalamountintransitdouble or null
totalamountoverduedouble or null
The total amount of bills that are overdue.
totalamountpaiddouble or null
The total amount of paid bills.
totalamountsent2approvaldouble or null
totalapprovedinteger or null
The total number of bills that were approved.
totalcancelinteger or null
totaldisapprovedinteger or null
The number of bills that were disapproved.
totalintransitinteger or null
totaloverdueinteger or null
The number of bills that are overdue.
totalPagesinteger or null
Total number of pages in response.
totalpaidinteger or null
The total number of paid bills.
totalRecordsinteger or null
Total number of records in response.
totalsent2approvalinteger or null

Errors