Get List of Bills for an Organization

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[]

Records.IdBill

integer

Identifier of the bill.

Example:

6104

Records.BillNumber

string

Bill number.

Example:

"QA-bill-1710345266"

Records.NetAmount

number

Net amount of the bill.

Example:

200

Records.BillDate

string | null

Bill creation date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2026-03-10T00:00:00"

Records.DueDate

string | null

Bill due date in one of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

Example:

"2027-03-10T00:00:00"

Records.Comments

string

Additional comments on the bill.

Example:

"Adjusted via phone call."

Records.BatchNumber

string

Batch number associated with the bill.

Example:

"BT-101"

Records.BillItems

object[]

Array of items included in the bill.

Records.Mode

enum<integer>

Bill mode: value 0 for single/one-time bills, 1 for scheduled bills.

Available options:

0,

1

Records.PaymentMethod

enum<string> | null

Preferred payment method used.

Available options:

vcard,

ach,

check,

card

Example:

"vcard"

Records.PaymentId

string

Payment identifier.

Example:

null

Records.AccountingField1

string | null

Optional custom field.

Example:

"MyInternalId"

Records.AccountingField2

string | null

Optional custom field.

Example:

"MyInternalId"

Records.Terms

string | null

The payment terms for invoice. If no terms were defined initially, then reponse data for this field will default to N30.

Example:

"NET30"

Records.Source

string

Source of the bill.

Example:

"web"

Records.AdditionalData

object

Additional data associated with the bill.

Records.Vendor

object

Records.Vendor.Name1

string

required

Primary name for vendor. Required for new vendor.

Example:

"Herman's Coatings and Masonry"

Records.Vendor.EIN

string

required

EIN/Tax ID for vendor. In reponses, this field is masked, and looks like: XXXXX6789.

Example:

"12-3456789"

Records.Vendor.Phone

string

required

Vendor's phone number

Example:

"5555555555"

Records.Vendor.Address1

string | null

required

Vendor's address

Example:

"123 Ocean Drive"

Records.Vendor.City

string

required

Vendor's city.

Example:

"Miami"

Records.Vendor.State

string

required

Vendor's state. Must be a 2 character state code.

Example:

"FL"

Records.Vendor.Zip

string

required

Vendor's zip code.

Example:

"33139"

Records.Vendor.Country

string

required

Vendor's country.

Example:

"US"

Records.Vendor.VendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

Example:

"1234"

Records.Vendor.Name2

string | null

Secondary name for vendor.

Records.Vendor.Email

string | null

Vendor's email address. Required for vCard.

Maximum length: 320

Example:

"example@email.com"

Records.Vendor.Address2

string | null

Additional line for vendor's address.

Example:

"Suite 400"

Records.Vendor.Mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Example:

"7777"

Records.Vendor.LocationCode

string | null

Additional location code used to identify the vendor.

Example:

"MIA123"

Records.Vendor.Contacts

object[] | null

Array of objects describing the vendor's contacts.

Records.Vendor.BillingData

object

Object containing vendor's bank information.

Records.Vendor.PaymentMethod

object

Object containing details about the payment method to use for the payout.

Records.Vendor.VendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Example:

1

Records.Vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

Records.Vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

Records.Vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

Records.Vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

Records.Vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

Records.Vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

Records.Vendor.payeeName1

string | null

Alternative name used to receive paper check.

Records.Vendor.payeeName2

string | null

Alternative name used to receive paper check.

Records.Vendor.customerVendorAccount

string | null

Account number of paypoint in the vendor side.

Example:

"A-37622"

Records.Vendor.InternalReferenceId

integer | null

Internal identifier for global vendor account.

Records.Vendor.VendorId

integer | null

Payabli identifier for vendor record. Required when VendorNumber isn't included.

Example:

"1340"

Records.Vendor.additionalData

object

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:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Records.Status

enum<integer>

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 "

Available options:

-99,

1,

2,

5,

11,

20,

50,

100

Records.CreatedAt

string

Timestamp of when bill was created, in UTC.

Example:

"2022-07-01 15:00:01"

Records.LastUpdated

string | null

Timestamp of when bill was last updated, in UTC.

Example:

"2025-10-19T00:00:00"

Records.Frequency

enum<string> | null

Frequency for scheduled bills. Applied only in Mode = 1.

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

Example:

"monthly"

Records.Transaction

object

MoneyOut transaction associated to the bill.

Records.Transaction.IdOut

integer

Identifier of payout transaction.

Example:

236

Records.Transaction.Vendor

object

Vendor related to the payout transaction.

Records.Transaction.Vendor.vendorNumber

string | null

