Get Bill - Payabli Docs

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

GET

Bill

{idBill}

curl --request GET \
  --url https://api-sandbox.payabli.com/api/Bill/{idBill} \
  --header 'requestToken: <api-key>'

{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": {
    "billNumber": "ABC-123",
    "netAmount": 3762.87,
    "billDate": "2024-07-01",
    "dueDate": "2024-07-01",
    "comments": "Deposit for materials",
    "billItems": [
      {
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemDescription": "Deposit for materials.",
        "itemCommodityCode": "010",
        "itemUnitOfMeasure": "SqFt",
        "itemCost": 5,
        "itemQty": 1,
        "itemMode": 0,
        "itemCategories": [
          null
        ],
        "itemTotalAmount": 123,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075
      }
    ],
    "mode": 0,
    "accountingField1": "MyInternalId",
    "accountingField2": "MyInternalId",
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "vendor": {
      "vendorNumber": "1234",
      "name1": "Herman's Coatings and Masonry",
      "name2": null,
      "ein": "XXXX6789",
      "phone": "5555555555",
      "email": "contact@hermanscoatings.com",
      "address1": "123 Ocean Drive",
      "address2": "Suite 400",
      "city": "Miami",
      "state": "FL",
      "zip": "33139",
      "country": "US",
      "mcc": "7777",
      "locationCode": "MIA123",
      "contacts": [
        {
          "contactName": "Herman Martinez",
          "contactEmail": "herman@hermanscoatings.com",
          "contactTitle": "Owner",
          "contactPhone": "3055550000"
        }
      ],
      "billingData": {
        "id": 123,
        "bankName": "Country Bank",
        "routingAccount": "123123123",
        "accountNumber": "1XXXXXX3123",
        "typeAccount": "Checking",
        "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
        "bankAccountHolderType": "Business",
        "bankAccountFunction": 0
      },
      "paymentMethod": "vcard",
      "vendorStatus": 1,
      "remitAddress1": "123 Walnut Street",
      "remitAddress2": "Suite 900",
      "remitCity": "Miami",
      "remitState": "FL",
      "remitZip": "31113",
      "remitCountry": "US",
      "payeeName1": null,
      "payeeName2": null,
      "customerVendorAccount": "A-37622",
      "internalReferenceId": 123,
      "vendorId": "1340",
      "AdditionalData": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      }
    },
    "endDate": "2024-07-01",
    "frequency": "monthly",
    "terms": "NET30",
    "status": -99,
    "Transaction": {
      "IdOut": 236,
      "Vendor": {
        "vendorNumber": "1234",
        "name1": "Herman's Coatings",
        "name2": "Herman's Coating Supply Company, LLC",
        "ein": "123456789",
        "phone": "212-555-1234",
        "email": "example@example.com",
        "address1": "123 Ocean Drive",
        "address2": "Suite 400",
        "city": "Bristol",
        "state": "GA",
        "zip": "31113",
        "country": "US",
        "mcc": "7777",
        "locationCode": "LOC123",
        "contacts": [
          {
            "contactName": "Herman Martinez",
            "contactEmail": "herman@hermanscoatings.com",
            "contactTitle": "Owner",
            "contactPhone": "3055550000"
          }
        ],
        "billingData": {
          "id": 123,
          "bankName": "Country Bank",
          "routingAccount": "123123123",
          "accountNumber": "1XXXXXX3123",
          "typeAccount": "Checking",
          "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
          "bankAccountHolderType": "Business",
          "bankAccountFunction": 0
        },
        "paymentMethod": {
          "method": "managed"
        },
        "vendorStatus": 1,
        "vendorId": "1340",
        "enrollmentStatus": null,
        "summary": {
          "pendingBills": 123,
          "inTransitBills": 123,
          "paidBills": 123,
          "overdueBills": 123,
          "totalBills": 123,
          "pendingBillsAmount": 123,
          "inTransitBillsAmount": 123,
          "paidBillsAmount": 123,
          "overdueBillsAmount": 123,
          "totalBillsAmount": 123
        },
        "paypointLegalname": "Sunshine Services, LLC",
        "paypointDbaname": "Sunshine Gutters",
        "paypointEntryname": "d193cf9a46",
        "parentOrgName": "PropertyManager Pro",
        "createdDate": "2022-07-01 15:00:01",
        "lastUpdated": "2022-07-01 15:00:01",
        "remitAddress1": "123 Walnut Street",
        "remitAddress2": "Suite 900",
        "remitCity": "Miami",
        "remitState": "FL",
        "remitZip": "31113",
        "remitCountry": "US",
        "payeeName1": null,
        "payeeName2": null,
        "customerVendorAccount": "123-456",
        "internalReferenceId": 123,
        "additionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
        "externalPaypointId": "Paypoint-100"
      },
      "Comments": "Deposit for materials",
      "parentOrgName": "PropertyManager Pro",
      "paypointDbaname": "Sunshine Gutters",
      "paypointLegalname": "Sunshine Services, LLC",
      "TotalAmount": 110.25,
      "NetAmount": 100,
      "FeeAmount": 10.25,
      "Source": "api",
      "PaymentId": "2345667-ddd-fff",
      "PaymentGroup": "2345667-ddd-fff",
      "Status": 1,
      "PaymentStatus": "Processed",
      "CheckNumber": "12345",
      "CheckData": {
        "ftype": "pdf",
        "filename": "my-doc.pdf",
        "furl": "https://mysite.com/my-doc.pdf",
        "fContent": "TXkgdGVzdCBmaWxlHJ==..."
      },
      "PaymentMethod": "ach",
      "PaymentData": {
        "MaskedAccount": "4XXXXXXXX1111",
        "AccountType": "visa",
        "AccountExp": "11/29",
        "AccountZip": "90210",
        "HolderName": "Chad Mercia",
        "orderDescription": "Depost for materials for 123 Walnut St",
        "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
        "Initiator": "payor",
        "StoredMethodUsageType": "subscription",
        "Sequence": "subsequent",
        "accountId": null,
        "SignatureData": null,
        "binData": {
          "binMatchedLength": 6,
          "binCardBrand": "Visa",
          "binCardType": "Credit",
          "binCardCategory": "PLATINUM",
          "binCardIssuer": "Bank of Example",
          "binCardIssuerCountry": "United States",
          "binCardIssuerCountryCodeA2": "US",
          "binCardIssuerCountryNumber": 840
        },
        "paymentDetails": {
          "totalAmount": 100,
          "serviceFee": 0,
          "currency": "USD",
          "checkNumber": "107",
          "checkImage": {},
          "categories": [
            {
              "label": "Deposit",
              "description": "Deposit for materials",
              "amount": 1000,
              "qty": 123
            }
          ],
          "splitFunding": [
            {
              "recipientEntryPoint": "41035afaa7",
              "accountId": "187-782",
              "description": "Split for annual dues",
              "amount": 456.23
            }
          ]
        }
      },
      "Bills": [
        {
          "invoiceNumber": "INV-2345",
          "netAmount": 3762.87,
          "invoiceDate": "2024-07-01",
          "dueDate": "2024-07-01",
          "comments": "Deposit for materials",
          "AccountingField1": "MyInternalId",
          "AccountingField2": "MyInternalId",
          "AdditionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          },
          "Terms": "NET30",
          "billId": 123,
          "attachments": [
            {
              "ftype": "pdf",
              "filename": "my-doc.pdf",
              "furl": "https://mysite.com/my-doc.pdf",
              "fContent": "TXkgdGVzdCBmaWxlHJ==..."
            }
          ]
        }
      ],
      "Events": [
        {
          "TransEvent": "Approved",
          "EventData": {},
          "EventTime": "2023-11-07T05:31:56Z"
        }
      ],
      "CreatedDate": "2022-07-01 15:00:01",
      "LastUpdated": "2022-07-01 15:00:01"
    }
  }
}

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

