GET
/
Export
/
customers
/
{format}
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Export/customers/{format}/org/{orgId} \
  --header 'requestToken: <api-key>'
{}

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

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
format
enum<string>
required

Format for the export, either XLSX or CSV.

Available options:
csv,
xlsx
Example:

"csv"

​
orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

​
limitRecord
integer
default:25000

The number of records to return for the query. The maximum is 30,000 records. When this parameter isn't sent, the API returns up to 25,000 records.

Required range: x <= 30000
Example:

1000

​
fromRecord
integer
default:0

The number of records to skip before starting to collect the result set.

Example:

251

​
columnsExport
string

Optional parameter for mapping source column names to custom export column names. The format is sourceColumn:exportColumn,sourceColumn2:exportColumn2. Supported columns are:

  • customerId
  • Company
  • Firstname
  • Lastname
  • customerNumber
  • Address
  • City
  • Country
  • Email
  • Phone
  • State
  • Zip
  • Balance
  • customerStatus
  • customerUsername
  • ShippingAddress
  • ShippingCity
  • ShippingCountry
  • ShippingState
  • ShippingZip
  • PaypointLegalname
  • PaypointDbaname
  • ParentOrgName
  • externalPaypointID
  • IdentifierFields
  • AdditionalFields
Example:

"BatchDate:Batch_Date,PaypointName:Legal_name"

​
parameters
object

Collection of field names, conditions, and values used to filter the query.

See Filters and Conditions Reference for help.

List of field names accepted:

  • createdDate (gt, ge, lt, le, eq, ne)
  • customernumber (ne, eq, ct, nct)
  • firstname (ne, eq, ct, nct)
  • lastname (ne, eq, ct, nct)
  • name (ct, nct)
  • address (ne, eq, ct, nct)
  • city (ne, eq, ct, nct)
  • country (ne, eq, ct, nct)
  • zip (ne, eq, ct, nct)
  • state (ne, eq, ct, nct)
  • shippingaddress (ne, eq, ct, nct)
  • shippingcity (ne, eq, ct, nct)
  • shippingcountry (ne, eq, ct, nct)
  • shippingzip (ne, eq, ct, nct)
  • shippingstate (ne, eq, ct, nct)
  • phone (ne, eq, ct, nct)
  • email (ne, eq, ct, nct)
  • company (ne, eq, ct, nct)
  • username (ne, eq, ct, nct)
  • balance (gt, ge, lt, le, eq, ne)
  • status (in, nin, eq, ne)
  • additional-xxx (ne, eq, ct, nct) where xxx is the additional field name
  • orgId (eq) mandatory when entry=org
  • paypointId (ne, eq)
  • paypointLegal (ne, eq, ct, nct)
  • paypointDba (ne, eq, ct, nct)
  • 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: balance(gt)=20 return all records with balance greater than 20.00

Response

200 - application/json
Success

The returned file includes the data exported. For the transaction export, the file includes these headers:

  • customerId
  • Company
  • FirstName
  • LastName
  • CustomerNumber
  • Address
  • City
  • Country
  • Email
  • Phone
  • State
  • Zip
  • Balance
  • Status
  • Username
  • ShippingAddress
  • ShippingCity
  • ShippingCountry
  • ShippingState
  • ShippingZip
  • PaypointLegalName
  • PaypointDbaName
  • ParentOrgName
  • externalPaypointID
  • Identifiers
  • AdditionalFields

Was this page helpful?