API referencePay Out endpointsVendor

List vendors by organization

Retrieve a list of vendors 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:

  • method (in, nin, eq, ne)
  • enrollmentStatus (in,nin, eq, ne)
  • status (in, nin, eq, ne)
  • vendorNumber (ct, nct, eq, ne)
  • name (ct, nct, eq, ne)
  • ein (ct, nct, eq, ne)
  • phone (ct, nct, eq, ne)
  • email (ct, nct, eq, ne)
  • address (ct, nct, eq, ne)
  • city (ct, nct, eq, ne)
  • state (ct, nct, eq, ne)
  • country (ct, nct, eq, ne)
  • zip (ct, nct, eq, ne)
  • mcc (ct, nct, eq, ne)
  • locationCode (ct, nct, eq, ne)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • parentOrgId (ne, eq, nin, in)
  • orgName (ne, eq, ct, nct)

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 separated by ”|”
  • nin => not inside array separated by ”|”

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: netAmount(gt)=20 return all records with netAmount 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

Recordslist of objectsOptional
SummaryobjectOptional

Errors