Custom number identifying the vendor. Must be unique in paypoint.

Example:

"1234"

Records.Transaction.Vendor.name1

string | null

Primary name for vendor.

Example:

"Herman's Coatings"

Records.Transaction.Vendor.name2

string | null

Secondary name for vendor.

Example:

"Herman's Coating Supply Company, LLC"

Records.Transaction.Vendor.ein

string | null

Business EIN or tax ID. This value is masked in API responses, for example XXXX6789.

Example:

"123456789"

Records.Transaction.Vendor.phone

string | null

Vendor's phone number.

Example:

"212-555-1234"

Records.Transaction.Vendor.email

string | null

Vendor's email address.

Maximum length: 320

Example:

"example@email.com"

Records.Transaction.Vendor.address1

string | null

Vendor's address.

Example:

"123 Ocean Drive"

Records.Transaction.Vendor.address2

string | null

Additional line for vendor's address.

Example:

"Suite 400"

Records.Transaction.Vendor.city

string | null

Vendor's city.

Example:

"Bristol"

Records.Transaction.Vendor.state

string | null

Vendor's state.

Example:

"GA"

Records.Transaction.Vendor.zip

string | null

Vendor's zip code.

Example:

"31113"

Records.Transaction.Vendor.country

string | null

Vendor's country.

Example:

"US"

Records.Transaction.Vendor.mcc

string | null

Business Merchant Category Code (MCC). This resource lists MCC codes.

Example:

"7777"

Records.Transaction.Vendor.locationCode

string | null

Additional location code used to identify the vendor.

Example:

"LOC123"

Records.Transaction.Vendor.contacts

object[] | null

List of contacts.

Records.Transaction.Vendor.billingData

object

Records.Transaction.Vendor.paymentMethod

object

Object containing details about the payment method to use for the payout.

Records.Transaction.Vendor.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Example:

1

Records.Transaction.Vendor.vendorId

integer | null

Payabli identifier for vendor record.

Example:

"1340"

Records.Transaction.Vendor.enrollmentStatus

string | null

Enrollment status of vendor in payables program.

Example:

null

Records.Transaction.Vendor.summary

object

Records.Transaction.Vendor.paypointLegalname

string | null

Business legal name.

Example:

"Sunshine Services, LLC"

Records.Transaction.Vendor.paypointDbaname

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Example:

"Sunshine Gutters"

Records.Transaction.Vendor.paypointEntryname

string | null

The entrypoint identifier.

Maximum length: 50

Example:

"d193cf9a46"

Records.Transaction.Vendor.parentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

Records.Transaction.Vendor.createdDate

string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

Records.Transaction.Vendor.lastUpdated

string | null

Timestamp of when record was last updated, in UTC.

Example:

"2022-07-01 15:00:01"

Records.Transaction.Vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

Records.Transaction.Vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

Records.Transaction.Vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

Records.Transaction.Vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

Records.Transaction.Vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

Records.Transaction.Vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

Records.Transaction.Vendor.payeeName1

string | null

Alternative name used to receive paper check.

Records.Transaction.Vendor.payeeName2

string | null

Alternative name used to receive paper check.

Records.Transaction.Vendor.customerVendorAccount

string | null

Account number of paypoint in the vendor system.

Example:

"123-456"

Records.Transaction.Vendor.internalReferenceId

integer | null

Internal identifier for global vendor account.

Records.Transaction.Vendor.additionalData

object

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:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Records.Transaction.Vendor.externalPaypointId

string | null

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.

Example:

"Paypoint-100"

Records.Transaction.Comments

string | null

Any comment or description for payout transaction.

Maximum length: 250

Example:

"Deposit for materials"

Records.Transaction.parentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

Records.Transaction.paypointDbaname

string | null

The alternate or common name that this business is doing business under usually referred to as a DBA name.

Example:

"Sunshine Gutters"

Records.Transaction.paypointLegalname

string | null

Paypoint legal name.

Example:

"Sunshine Services, LLC"

Records.Transaction.TotalAmount

number

Transaction total amount (including service fee or sub-charge).

Example:

110.25

Records.Transaction.NetAmount

number | null

Net amount.

Example:

100

Records.Transaction.FeeAmount

number

Service fee or sub-charge applied.

Example:

10.25

Records.Transaction.Source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Example:

"api"

Records.Transaction.PaymentId

string | null

Unique transaction ID.

Example:

"2345667-ddd-fff"

Records.Transaction.PaymentGroup

string | null

Unique identifier for group or batch containing the transaction.

Example:

"2345667-ddd-fff"

Records.Transaction.Status

integer

Internal status of transaction.

Example:

1