idBill

integer

required

Payabli ID for the bill. Get this ID by querying /api/Query/bills/ for the entrypoint or the organization.

Example:

285

Response

200

application/json

Success

isSuccess

boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText

string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

responseData

object

If isSuccess = true, this contains the Bill identifier. If isSuccess = false, this contains the reason for the error.

responseData.billNumber

string | null

Unique identifier for the bill. Required for new bill.

Example:

"ABC-123"

responseData.netAmount

string | null

Net amount owed in bill.

Example:

3762.87

responseData.billDate

string | null

Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY

Example:

"2024-07-01"

responseData.dueDate

string | null

Due Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY

Example:

"2024-07-01"

responseData.comments

string | null

Any comment or description.

Maximum length: 250

Example:

"Deposit for materials"

responseData.billItems

object[] | null

Array of LineItems contained in bill.

responseData.mode

enum<integer>

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

Available options:

0,

1

responseData.accountingField1

string | null

Optional custom field.

Example:

"MyInternalId"

responseData.accountingField2

string | null

Optional custom field.

Example:

"MyInternalId"

responseData.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"
}

responseData.vendor

object

responseData.vendor.vendorNumber

string | null

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

Example:

"1234"

responseData.vendor.name1

string | null

Primary name for vendor.

Example:

"Herman's Coatings and Masonry"

responseData.vendor.name2

string | null

Secondary name for vendor.

responseData.vendor.ein

string | null

EIN/Tax ID for vendor. Inresponses, this field is masked, and looks like: "ein": "XXXXX6789".

Example:

"12-3456789"

responseData.vendor.phone

string | null

Vendor's phone number.

Example:

"5555555555"

responseData.vendor.email

string | null

Vendor's email address.

Maximum length: 320

Example:

"example@email.com"

responseData.vendor.address1

string | null

Vendor's address.

Example:

"123 Ocean Drive"

responseData.vendor.address2

string | null

Additional line for vendor's address.

Example:

"Suite 400"

responseData.vendor.city

string | null

Vendor's city.

Example:

"Miami"

responseData.vendor.state

string | null

Vendor's state. Must be a two-character state code.

Example:

"FL"

responseData.vendor.zip

string | null

Vendor's zip code.

Example:

"33139"

responseData.vendor.country

string | null

Vendor's country. Payabli supports only US and Canadian vendors.

Example:

"US"

responseData.vendor.mcc

string | null

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

Example:

"7777"

responseData.vendor.locationCode

string | null

Additional location code used to identify the vendor.

Example:

"MIA123"

responseData.vendor.contacts

object[] | null

List of contacts.

responseData.vendor.billingData

object

Object containing vendor's bank information.

responseData.vendor.paymentMethod

enum<string> | null

Preferred payment method for vendor.

Available options:

vcard,

ach,

check,

card

Example:

"vcard"

responseData.vendor.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Example:

1

responseData.vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

responseData.vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

responseData.vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

responseData.vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

responseData.vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

responseData.vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

responseData.vendor.payeeName1

string | null

Alternative name used to receive paper check.

responseData.vendor.payeeName2

string | null

Alternative name used to receive paper check.

responseData.vendor.customerVendorAccount

string | null

Account number of paypoint in the Vendor side.

Example:

"A-37622"

responseData.vendor.internalReferenceId

integer | null

Internal identifier for global vendor account.

responseData.vendor.vendorId

integer | null

Payabli identifier for vendor record.

Example:

"1340"

responseData.vendor.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"
}

responseData.endDate

string | null

End date for scheduled bills. Applied only in Mode = 1.

Example:

"2024-07-01"

responseData.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"

responseData.terms

string | null

Description of payment terms.

Example:

"NET30"

responseData.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

responseData.DocumentRefs

