GET
/
Query
/
bills
/
org
/
{orgId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Query/bills/org/{orgId} \
  --header 'requestToken: <api-key>'
{
  "Summary": {
    "totalPages": 1,
    "totalRecords": 1,
    "totalAmount": 200,
    "totalactive": 0,
    "totalamountactive": 0,
    "totalsent2approval": 1,
    "totalamountsent2approval": 200,
    "total2approval": 0,
    "totalamount2approval": 0,
    "totalapproved": 0,
    "totalamountapproved": 0,
    "totaldisapproved": 0,
    "totalamountdisapproved": 0,
    "totalcancel": 0,
    "totalamountcancel": 0,
    "totalintransit": 0,
    "totalamountintransit": 0,
    "totalpaid": 0,
    "totalamountpaid": 0,
    "totaloverdue": 0,
    "totalamountoverdue": 0,
    "pageSize": 20,
    "pageidentifier": null
  },
  "Records": [
    {
      "IdBill": 6104,
      "BillNumber": "MI-bill-2024031926",
      "NetAmount": 200,
      "BillDate": "2026-03-10T00:00:00",
      "DueDate": "2027-03-10T00:00:00",
      "Comments": "PAYBILL",
      "BatchNumber": null,
      "BillItems": [
        {
          "itemTotalAmount": 200,
          "itemTaxAmount": 0,
          "itemTaxRate": 0,
          "itemProductCode": "Prod-MI-2024031926",
          "itemProductName": "Consultation",
          "itemDescription": "Consultation price",
          "itemCommodityCode": "Commod-MI-2024031926",
          "itemUnitOfMeasure": "per each",
          "itemCost": 200,
          "itemQty": 1,
          "itemMode": 0,
          "itemCategories": null
        }
      ],
      "Mode": 0,
      "PaymentMethod": null,
      "PaymentId": null,
      "AccountingField1": null,
      "AccountingField2": null,
      "Terms": "Net30",
      "Source": "web",
      "AdditionalData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Vendor": {
        "VendorNumber": "MI-vendor-2024031926",
        "Name1": "Gomez-Radulescu Industries",
        "Name2": "Elena",
        "EIN": "XXXXX6789",
        "Phone": "517-555-0123",
        "Email": "elenag@industriesexample.com",
        "Address1": "1234 Liberdad St.",
        "Address2": "Suite 100",
        "City": "Detroit",
        "State": "MI",
        "Zip": "48201",
        "Country": "US",
        "Mcc": "700",
        "LocationCode": null,
        "Contacts": null,
        "BillingData": {
          "id": 0,
          "bankName": "Michigan Savings Bank",
          "routingAccount": "072000326",
          "accountNumber": "12345XXXX",
          "typeAccount": "Checking",
          "bankAccountHolderName": "Elena Gomez",
          "bankAccountHolderType": "Business",
          "bankAccountFunction": 0
        },
        "PaymentMethod": "ach",
        "VendorStatus": 1,
        "VendorId": 8723,
        "EnrollmentStatus": null,
        "Summary": null,
        "PaypointLegalname": null,
        "PaypointDbaname": null,
        "PaypointEntryname": null,
        "ParentOrgName": null,
        "CreatedDate": "2024-03-13T10:54:26.85",
        "LastUpdated": "2024-03-13T10:54:26.85",
        "remitAddress1": null,
        "remitAddress2": null,
        "remitCity": null,
        "remitState": null,
        "remitZip": null,
        "remitCountry": null,
        "payeeName1": null,
        "payeeName2": null,
        "customerVendorAccount": null,
        "InternalReferenceId": 1215,
        "additionalData": null,
        "externalPaypointID": null
      },
      "Status": 2,
      "CreatedAt": "2024-03-13T15:54:26.86",
      "EndDate": null,
      "LastUpdated": "2024-03-13T10:54:26.86",
      "Frequency": "one-time",
      "Transaction": null,
      "billEvents": [
        {
          "description": "Created Bill",
          "eventTime": "2024-03-13T15:54:26.8586107+00:00",
          "refData": "00-45e1c2d8b53b72fafc4082f374e68753-ffea4ba4c2ce63ce-00",
          "extraData": null,
          "source": null
        },
        {
          "description": "Sent to Approval",
          "eventTime": "2024-03-13T15:54:28.2472318+00:00",
          "refData": "00-086a951822211bc2eb1803ed64db9d4f-0f07e0e8c394e481-00",
          "extraData": null,
          "source": null
        }
      ],
      "billApprovals": [
        {
          "Id": 34,
          "email": "lisandra@example.com",
          "approved": 0,
          "comments": null,
          "approvedTime": "2024-03-13T15:54:27.0715564+00:00"
        },
        {
          "Id": 293,
          "email": "jccastillo@example.com",
          "approved": 0,
          "comments": null,
          "approvedTime": "2024-03-13T15:54:27.0793064+00:00"
        }
      ],
      "PaypointLegalname": "MiCasa Sports LLC",
      "PaypointDbaname": "MiCasa Sports",
      "ParentOrgName": "Fitness Hub",
      "PaypointEntryname": "micasa",
      "paylinkId": null,
      "DocumentsRef": null,
      "externalPaypointID": "micasa-10",
      "LotNumber": null
    }
  ]
}

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

orgId
integer
required

The numeric identifier for organization, assigned by Payabli.

Example:

123

Query Parameters

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:

  • 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

limitRecord
integer
default:20

Max number of records to return for the query. Use 0 or negative value to return all records.

Example:

0

fromRecord
integer
default:0

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

Example:

251

sortBy
string

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.

Example:

"desc(field_name)"

Response

200 - application/json
Success
totalPages
integer

Total number of pages in response.

Example:

1

totalRecords
integer

Total number of records in response.

Example:

2

totalAmount
number

Total amount of bills in response.

totalactive
integer
totalamountactive
number
totalsent2approval
integer
totalamountsent2approval
number
total2approval
integer
totalamount2approval
number
totalapproved
integer

The total number of bills that were approved.

totalamountapproved
number

The total amount of approved bills.

totaldisapproved
integer

The number of bills that were disapproved.

totalamountdisapproved
number

The total amount of disapproved bills.

totalcancel
integer
totalamountcancel
number
totalintransit
integer
totalamountintransit
number
totalpaid
integer

The total number of paid bills.

totalamountpaid
number

The total amount of paid bills.

totaloverdue
integer

The number of bills that are overdue.

totalamountoverdue
number

The total amount of bills that are overdue.

pageSize
integer

Number of records on each response page.

Example:

20

pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

Records
object[]