List bills by paypoint

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

{
  "pageidentifier": "null",
  "pageSize": 20,
  "Records": [
    {
      "AdditionalData": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "billApprovals": [
        {
          "approved": 0,
          "approvedTime": "2024-03-13T15:54:27Z",
          "email": "lisandra@example.com",
          "Id": 34
        },
        {
          "approved": 0,
          "approvedTime": "2024-03-13T15:54:27Z",
          "email": "jccastillo@example.com",
          "Id": 293
        }
      ],
      "BillDate": "2025-03-10",
      "billEvents": [
        {
          "description": "Created Bill",
          "eventTime": "2024-03-13T15:54:26Z",
          "refData": "00-45e1c2d8b53b72fafc4082f374e68753-ffea4ba4c2ce63ce-00"
        },
        {
          "description": "Sent to Approval",
          "eventTime": "2024-03-13T15:54:28Z",
          "refData": "00-086a951822211bc2eb1803ed64db9d4f-0f07e0e8c394e481-00"
        }
      ],
      "BillItems": [
        {
          "itemCost": 200,
          "itemCommodityCode": "Commod-MI-2024031926",
          "itemDescription": "Consultation price",
          "itemMode": 0,
          "itemProductCode": "Prod-MI-2024031926",
          "itemProductName": "Consultation",
          "itemQty": 1,
          "itemTaxAmount": 0,
          "itemTaxRate": 0,
          "itemTotalAmount": 200,
          "itemUnitOfMeasure": "per each"
        }
      ],
      "BillNumber": "MI-bill-2024031926",
      "Comments": "PAYBILL",
      "CreatedAt": "2024-03-13T15:54:26Z",
      "DueDate": "2025-03-10",
      "externalPaypointID": "micasa-10",
      "Frequency": "one-time",
      "IdBill": 6104,
      "LastUpdated": "2024-03-13T10:54:26Z",
      "Mode": 0,
      "NetAmount": 200,
      "ParentOrgName": "Fitness Hub",
      "PaypointDbaname": "MiCasa Sports",
      "PaypointEntryname": "micasa",
      "PaypointLegalname": "MiCasa Sports LLC",
      "Source": "web",
      "Status": 2,
      "Terms": "Net30",
      "Vendor": {
        "City": "Detroit",
        "Country": "US",
        "EIN": "XXXXX6789",
        "Name1": "Gomez-Radulescu Industries",
        "Phone": "517-555-0123",
        "State": "MI",
        "Zip": "48201",
        "Address1": "1234 Liberdad St.",
        "Address2": "Suite 100",
        "BillingData": {
          "accountNumber": "12345XXXX",
          "bankAccountFunction": 0,
          "bankAccountHolderName": "Elena Gomez",
          "bankAccountHolderType": "Business",
          "bankName": "Michigan Savings Bank",
          "id": 0,
          "routingAccount": "072000326",
          "typeAccount": "Checking"
        },
        "Email": "elenag@industriesexample.com",
        "InternalReferenceId": 1215,
        "Mcc": "700",
        "Name2": "Elena",
        "VendorId": 8723,
        "VendorNumber": "MI-vendor-2024031926",
        "VendorStatus": 1
      }
    }
  ],
  "total2approval": 1,
  "totalactive": 1,
  "totalAmount": 1.1,
  "totalamount2approval": 1.1,
  "totalamountactive": 1.1,
  "totalamountapproved": 1.1,
  "totalamountcancel": 1.1,
  "totalamountdisapproved": 1.1,
  "totalamountintransit": 1.1,
  "totalamountoverdue": 1.1,
  "totalamountpaid": 1.1,
  "totalamountsent2approval": 1.1,
  "totalapproved": 1,
  "totalcancel": 1,
  "totaldisapproved": 1,
  "totalintransit": 1,
  "totaloverdue": 1,
  "totalPages": 1,
  "totalpaid": 1,
  "totalRecords": 2,
  "totalsent2approval": 1
}

Retrieve a list of bills for an entrypoint. Use filters to limit results.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

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:

frequency (in, nin, ne, eq)
method (in, nin, eq, ne)
event (in, nin, eq, ne)
target (ct, nct, eq, ne)
status (eq, ne)
approvalUserId (eq, ne)
parentOrgId (ne, eq, nin, in)
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

Collection of field names, conditions, and values used to filter the query <Info> **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 </Info> See [Filters and Conditions Reference](/developer-guides/reporting-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) - approvalUserId (eq, ne) - parentOrgId (ne, eq, nin, in) - 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

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

pageidentifierstring

Auxiliary validation used internally by payment pages and components.

pageSizeinteger

Number of records on each response page.

Recordslist of objects

total2approvalinteger

totalactiveinteger

totalAmountdouble

Total amount of bills in response.

totalamount2approvaldouble

totalamountactivedouble

totalamountapproveddouble

The total amount of approved bills.

totalamountcanceldouble

totalamountdisapproveddouble

The total amount of disapproved bills.

totalamountintransitdouble

totalamountoverduedouble

The total amount of bills that are overdue.

totalamountpaiddouble

The total amount of paid bills.

totalamountsent2approvaldouble

totalapprovedinteger

The total number of bills that were approved.

totalcancelinteger

totaldisapprovedinteger

The number of bills that were disapproved.

totalintransitinteger

totaloverdueinteger

The number of bills that are overdue.

totalPagesinteger

Total number of pages in response.

totalpaidinteger

The total number of paid bills.

totalRecordsinteger

Total number of records in response.

totalsent2approvalinteger

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error