object

Object with the attached documents.

responseData.Transaction

object

MoneyOut transaction associated to the bill

responseData.Transaction.IdOut

integer

Identifier of payout transaction.

Example:

236

responseData.Transaction.Vendor

object

Vendor related to the payout transaction.

responseData.Transaction.Vendor.vendorNumber

string | null

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

Example:

"1234"

responseData.Transaction.Vendor.name1

string | null

Primary name for vendor.

Example:

"Herman's Coatings"

responseData.Transaction.Vendor.name2

string | null

Secondary name for vendor.

Example:

"Herman's Coating Supply Company, LLC"

responseData.Transaction.Vendor.ein

string | null

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

Example:

"123456789"

responseData.Transaction.Vendor.phone

string | null

Vendor's phone number.

Example:

"212-555-1234"

responseData.Transaction.Vendor.email

string | null

Vendor's email address.

Maximum length: 320

Example:

"example@email.com"

responseData.Transaction.Vendor.address1

string | null

Vendor's address.

Example:

"123 Ocean Drive"

responseData.Transaction.Vendor.address2

string | null

Additional line for vendor's address.

Example:

"Suite 400"

responseData.Transaction.Vendor.city

string | null

Vendor's city.

Example:

"Bristol"

responseData.Transaction.Vendor.state

string | null

Vendor's state.

Example:

"GA"

responseData.Transaction.Vendor.zip

string | null

Vendor's zip code.

Example:

"31113"

responseData.Transaction.Vendor.country

string | null

Vendor's country.

Example:

"US"

responseData.Transaction.Vendor.mcc

string | null

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

Example:

"7777"

responseData.Transaction.Vendor.locationCode

string | null

Additional location code used to identify the vendor.

Example:

"LOC123"

responseData.Transaction.Vendor.contacts

object[] | null

List of contacts.

responseData.Transaction.Vendor.billingData

object

responseData.Transaction.Vendor.paymentMethod

object

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

responseData.Transaction.Vendor.vendorStatus

integer | null

Vendor's status. Allowed status:

0 Inactive
1 Active

Example:

1

responseData.Transaction.Vendor.vendorId

integer | null

Payabli identifier for vendor record.

Example:

"1340"

responseData.Transaction.Vendor.enrollmentStatus

string | null

Enrollment status of vendor in payables program.

Example:

null

responseData.Transaction.Vendor.summary

object

responseData.Transaction.Vendor.paypointLegalname

string | null

Business legal name.

Example:

"Sunshine Services, LLC"

responseData.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"

responseData.Transaction.Vendor.paypointEntryname

string | null

The entrypoint identifier.

Maximum length: 50

Example:

"d193cf9a46"

responseData.Transaction.Vendor.parentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

responseData.Transaction.Vendor.createdDate

string

Timestamp of when record was created, in UTC.

Example:

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

responseData.Transaction.Vendor.lastUpdated

string | null

Timestamp of when record was last updated, in UTC.

Example:

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

responseData.Transaction.Vendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

responseData.Transaction.Vendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

responseData.Transaction.Vendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

responseData.Transaction.Vendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

responseData.Transaction.Vendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

responseData.Transaction.Vendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

responseData.Transaction.Vendor.payeeName1

string | null

Alternative name used to receive paper check.

responseData.Transaction.Vendor.payeeName2

string | null

Alternative name used to receive paper check.

responseData.Transaction.Vendor.customerVendorAccount

string | null

Account number of paypoint in the vendor system.

Example:

"123-456"

responseData.Transaction.Vendor.internalReferenceId

integer | null

Internal identifier for global vendor account.

responseData.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"
}

responseData.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"

responseData.Transaction.Comments

string | null

Any comment or description for payout transaction.

Maximum length: 250

Example:

"Deposit for materials"

responseData.Transaction.parentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

responseData.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"

responseData.Transaction.paypointLegalname

string | null