Records.Transaction.Gateway

string | null

Gateway used to process the transaction.

Example:

"TSYS"

Records.Transaction.StatusText

string | null

Status of payout transaction.

Example:

"Captured"

Records.Transaction.PaymentStatus

string | null

Status of payout transaction.

Example:

"Processed"

Records.Transaction.CheckNumber

string | null

Paper check number related to payout transaction.

Example:

"12345"

Records.Transaction.CheckData

object | null

Object referencing to paper check image.

Records.Transaction.PaymentMethod

string | null

Method of payment applied to the transaction.

Example:

"ach"

Records.Transaction.PaymentData

object

Records.Transaction.PaymentData.MaskedAccount

string | null

Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).

Example:

"4XXXXXXXX1111"

Records.Transaction.PaymentData.AccountType

string | null

Bank account type or card brand.

Example:

"visa"

Records.Transaction.PaymentData.AccountExp

string | null

Expiration date of card used in transaction.

Example:

"11/29"

Records.Transaction.PaymentData.AccountZip

string | null

ZIP code for card used in transaction.

Example:

"90210"

Records.Transaction.PaymentData.HolderName

string | null

Account holder name for the method.

Example:

"Chad Mercia"

Records.Transaction.PaymentData.orderDescription

string | null

Text description of the transaction.

Maximum length: 250

Example:

"Depost for materials for 123 Walnut St"

Records.Transaction.PaymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

Example:

"1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440"

Records.Transaction.PaymentData.Initiator

string | null

default:merchant

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 for more information.

Example:

"payor"

Records.Transaction.PaymentData.StoredMethodUsageType

string | null

default:unscheduled

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 for more information.

Example:

"subscription"

Records.Transaction.PaymentData.Sequence

string | null

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 for more information.

Example:

"subsequent"

Records.Transaction.PaymentData.accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

Records.Transaction.PaymentData.SignatureData

string | null

Example:

null

Records.Transaction.PaymentData.binData

object

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.

Records.Transaction.PaymentData.paymentDetails

object

Details about the payment.

Records.Transaction.Bills

object[] | null

Events associated to this transaction.

Records.Transaction.Bills.invoiceNumber

string | null

Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId is not provided.

Maximum length: 250

Example:

"INV-2345"

Records.Transaction.Bills.netAmount

string | null

Net Amount owed in bill. Required when adding a bill.

Example:

3762.87

Records.Transaction.Bills.invoiceDate

string | null

Bill date in format YYYY-MM-DD or MM/DD/YYYY.

Example:

"2024-07-01"

Records.Transaction.Bills.dueDate

string | null

Bill due date in format YYYY-MM-DD or MM/DD/YYYY.

Example:

"2024-07-01"

Records.Transaction.Bills.comments

string | null

Any comments about bill. For managed payouts, this field has a limit of 100 characters.

Maximum length: 250

Example:

"Deposit for materials"

Records.Transaction.Bills.AccountingField1

string | null

Optional custom field.

Example:

"MyInternalId"

Records.Transaction.Bills.AccountingField2

string | null

Optional custom field.

Example:

"MyInternalId"

Records.Transaction.Bills.AdditionalData

string | null

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:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

Example:

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Records.Transaction.Bills.Terms

string | null

Description of payment terms.

Example:

"NET30"

Records.Transaction.Bills.billId

integer | null

Bill ID in Payabli.

Records.Transaction.Bills.attachments

object[] | null

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.

Contains details about a file. See See fileObject Object Model for a complete reference. Max upload size is 30 MB.

Records.Transaction.Events

object[] | null

Events associated to this transaction.

Records.Transaction.CreatedDate

string

Timestamp when the payment was created, in UTC.

Example:

"2022-07-01 15:00:01"

Records.Transaction.LastUpdated

string | null

Timestamp when payment record was updated, in UTC.

Example:

"2022-07-01 15:00:01"

Records.billEvents

object[]

Events associated with the bill.

Records.billApprovals

array

Approvals associated with the bill.

Records.PaypointLegalname

string | null

The paypoint's legal name.

Example:

"Sunshine Services, LLC"

Records.PaypointDbaname

string | null

The paypoint's DBA name.

Example:

"Sunshine Gutters"

Records.ParentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

Records.PaypointEntryname

string

Entry name of the paypoint.

Example:

"47acedf1"

Records.externalPaypointID

string | null

Example:

"Paypoint-100"

Was this page helpful?

Get List of Bills for a Paypoint

Get Statistics for Paypoint or Organization

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
    }
  ]
}

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Get List of Bills for an Organization

Authorizations

Path Parameters

Query Parameters

Response