> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://beta-docs.payabli.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server. # List bills by organization GET https://api-sandbox.payabli.com/api/Query/bills/org/{orgId} Retrieve a list of bills for an organization. Use filters to limit results. Reference: https://beta-docs.payabli.com/api-reference/bill/get-list-of-bills-for-organization ## Authentication - `requestToken` header (required) — API Key authentication via header ## Servers - `https://api-sandbox.payabli.com/api` (Sandbox, default) - `https://api.payabli.com/api` (Production) ## Request ### Path parameters - `orgId` (integer, required) — The numeric identifier for organization, assigned by Payabli. ### Query parameters - `fromRecord` (integer, optional, default: 0) — The number of records to skip before starting to collect the result set. - `limitRecord` (integer, optional, default: 20) — Max number of records to return for the query. Use `0` or negative value to return all records. - `parameters` (map from string to string, optional) — 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](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](https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount\(gt\)=1000\&limitRecord=20) 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) * 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 - `sortBy` (string, optional) — 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 ### 200 Success - `pageidentifier` (string, optional) — Auxiliary validation used internally by payment pages and components. - `pageSize` (integer, optional) — Number of records on each response page. - `Records` (list of BillQueryRecord2, optional) - `total2approval` (integer, optional) - `totalactive` (integer, optional) - `totalAmount` (double, optional) — Total amount of bills in response. - `totalamount2approval` (double, optional) - `totalamountactive` (double, optional) - `totalamountapproved` (double, optional) — The total amount of approved bills. - `totalamountcancel` (double, optional) - `totalamountdisapproved` (double, optional) — The total amount of disapproved bills. - `totalamountintransit` (double, optional) - `totalamountoverdue` (double, optional) — The total amount of bills that are overdue. - `totalamountpaid` (double, optional) — The total amount of paid bills. - `totalamountsent2approval` (double, optional) - `totalapproved` (integer, optional) — The total number of bills that were approved. - `totalcancel` (integer, optional) - `totaldisapproved` (integer, optional) — The number of bills that were disapproved. - `totalintransit` (integer, optional) - `totaloverdue` (integer, optional) — The number of bills that are overdue. - `totalPages` (integer, optional) — Total number of pages in response. - `totalpaid` (integer, optional) — The total number of paid bills. - `totalRecords` (integer, optional) — Total number of records in response. - `totalsent2approval` (integer, optional) ## Errors ### 400 Bad Request Error Bad request/ invalid data - `any` ### 401 Unauthorized Error Unauthorized request. - `any` ### 500 Internal Server Error Internal API Error - `any` ### 503 Service Unavailable Error Database connection error - `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure. - `responseData` (map from string to any, optional) — The object containing the response data. - `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'. ## Types ### BillQueryRecord2 - `AccountingField1` (string, optional) — Optional custom field. - `AccountingField2` (string, optional) — Optional custom field. - `AdditionalData` (map from string to string, optional) — Additional data associated with the bill. - `BatchNumber` (string, optional) — Batch number associated with the bill. - `billApprovals` (list of BillQueryRecord2BillApprovalsItem, optional) — Approvals associated with the bill. - `BillDate` (date, optional) — Bill creation date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. - `billEvents` (list of GeneralEvents, optional) — Events associated with the bill. - `BillItems` (list of BillItem, optional) — Array of items included in the bill. - `BillNumber` (string, optional) — Bill number. - `Comments` (string, optional) — Additional comments on the bill. - `CreatedAt` (datetime, optional) — Timestamp of when bill was created, in UTC. - `DueDate` (date, optional) — Bill due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. - `externalPaypointID` (string, optional) — A custom identifier for the paypoint, if applicable. Like `entrypoint` is the Payabli identifier for the merchant, `externalPaypointId` is a custom field you can use to include the merchant's ID from your own systems. - `Frequency` (enum, optional) — Frequency for scheduled bills. Applied only in `Mode` = 1. - Allowed values: `one-time`, `weekly`, `every2weeks`, `every6months`, `monthly`, `every3months`, `annually` - `IdBill` (long, optional) — Identifier of the bill. - `LastUpdated` (datetime, optional) — Timestamp of when bill was last updated, in UTC. - `Mode` (integer, optional) — Bill mode: value `0` for single/one-time bills, `1` for scheduled bills. - `NetAmount` (double, optional) — Net amount of the bill. - `ParentOrgName` (string, optional) — The name of the parent organization. - `PaymentId` (string, optional) — Payment identifier. - `PaymentMethod` (enum, optional) — Preferred payment method used. - Allowed values: `vcard`, `ach`, `check`, `card` - `PaypointDbaname` (string, optional) — The paypoint's DBA name. - `PaypointEntryname` (string, optional) — Entry name of the paypoint. - `PaypointLegalname` (string, optional) — The paypoint's legal name. - `Source` (string, optional) — Source of the bill. - `Status` (integer, optional) — The bill's status. Values are: - `-99`: deleted or canceled - `1`: Active - `2`: Sent to approval - `5`: Partially approved - `11`: Rejected - `20`: Approved - `50`: Payment in transit - `100`: Paid " - `Terms` (string, optional) — The payment terms for invoice. If no terms were defined initially, then reponse data for this field will default to `N30`. - `Transaction` (TransactionOutQueryRecord, optional) — MoneyOut transaction associated to the bill. - `Vendor` (VendorOutData, optional) ### BillQueryRecord2BillApprovalsItem - `approved` (integer, optional) — Indicates whether the bill has been approved. `0` is false, and `1` is true. - `approvedTime` (datetime, optional) — Timestamp of when the approval was made, in UTC. - `comments` (string, optional) — Additional comments on the approval. - `email` (string, optional) — The approving user's email address. - `Id` (long, optional) — The approving user's ID. ### GeneralEvents - `description` (string, optional) — Event description. - `eventTime` (datetime, optional) — Event timestamp, in UTC. - `extraData` (map from string to any, optional) — Extra data. - `refData` (string, optional) — Reference data. - `source` (string, optional) — The event source. ### BillItem - `itemCost` (double, required) — Item or product price per unit. - `itemCategories` (list of string, optional) — Array of tags classifying item or product. - `itemCommodityCode` (string, optional) — Item or product commodity code. Max length of 250 characters. - `itemDescription` (string, optional) — Item or product description. Max length of 250 characters. - `itemMode` (integer, optional) — Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both. - `itemProductCode` (string, optional) — Item or product code. Max length of 250 characters. - `itemProductName` (string, optional) — Item or product name. Max length of 250 characters. - `itemQty` (integer, optional) — Quantity of item or product. - `itemTaxAmount` (double, optional) — Tax amount applied to item or product. - `itemTaxRate` (double, optional) — Tax rate applied to item or product. - `itemTotalAmount` (double, optional) — Total amount in item or product. - `itemUnitOfMeasure` (string, optional) — Unit of measurement. Max length of 100 characters. ### TransactionOutQueryRecord - `Bills` (list of BillPayOutData, optional) — Events associated to this transaction. - `CheckData` (FileContent, optional) — Object referencing to paper check image. - `CheckNumber` (string, optional) — Paper check number related to payout transaction. - `Comments` (string, optional) — Any comment or description for payout transaction. - `CreatedDate` (datetime, optional) — Timestamp when the payment was created, in UTC. - `Events` (list of QueryTransactionEvents, optional) — Events associated to this transaction. - `FeeAmount` (double, optional) — Service fee or sub-charge applied. - `Gateway` (string, optional) — Gateway used to process the transaction. - `IdOut` (long, optional) — Identifier of payout transaction. - `LastUpdated` (datetime, optional) — Timestamp when payment record was updated, in UTC. - `NetAmount` (double, optional) — Net amount. - `parentOrgName` (string, optional) — The name of the parent organization. - `PaymentData` (QueryPaymentData, optional) - `PaymentGroup` (string, optional) — Unique identifier for group or batch containing the transaction. - `PaymentId` (string, optional) — Unique transaction ID. - `PaymentMethod` (string, optional) — Method of payment applied to the transaction. - `PaymentStatus` (string, optional) — Status of payout transaction. - `paypointDbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `paypointLegalname` (string, optional) — Paypoint legal name. - `Source` (string, optional) — Custom identifier to indicate the transaction or request source. - `Status` (integer, optional) — Internal status of transaction. - `StatusText` (string, optional) — Status of payout transaction. - `TotalAmount` (double, optional) — Transaction total amount (including service fee or sub-charge). - `Vendor` (VendorQueryRecord, optional) — Vendor related to the payout transaction. ### VendorOutData - `City` (string, required) — Vendor's city. - `Country` (string, required) — Vendor's country. - `EIN` (string, required) — EIN/Tax ID for vendor. In reponses, this field is masked, and looks like: `XXXXX6789`. - `Name1` (string, required) — Primary name for vendor. Required for new vendor. - `Phone` (string, required) — Vendor's phone number - `State` (string, required) — Vendor's state. Must be a 2 character state code. - `Zip` (string, required) — Vendor's zip code. - `additionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `Address1` (string, optional) — Vendor's address - `Address2` (string, optional) — Additional line for vendor's address. - `BillingData` (BillingData, optional) — Object containing vendor's bank information. - `Contacts` (list of Contacts, optional) — Array of objects describing the vendor's contacts. - `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor side. - `Email` (string, optional) — Vendor's email address. Required for vCard. - `InternalReferenceId` (long, optional) — Internal identifier for global vendor account. - `LocationCode` (string, optional) — Additional location code used to identify the vendor. - `Mcc` (string, optional) — Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes. - `Name2` (string, optional) — Secondary name for vendor. - `payeeName1` (string, optional) — Alternative name used to receive paper check. - `payeeName2` (string, optional) — Alternative name used to receive paper check. - `PaymentMethod` (VendorPaymentMethod, optional) — Object containing details about the payment method to use for the payout. - `remitAddress1` (string, optional) — Remittance address. Used for mailing paper checks. - `remitAddress2` (string, optional) — Remittance address additional line. Used for mailing paper checks. - `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks. - `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks. - `remitState` (string, optional) — Remittance address state. Used for mailing paper checks. - `remitZip` (string, optional) — Remittance address ZIP code. Used for mailing paper checks. - `VendorId` (integer, optional) — Payabli identifier for vendor record. Required when `VendorNumber` isn't included. - `VendorNumber` (string, optional) — Custom number identifying the vendor. Must be unique in paypoint. - `VendorStatus` (integer, optional) — Vendor's status. Allowed status: - 0 Inactive - 1 Active ### BillPayOutData - `AccountingField1` (string, optional) — Optional custom field. - `AccountingField2` (string, optional) — Optional custom field. - `AdditionalData` (string, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `attachments` (list of FileContent, optional) — Bill image attachment. Send the bill image as Base64-encoded string, or as a publicly-accessible link. For full details on using this field with a payout authorization, see [the documentation](/developer-guides/pay-out-manage-payouts). - `billId` (long, optional) — Bill ID in Payabli. - `comments` (string, optional) — Any comments about bill. **For managed payouts, this field has a limit of 100 characters**. - `dueDate` (date, optional) — Bill due date in format YYYY-MM-DD or MM/DD/YYYY. - `invoiceDate` (date, optional) — Bill date in format YYYY-MM-DD or MM/DD/YYYY. - `invoiceNumber` (string, optional) — Custom number identifying the bill. Must be unique in paypoint. **Required** for new bill and when `billId` is not provided. - `netAmount` (string, optional) — Net Amount owed in bill. Required when adding a bill. - `Terms` (string, optional) — Description of payment terms. ### FileContent Contains details about a file. See See [fileObject Object Model](/api-reference/schemas/filecontent) for a complete reference. Max upload size is 30 MB. - `fContent` (string, optional) — Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB. - `filename` (string, optional) — The name of the attached file. - `ftype` (enum, optional) — The MIME type of the file (if content is provided) - Allowed values: `pdf`, `doc`, `docx`, `jpg`, `jpeg`, `png`, `gif`, `txt` - `furl` (string, optional) — Optional url provided to show or download the file remotely ### QueryTransactionEvents - `EventData` (QueryTransactionEventsEventData, optional) — Any data associated to the event received from processor. Contents vary by event type. - `EventTime` (datetime, optional) — Date and time of event. - `TransEvent` (string, optional) — Event descriptor. See [TransEvent Reference](/references/transevents) for more details. ### QueryPaymentData - `AccountExp` (string, optional) — Expiration date of card used in transaction. - `accountId` (string, optional) — Custom identifier for payment connector. - `AccountType` (string, optional) — Bank account type or card brand. - `AccountZip` (string, optional) — ZIP code for card used in transaction. - `binData` (BinData, optional) — Object containing information related to the card. This object is `null` unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay. - `HolderName` (string, optional) — Account holder name for the method. - `Initiator` (string, optional) — **Strongly recommended** The cardholder-initiated transaction (CIT) or merchant-initiated transaction (MIT) indicator for the transaction. If you don't specify a value, Payabli defaults to `merchant`. Available values: - `payor`: For cardholder-initiated transactions - `merchant`: For merchant-initiated transactions See [Understanding CIT and MIT Indicators](/guides/money-in-cit-mit) for more information. - `MaskedAccount` (string, optional) — Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number). - `orderDescription` (string, optional) — Text description of the transaction. - `paymentDetails` (PaymentDetail, optional) — Details about the payment. - `Sequence` (string, optional) — The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected and populated by Payabli. Available values: - `first`: The first use of the payment method. This is almost always a cardholder-initiated transaction. - `subsequent`: For merchant-initiated transactions after the first use of the payment method. See [Understanding CIT and MIT Indicators](/guides/money-in-cit-mit) for more information. - `SignatureData` (string, optional) - `StoredId` (string, optional) — Identifier of stored payment method used in transaction. - `StoredMethodUsageType` (string, optional) — **Strongly recommended** The usage type for the stored method, used for merchant-initiated transactions (MIT). If you don't specify a value, Payabli defaults to `unscheduled`. Available values: - `unscheduled`: This type is used for transactions that are one-time or otherwise not pre-scheduled. - `subscription`: This type is used for subscription payments. For example, monthly rental fees or ongoing service subscriptions. - `recurring`: This type is used for recurring payments that occur per a set plan. For example, splitting an HOA special assessment over 6 monthly payments. See [Understanding CIT and MIT Indicators](/guides/money-in-cit-mit) for more information. ### VendorQueryRecord - `additionalData` (map from string to map from string to any, optional) — Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using [custom identifiers](/developer-guides/entities-custom-identifiers), pass those in this object. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ``` - `address1` (string, optional) — Vendor's address. - `address2` (string, optional) — Additional line for vendor's address. - `billingData` (BillingDataResponse, optional) - `city` (string, optional) — Vendor's city. - `contacts` (list of Contacts, optional) — List of contacts. - `country` (string, optional) — Vendor's country. - `createdDate` (datetime, optional) — Timestamp of when record was created, in UTC. - `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor system. - `ein` (string, optional) — Business EIN or tax ID. This value is masked in API responses, for example `XXXX6789`. - `email` (string, optional) — Vendor's email address. - `enrollmentStatus` (string, optional) — Enrollment status of vendor in payables program. - `externalPaypointId` (string, optional) — A custom identifier for the paypoint, if applicable. Like `entrypoint` is the Payabli identifier for the merchant, `externalPaypointId` is a custom field you can use to include the merchant's ID from your own systems. - `internalReferenceId` (long, optional) — Internal identifier for global vendor account. - `lastUpdated` (datetime, optional) — Timestamp of when record was last updated, in UTC. - `locationCode` (string, optional) — Additional location code used to identify the vendor. - `mcc` (string, optional) — Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcc_codes.csv) lists MCC codes. - `name1` (string, optional) — Primary name for vendor. - `name2` (string, optional) — Secondary name for vendor. - `parentOrgName` (string, optional) — The name of the parent organization. - `payeeName1` (string, optional) — Alternative name used to receive paper check. - `payeeName2` (string, optional) — Alternative name used to receive paper check. - `paymentMethod` (VendorPaymentMethod, optional) — Object containing details about the payment method to use for the payout. - `paypointDbaname` (string, optional) — The alternate or common name that this business is doing business under usually referred to as a DBA name. - `paypointEntryname` (string, optional) — The entrypoint identifier. - `paypointLegalname` (string, optional) — Business legal name. - `phone` (string, optional) — Vendor's phone number. - `remitAddress1` (string, optional) — Remittance address. Used for mailing paper checks. - `remitAddress2` (string, optional) — Remittance address additional line. Used for mailing paper checks. - `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks. - `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks. - `remitState` (string, optional) — Remittance address state. Used for mailing paper checks. - `remitZip` (string, optional) — Remittance address ZIP code. Used for mailing paper checks. - `state` (string, optional) — Vendor's state. - `summary` (VendorSummary, optional) - `vendorId` (integer, optional) — Payabli identifier for vendor record. - `vendorNumber` (string, optional) — Custom number identifying the vendor. Must be unique in paypoint. - `vendorStatus` (integer, optional) — Vendor's status. Allowed status: - 0 Inactive - 1 Active - `zip` (string, optional) — Vendor's zip code. ### BillingData - `accountNumber` (string, optional) — Account number for bank account. - `bankAccountFunction` (integer, optional) — Describes whether the bank account is used for deposits or withdrawals in Payabli: - `0`: Deposit - `1`: Withdrawal - `2`: Deposit and withdrawal - `bankAccountHolderName` (string, optional) — The accountholder's name. - `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account. - Allowed values: `Personal`, `Business` - `bankName` (string, optional) — Name of bank for account. - `id` (integer, optional) — The bank's ID in Payabli. - `routingAccount` (string, optional) — Routing number of bank account. - `typeAccount` (enum, optional) — Type of bank account: Checking or Savings. - Allowed values: `Checking`, `Savings` ### Contacts - `contactEmail` (string, optional) — Contact email address. - `contactName` (string, optional) — Contact name. - `contactPhone` (string, optional) — Contact phone number. - `contactTitle` (string, optional) — Contact title. ### VendorPaymentMethod Object containing details about the payment method to use for the payout. - `method` (enum, optional) — Payment method to use for payout. Leave empty for managed payables. - Allowed values: `managed`, `vcard`, `ach`, `check` ### QueryTransactionEventsEventData Any data associated to the event received from processor. Contents vary by event type. ### BinData Object containing information related to the card. This object is `null` unless the payment method is card. If the payment method is Apple Pay, the binData will be related to the DPAN (device primary account number), not the card connected to Apple Pay. - `binCardBrand` (string, optional) — The card brand. For example, Visa, Mastercard, American Express, Discover. - `binCardCategory` (string, optional) — The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked `PREPAID`. - `binCardIssuer` (string, optional) — The name of the financial institution that issued the card. - `binCardIssuerCountry` (string, optional) — The issuing financial institution's country name. - `binCardIssuerCountryCodeA2` (string, optional) — The issuing financial institution's two-character ISO country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. - `binCardIssuerCountryNumber` (double, optional) — The issuing financial institution's ISO standard numeric country code. See [this resource](https://www.iso.org/obp/ui/#search) for a list of codes. - `binCardType` (string, optional) — The type of card: Credit or Debit. - `binMatchedLength` (double, optional) — The number of characters from the beginning of the card number that were matched against a Bank Identification Number (BIN) or the Card Range table. ### PaymentDetail Details about the payment. - `totalAmount` (double, required) — Total amount to be charged. If a service fee is sent, then this amount should include the service fee." - `categories` (list of PaymentCategories, optional) — Array of payment categories/line items describing the amount to be paid **Note**: These categories are for information only and are not validated against the total amount provided. - `checkImage` (map from string to any, optional) — Object containing image of paper check. - `checkNumber` (string, optional) — A check number to be used in the ach transaction. **Required** for payment method = 'check'. - `currency` (string, optional) — Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is **USD**. - `serviceFee` (double, optional) — Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. If you are using a percentage-based fee schedule, you must calculate the value manually. - `splitFunding` (list of SplitFundingContent, optional) — Split funding instructions for the transaction. See [Split a Transaction](/developer-guides/money-in-split-funding) for more. ### BillingDataResponse - `accountNumber` (string, optional) — Masked account number for bank account. - `bankAccountFunction` (integer, optional) — Describes whether the bank account is used for deposits or withdrawals in Payabli: - `0`: Deposit - `1`: Withdrawal - `2`: Deposit and withdrawal - `bankAccountHolderName` (string, optional) — The accountholder's name. - `bankAccountHolderType` (enum, optional) — Describes whether the bank is a personal or business account. - Allowed values: `Personal`, `Business` - `bankName` (string, optional) — Name of bank for account. - `id` (integer, optional) — The bank's ID in Payabli. - `routingAccount` (string, optional) — Routing number of bank account. - `typeAccount` (enum, optional) — Type of bank account: Checking or Savings. - Allowed values: `Checking`, `Savings` ### VendorSummary - `inTransitBills` (integer, optional) - `inTransitBillsAmount` (double, optional) - `overdueBills` (integer, optional) - `overdueBillsAmount` (double, optional) - `paidBills` (integer, optional) - `paidBillsAmount` (double, optional) - `pendingBills` (integer, optional) - `pendingBillsAmount` (double, optional) - `totalBills` (integer, optional) - `totalBillsAmount` (double, optional) ### PaymentCategories - `amount` (double, required) — Price/cost per unit of item or category. - `label` (string, required) — Name of item or category. - `description` (string, optional) — Description of item or category - `qty` (integer, optional, default: 1) — Quatity of item or category ### SplitFundingContent - `accountId` (string, optional) — The accountId for the account the split should be sent to. - `amount` (double, optional) — Amount from the transaction to sent to this recipient. - `description` (string, optional) — A description for the split. - `recipientEntryPoint` (string, optional) — The entrypoint the split should be sent to. ## Examples **Response** ```json { "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 } ``` **SDK Code** ```python An example response for bill queries. import requests url = "https://api-sandbox.payabli.com/api/Query/bills/org/123" querystring = {"fromRecord":"251","limitRecord":"0","sortBy":"desc(field_name)"} headers = {"requestToken": ""} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript An example response for bill queries. const url = 'https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29'; const options = {method: 'GET', headers: {requestToken: ''}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go An example response for bill queries. package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("requestToken", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby An example response for bill queries. require 'uri' require 'net/http' url = URI("https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["requestToken"] = '' response = http.request(request) puts response.read_body ``` ```java An example response for bill queries. import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29") .header("requestToken", "") .asString(); ``` ```php An example response for bill queries. request('GET', 'https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29', [ 'headers' => [ 'requestToken' => '', ], ]); echo $response->getBody(); ``` ```csharp An example response for bill queries. using RestSharp; var client = new RestClient("https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29"); var request = new RestRequest(Method.GET); request.AddHeader("requestToken", ""); IRestResponse response = client.Execute(request); ``` ```swift An example response for bill queries. import Foundation let headers = ["requestToken": ""] let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/bills/org/123?fromRecord=251&limitRecord=0&sortBy=desc%28field_name%29")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```