List invoices by organization

curl -G https://api-sandbox.payabli.com/api/Query/invoices/org/123 \
     -H "requestToken: <apiKey>" \
     -d fromRecord=251 \
     -d limitRecord=0 \
     -d sortBy=desc(field_name)

{
  "Records": [
    {
      "invoiceId": 3674,
      "customerId": 1323,
      "paypointId": 10,
      "invoiceNumber": "QA-1709680125",
      "invoiceDate": "2025-03-05",
      "invoiceDueDate": "2025-03-05",
      "invoiceSentDate": "2025-03-05",
      "invoiceEndDate": "2025-03-05",
      "createdAt": "2024-03-05T18:08:45Z",
      "invoiceStatus": 1,
      "invoiceType": 0,
      "frequency": "onetime",
      "paymentTerms": "N30",
      "invoiceAmount": 50,
      "invoicePaidAmount": 0,
      "firstName": "Amirah",
      "lastName": "Tan",
      "shippingAddress1": "1234 Rainier Ave",
      "shippingAddress2": "Apt 567",
      "shippingCity": "Seattle",
      "shippingState": "WA",
      "shippingZip": "98101",
      "shippingFromZip": "",
      "shippingCountry": "US",
      "shippingEmail": "amirah.tan@example.com",
      "shippingPhone": "",
      "items": [
        {
          "itemCost": 50,
          "itemDescription": "service",
          "itemProductName": "Internet",
          "itemQty": 1
        }
      ],
      "Customer": {
        "AdditionalData": {
          "key1": "value",
          "key2": "value",
          "key3": "value"
        },
        "BillingPhone": "1234567890",
        "customerId": 1323
      },
      "paylinkId": "3674-cf15b881-f276-4b69-bdc8-841b2d123XXXXXX",
      "PaypointLegalname": "Emerald City LLC",
      "PaypointDbaname": "Emerald City Trading",
      "PaypointEntryname": "47a30009s",
      "ParentOrgId": 123,
      "ParentOrgName": "Emerald Enterprises",
      "externalPaypointID": "seattletrade01-10",
      "tax": 0,
      "discount": 0,
      "freightAmount": 0,
      "dutyAmount": 0,
      "billEvents": [
        {
          "description": "Invoice created",
          "eventTime": "2024-03-05T23:08:45Z",
          "refData": "00-802fa578504a7af6f3dd890a3802f7ef-61b4bedXXXX1234"
        }
      ]
    }
  ],
  "Summary": {
    "pageIdentifier": "null",
    "pageSize": 20,
    "totalAmount": 77.22,
    "totalNetAmount": 77.22,
    "totalPages": 2,
    "totalRecords": 2
  }
}

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

Authentication

requestTokenstring

API Key authentication via header

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 optional 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:

invoiceDate (gt, ge, lt, le, eq, ne)
dueDate (gt, ge, lt, le, eq, ne)
sentDate (gt, ge, lt, le, eq, ne)
frequency (in, nin,ne, eq)
invoiceType (eq, ne)
payTerms (in, nin, eq, ne)
paypointId (ne, eq)
totalAmount (gt, ge, lt, le, eq, ne)
paidAmount (gt, ge, lt, le, eq, ne)
status (in, nin, eq, ne)
invoiceNumber (ct, nct, eq, ne)
purchaseOrder (ct, nct, eq, ne)
itemProductCode (ct, nct)
itemDescription (ct, nct)
customerFirstname (ct, nct, eq, ne)
customerLastname (ct, nct, eq, ne)
customerName (ct, nct)
customerId (eq, ne)
customerNumber (ct, nct, eq, ne)
customerCompanyname (ct, nct, eq, ne)
customerAddress (ct, nct, eq, ne)
customerCity (ct, nct, eq, ne)
customerZip (ct, nct, eq, ne)
customerState (ct, nct, eq, ne)
customerCountry (ct, nct, eq, ne)
customerPhone (ct, nct, eq, ne)
customerEmail (ct, nct, eq, ne)
customerShippingAddress (ct, nct, eq, ne)
customerShippingCity (ct, nct, eq, ne)
customerShippingZip (ct, nct, eq, ne)
customerShippingState (ct, nct, eq, ne)
customerShippingCountry (ct, nct, eq, ne)
orgId (eq)
paylinkId (ne, eq)
paypointLegal (ne, eq, ct, nct)
paypointDba (ne, eq, ct, nct)
orgName (ne, eq, ct, nct)
additional-xxx (ne, eq, ct, nct) where xxx is the additional field name

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

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: - `invoiceDate` (gt, ge, lt, le, eq, ne) - `dueDate` (gt, ge, lt, le, eq, ne) - `sentDate` (gt, ge, lt, le, eq, ne) - `frequency` (in, nin,ne, eq) - `invoiceType` (eq, ne) - `payTerms` (in, nin, eq, ne) - `paypointId` (ne, eq) - `totalAmount` (gt, ge, lt, le, eq, ne) - `paidAmount` (gt, ge, lt, le, eq, ne) - `status` (in, nin, eq, ne) - `invoiceNumber` (ct, nct, eq, ne) - `purchaseOrder` (ct, nct, eq, ne) - `itemProductCode` (ct, nct) - `itemDescription` (ct, nct) - `customerFirstname` (ct, nct, eq, ne) - `customerLastname` (ct, nct, eq, ne) - `customerName` (ct, nct) - `customerId` (eq, ne) - `customerNumber` (ct, nct, eq, ne) - `customerCompanyname` (ct, nct, eq, ne) - `customerAddress` (ct, nct, eq, ne) - `customerCity` (ct, nct, eq, ne) - `customerZip` (ct, nct, eq, ne) - `customerState` (ct, nct, eq, ne) - `customerCountry` (ct, nct, eq, ne) - `customerPhone` (ct, nct, eq, ne) - `customerEmail` (ct, nct, eq, ne) - `customerShippingAddress` (ct, nct, eq, ne) - `customerShippingCity` (ct, nct, eq, ne) - `customerShippingZip` (ct, nct, eq, ne) - `customerShippingState` (ct, nct, eq, ne) - `customerShippingCountry` (ct, nct, eq, ne) - `orgId` (eq) - `paylinkId` (ne, eq) - `paypointLegal` (ne, eq, ct, nct) - `paypointDba` (ne, eq, ct, nct) - `orgName` (ne, eq, ct, nct) - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name 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. Fields marked optional may return null if not set.

Recordslist of objects

Summaryobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error