Paypoint legal name.

Example:

"Sunshine Services, LLC"

responseData.Transaction.TotalAmount

number

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

Example:

110.25

responseData.Transaction.NetAmount

number | null

Net amount.

Example:

100

responseData.Transaction.FeeAmount

number

Service fee or sub-charge applied.

Example:

10.25

responseData.Transaction.Source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Example:

"api"

responseData.Transaction.PaymentId

string | null

Unique transaction ID.

Example:

"2345667-ddd-fff"

responseData.Transaction.PaymentGroup

string | null

Unique identifier for group or batch containing the transaction.

Example:

"2345667-ddd-fff"

responseData.Transaction.Status

integer

Internal status of transaction.

Example:

1

responseData.Transaction.Gateway

string | null

Gateway used to process the transaction.

Example:

"TSYS"

responseData.Transaction.StatusText

string | null

Status of payout transaction.

Example:

"Captured"

responseData.Transaction.PaymentStatus

string | null

Status of payout transaction.

Example:

"Processed"

responseData.Transaction.CheckNumber

string | null

Paper check number related to payout transaction.

Example:

"12345"

responseData.Transaction.CheckData

object | null

Object referencing to paper check image.

responseData.Transaction.PaymentMethod

string | null

Method of payment applied to the transaction.

Example:

"ach"

responseData.Transaction.PaymentData

object

responseData.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"

responseData.Transaction.PaymentData.AccountType

string | null

Bank account type or card brand.

Example:

"visa"

responseData.Transaction.PaymentData.AccountExp

string | null

Expiration date of card used in transaction.

Example:

"11/29"

responseData.Transaction.PaymentData.AccountZip

string | null

ZIP code for card used in transaction.

Example:

"90210"

responseData.Transaction.PaymentData.HolderName

string | null

Account holder name for the method.

Example:

"Chad Mercia"

responseData.Transaction.PaymentData.orderDescription

string | null

Text description of the transaction.

Maximum length: 250

Example:

"Depost for materials for 123 Walnut St"

responseData.Transaction.PaymentData.StoredId

string | null

Identifier of stored payment method used in transaction.

Example:

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

responseData.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"

responseData.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"

responseData.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"

responseData.Transaction.PaymentData.accountId

string | null

Custom identifier for payment connector.

Maximum length: 250

responseData.Transaction.PaymentData.SignatureData

string | null

Example:

null

responseData.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.

responseData.Transaction.PaymentData.paymentDetails

object

Details about the payment.

responseData.Transaction.Bills

object[] | null

Events associated to this transaction.

responseData.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"

responseData.Transaction.Bills.netAmount

string | null

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

Example:

3762.87

responseData.Transaction.Bills.invoiceDate

string | null

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

Example:

"2024-07-01"

responseData.Transaction.Bills.dueDate

string | null

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

Example:

"2024-07-01"

responseData.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"

responseData.Transaction.Bills.AccountingField1

string | null

Optional custom field.

Example:

"MyInternalId"

responseData.Transaction.Bills.AccountingField2

string | null

Optional custom field.

Example:

"MyInternalId"

responseData.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"
}

responseData.Transaction.Bills.Terms

string | null

Description of payment terms.

Example:

"NET30"

responseData.Transaction.Bills.billId

integer | null

Bill ID in Payabli.

responseData.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.

responseData.Transaction.Events

object[] | null

Events associated to this transaction.

responseData.Transaction.CreatedDate

string

Timestamp when the payment was created, in UTC.

Example:

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

responseData.Transaction.LastUpdated

string | null

Timestamp when payment record was updated, in UTC.

Example:

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

Was this page helpful?

Add Bill

Update Bill

curl --request GET \
  --url https://api-sandbox.payabli.com/api/Bill/{idBill} \
  --header 'requestToken: <api-key>'

