List all apps for org

GET

/Query/boarding/:orgId

GET

/api/Query/boarding/:orgId

$ curl -G https://api-sandbox.payabli.com/api/Query/boarding/123 \
>      -d fromRecord=251 \
>      -d limitRecord=0 \
>      -d sortBy=desc(field_name)

1 {
2   "Records": [
3     {
4       "annualRevenue": 1000,
5       "averageMonthlyVolume": 1000,
6       "averageTicketAmount": 1000,
7       "bAddress1": "123 Walnut Street",
8       "bAddress2": "Suite 103",
9       "bankData": [
10         {
11           "id": 1,
12           "accountId": "123-456",
13           "nickname": "Business Checking 1234",
14           "bankName": "Country Bank",
15           "routingAccount": "123123123",
16           "accountNumber": "1XXXXXX3123",
17           "typeAccount": "Checking",
18           "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
19           "bankAccountHolderType": "Personal",
20           "bankAccountFunction": 1
21         },
22         {
23           "id": 1,
24           "accountId": "123-456",
25           "nickname": "Business Checking 1234",
26           "bankName": "Country Bank",
27           "routingAccount": "123123123",
28           "accountNumber": "1XXXXXX3123",
29           "typeAccount": "Checking",
30           "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
31           "bankAccountHolderType": "Personal",
32           "bankAccountFunction": 0
33         }
34       ],
35       "bCity": "New Vegas",
36       "bCountry": "US",
37       "bFax": "5551234567",
38       "binPerson": 60,
39       "binPhone": 20,
40       "binWeb": 20,
41       "boardingLinkId": 91,
42       "boardingStatus": 1,
43       "boardingSubStatus": 1,
44       "bPhone": "5551234567",
45       "bStartdate": "01/01/1990",
46       "bState": "FL",
47       "bSummary": "Brick and mortar store that sells office supplies",
48       "bZip": "33000",
49       "contactData": [
50         {}
51       ],
52       "createdAt": "2022-07-01T15:00:01Z",
53       "dbaName": "Sunshine Gutters",
54       "ein": "123456789",
55       "externalPaypointId": "Paypoint-100",
56       "generalEvents": [
57         {
58           "description": "TransferCreated",
59           "eventTime": "2023-07-05T22:31:06Z"
60         }
61       ],
62       "highTicketAmount": 1000,
63       "idApplication": 352,
64       "lastModified": "2022-07-01T15:00:01Z",
65       "legalName": "Sunshine Services, LLC",
66       "license": "2222222FFG",
67       "licenseState": "CA",
68       "mAddress1": "123 Walnut Street",
69       "mAddress2": "STE 900",
70       "mccid": "mccid",
71       "mCity": "TN",
72       "mCountry": "US",
73       "mState": "TN",
74       "mZip": "37615",
75       "orgId": 123,
76       "orgParentName": "PropertyManager Pro",
77       "ownerData": [
78         {}
79       ],
80       "ownType": "Limited Liability Company",
81       "pageidentifier": "null",
82       "recipientEmailNotification": true,
83       "resumable": false,
84       "salesCode": "salesCode",
85       "taxfillname": "Sunshine LLC",
86       "templateId": 22,
87       "websiteAddress": "www.example.com",
88       "whencharged": "When Service Provided",
89       "whendelivered": "0-7 Days",
90       "whenProvided": "30 Days or Less",
91       "whenrefund": "Exchange Only"
92     }
93   ],
94   "Summary": {
95     "pageIdentifier": "null",
96     "pageSize": 20,
97     "totalAmount": 77.22,
98     "totalNetAmount": 77.22,
99     "totalPages": 2,
100     "totalRecords": 2
101   }
102 }

Returns a list of boarding applications for an organization. Use filters to limit results. Include the exportFormat query parameter to return the results as a file instead of a JSON response.

Path parameters

orgIdintegerRequired

The numeric identifier for organization, assigned by Payabli.

Query parameters

exportFormatenumOptional

Export format for file downloads. When specified, returns data as a file instead of JSON.

Allowed values:

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 nullable stringsOptional

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

See Filters and Conditions Reference for help.

List of field names accepted:

createdAt (gt, ge, lt, le, eq, ne)
startDate (gt, ge, lt, le, eq, ne)
dbaname (ct, nct)
legalname (ct, nct)
ein (ct, nct)
address (ct, nct)
city (ct, nct)
state (ct, nct)
phone (ct, nct)
mcc (ct, nct)
owntype (ct, nct)
ownerName (ct, nct)
contactName (ct, nct)
status (in, nin, eq,ne)
orgParentname (ct, nct)
externalpaypointID (ct, nct, eq, ne)
repCode (ct, nct, eq, ne)
repName (ct, nct, eq, ne)
repOffice (ct, nct, 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

Collection of field names, conditions, and values used to filter the query See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help. List of field names accepted: - `createdAt` (gt, ge, lt, le, eq, ne) - `startDate` (gt, ge, lt, le, eq, ne) - `dbaname` (ct, nct) - `legalname` (ct, nct) - `ein` (ct, nct) - `address` (ct, nct) - `city` (ct, nct) - `state` (ct, nct) - `phone` (ct, nct) - `mcc` (ct, nct) - `owntype` (ct, nct) - `ownerName` (ct, nct) - `contactName` (ct, nct) - `status` (in, nin, eq,ne) - `orgParentname` (ct, nct) - `externalpaypointID` (ct, nct, eq, ne) - `repCode` (ct, nct, eq, ne) - `repName` (ct, nct, eq, ne) - `repOffice` (ct, nct, 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

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

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error