{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": {
    "billNumber": "ABC-123",
    "netAmount": 3762.87,
    "billDate": "2024-07-01",
    "dueDate": "2024-07-01",
    "comments": "Deposit for materials",
    "billItems": [
      {
        "itemProductCode": "M-DEPOSIT",
        "itemProductName": "Materials deposit",
        "itemDescription": "Deposit for materials.",
        "itemCommodityCode": "010",
        "itemUnitOfMeasure": "SqFt",
        "itemCost": 5,
        "itemQty": 1,
        "itemMode": 0,
        "itemCategories": [
          null
        ],
        "itemTotalAmount": 123,
        "itemTaxAmount": 7,
        "itemTaxRate": 0.075
      }
    ],
    "mode": 0,
    "accountingField1": "MyInternalId",
    "accountingField2": "MyInternalId",
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "vendor": {
      "vendorNumber": "1234",
      "name1": "Herman's Coatings and Masonry",
      "name2": null,
      "ein": "XXXX6789",
      "phone": "5555555555",
      "email": "contact@hermanscoatings.com",
      "address1": "123 Ocean Drive",
      "address2": "Suite 400",
      "city": "Miami",
      "state": "FL",
      "zip": "33139",
      "country": "US",
      "mcc": "7777",
      "locationCode": "MIA123",
      "contacts": [
        {
          "contactName": "Herman Martinez",
          "contactEmail": "herman@hermanscoatings.com",
          "contactTitle": "Owner",
          "contactPhone": "3055550000"
        }
      ],
      "billingData": {
        "id": 123,
        "bankName": "Country Bank",
        "routingAccount": "123123123",
        "accountNumber": "1XXXXXX3123",
        "typeAccount": "Checking",
        "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
        "bankAccountHolderType": "Business",
        "bankAccountFunction": 0
      },
      "paymentMethod": "vcard",
      "vendorStatus": 1,
      "remitAddress1": "123 Walnut Street",
      "remitAddress2": "Suite 900",
      "remitCity": "Miami",
      "remitState": "FL",
      "remitZip": "31113",
      "remitCountry": "US",
      "payeeName1": null,
      "payeeName2": null,
      "customerVendorAccount": "A-37622",
      "internalReferenceId": 123,
      "vendorId": "1340",
      "AdditionalData": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      }
    },
    "endDate": "2024-07-01",
    "frequency": "monthly",
    "terms": "NET30",
    "status": -99,
    "Transaction": {
      "IdOut": 236,
      "Vendor": {
        "vendorNumber": "1234",
        "name1": "Herman's Coatings",
        "name2": "Herman's Coating Supply Company, LLC",
        "ein": "123456789",
        "phone": "212-555-1234",
        "email": "example@example.com",
        "address1": "123 Ocean Drive",
        "address2": "Suite 400",
        "city": "Bristol",
        "state": "GA",
        "zip": "31113",
        "country": "US",
        "mcc": "7777",
        "locationCode": "LOC123",
        "contacts": [
          {
            "contactName": "Herman Martinez",
            "contactEmail": "herman@hermanscoatings.com",
            "contactTitle": "Owner",
            "contactPhone": "3055550000"
          }
        ],
        "billingData": {
          "id": 123,
          "bankName": "Country Bank",
          "routingAccount": "123123123",
          "accountNumber": "1XXXXXX3123",
          "typeAccount": "Checking",
          "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
          "bankAccountHolderType": "Business",
          "bankAccountFunction": 0
        },
        "paymentMethod": {
          "method": "managed"
        },
        "vendorStatus": 1,
        "vendorId": "1340",
        "enrollmentStatus": null,
        "summary": {
          "pendingBills": 123,
          "inTransitBills": 123,
          "paidBills": 123,
          "overdueBills": 123,
          "totalBills": 123,
          "pendingBillsAmount": 123,
          "inTransitBillsAmount": 123,
          "paidBillsAmount": 123,
          "overdueBillsAmount": 123,
          "totalBillsAmount": 123
        },
        "paypointLegalname": "Sunshine Services, LLC",
        "paypointDbaname": "Sunshine Gutters",
        "paypointEntryname": "d193cf9a46",
        "parentOrgName": "PropertyManager Pro",
        "createdDate": "2022-07-01 15:00:01",
        "lastUpdated": "2022-07-01 15:00:01",
        "remitAddress1": "123 Walnut Street",
        "remitAddress2": "Suite 900",
        "remitCity": "Miami",
        "remitState": "FL",
        "remitZip": "31113",
        "remitCountry": "US",
        "payeeName1": null,
        "payeeName2": null,
        "customerVendorAccount": "123-456",
        "internalReferenceId": 123,
        "additionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
        "externalPaypointId": "Paypoint-100"
      },
      "Comments": "Deposit for materials",
      "parentOrgName": "PropertyManager Pro",
      "paypointDbaname": "Sunshine Gutters",
      "paypointLegalname": "Sunshine Services, LLC",
      "TotalAmount": 110.25,
      "NetAmount": 100,
      "FeeAmount": 10.25,
      "Source": "api",
      "PaymentId": "2345667-ddd-fff",
      "PaymentGroup": "2345667-ddd-fff",
      "Status": 1,
      "PaymentStatus": "Processed",
      "CheckNumber": "12345",
      "CheckData": {
        "ftype": "pdf",
        "filename": "my-doc.pdf",
        "furl": "https://mysite.com/my-doc.pdf",
        "fContent": "TXkgdGVzdCBmaWxlHJ==..."
      },
      "PaymentMethod": "ach",
      "PaymentData": {
        "MaskedAccount": "4XXXXXXXX1111",
        "AccountType": "visa",
        "AccountExp": "11/29",
        "AccountZip": "90210",
        "HolderName": "Chad Mercia",
        "orderDescription": "Depost for materials for 123 Walnut St",
        "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
        "Initiator": "payor",
        "StoredMethodUsageType": "subscription",
        "Sequence": "subsequent",
        "accountId": null,
        "SignatureData": null,
        "binData": {
          "binMatchedLength": 6,
          "binCardBrand": "Visa",
          "binCardType": "Credit",
          "binCardCategory": "PLATINUM",
          "binCardIssuer": "Bank of Example",
          "binCardIssuerCountry": "United States",
          "binCardIssuerCountryCodeA2": "US",
          "binCardIssuerCountryNumber": 840
        },
        "paymentDetails": {
          "totalAmount": 100,
          "serviceFee": 0,
          "currency": "USD",
          "checkNumber": "107",
          "checkImage": {},
          "categories": [
            {
              "label": "Deposit",
              "description": "Deposit for materials",
              "amount": 1000,
              "qty": 123
            }
          ],
          "splitFunding": [
            {
              "recipientEntryPoint": "41035afaa7",
              "accountId": "187-782",
              "description": "Split for annual dues",
              "amount": 456.23
            }
          ]
        }
      },
      "Bills": [
        {
          "invoiceNumber": "INV-2345",
          "netAmount": 3762.87,
          "invoiceDate": "2024-07-01",
          "dueDate": "2024-07-01",
          "comments": "Deposit for materials",
          "AccountingField1": "MyInternalId",
          "AccountingField2": "MyInternalId",
          "AdditionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          },
          "Terms": "NET30",
          "billId": 123,
          "attachments": [
            {
              "ftype": "pdf",
              "filename": "my-doc.pdf",
              "furl": "https://mysite.com/my-doc.pdf",
              "fContent": "TXkgdGVzdCBmaWxlHJ==..."
            }
          ]
        }
      ],
      "Events": [
        {
          "TransEvent": "Approved",
          "EventData": {},
          "EventTime": "2023-11-07T05:31:56Z"
        }
      ],
      "CreatedDate": "2022-07-01 15:00:01",
      "LastUpdated": "2022-07-01 15:00:01"
    }
  }
}