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
Retrieves a bill by ID from an entrypoint.
Authorizations
Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.
Path Parameters
Payabli ID for the bill. Get this ID by querying /api/Query/bills/ for the entrypoint or the organization.
Response
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
If isSuccess = true, this contains the Bill identifier. If isSuccess = false, this contains the reason for the error.
Optional custom field.
Optional custom field.
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"
}
}
Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY
Array of LineItems contained in bill.
Item or product price per unit.
Item or product name. Max length of 250 characters.
250Quantity of item or product.
Array of tags classifying item or product.
Item or product commodity code. Max length of 250 characters.
250Item or product description. Max length of 250 characters.
250Internal class of item or product: value '0' is only for invoices , '1' for bills and, '2' common for both.
0, 1, 2 Item or product code. Max length of 250 characters.
250Tax amount applied to item or product.
Tax rate applied to item or product.
Total amount in item or product.
Unit of measurement. Max length of 100 characters.
100Unique identifier for the bill. Required for new bill.
Any comment or description.
250Object with the attached documents.
Due Date of bill. Accepted formats: YYYY-MM-DD, MM/DD/YYYY
End date for scheduled bills. Applied only in Mode = 1.
Frequency for scheduled bills. Applied only in Mode = 1.
one-time, weekly, every2weeks, every6months, monthly, every3months, annually Bill mode: value 0 for single/one-time bills, 1 for scheduled bills.
0, 1 Net amount owed in bill.
The bill's status. Values are:
-99: deleted or canceled1: Active2: Sent to approval5: Partially approved11: Rejected20: Approved50: Payment in transit100: Paid "
-99, 1, 2, 5, 11, 20, 50, 100 Description of payment terms.
MoneyOut transaction associated to the bill
Events associated to this transaction.
Optional custom field.
Optional custom field.
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"
}
}
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.
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
The name of the attached file.
The MIME type of the file (if content is provided)
pdf, doc, docx, jpg, jpeg, png, gif, txt Optional url provided to show or download the file remotely
Bill ID in Payabli.
Any comments about bill. For managed payouts, this field has a limit of 100 characters.
250Bill due date in format YYYY-MM-DD or MM/DD/YYYY.
Bill date in format YYYY-MM-DD or MM/DD/YYYY.
Custom number identifying the bill. Must be unique in paypoint. Required for new bill and when billId is not provided.
250Net Amount owed in bill. Required when adding a bill.
Description of payment terms.
Object referencing to paper check image.
Content of file, Base64-encoded Ignored if furl is specified. Max upload size is 30 MB.
The name of the attached file.
The MIME type of the file (if content is provided)
pdf, doc, docx, jpg, jpeg, png, gif, txt Optional url provided to show or download the file remotely
Paper check number related to payout transaction.
Any comment or description for payout transaction.
250Timestamp when the payment was created, in UTC.
Events associated to this transaction.
Any data associated to the event received from processor. Contents vary by event type.
Date and time of event.
Event descriptor. See TransEvent Reference for more details.
Service fee or sub-charge applied.
Gateway used to process the transaction.
Identifier of payout transaction.
Timestamp when payment record was updated, in UTC.
Net amount.
The name of the parent organization.
Expiration date of card used in transaction.
Custom identifier for payment connector.
250Bank account type or card brand.
ZIP code for card used in transaction.
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.
The card brand. For example, Visa, MasterCard, American Express, Discover.
The category of the card, which indicates the card product. For example: Standard, Gold, Platinum, etc. The binCardCategory for prepaid cards is marked PREPAID.
The name of the financial institution that issued the card.
The issuing financial institution's country name.
The issuing financial institution's two-character ISO country code. See this resource for a list of codes.
The issuing financial institution's ISO standard numeric country code. See this resource for a list of codes.
The type of card: Credit or Debit.
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.
Account holder name for the method.
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 transactionsmerchant: For merchant-initiated transactions
See Understanding CIT and MIT Indicators for more information.
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
Text description of the transaction.
250Details about the payment.
Total amount to be charged. If a service fee is sent, then this amount should include the service fee."
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.
Object containing image of paper check.
A check number to be used in the ach transaction. Required for payment method = 'check'.
Currency code ISO-4217. If not code is provided the currency in the paypoint setting is taken. Default is USD.
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.
Split funding instructions for the transaction. See Split a Transaction for more.
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.
Identifier of stored payment method used in transaction.
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.
Unique identifier for group or batch containing the transaction.
Unique transaction ID.
Method of payment applied to the transaction.
Status of payout transaction.
The alternate or common name that this business is doing business under usually referred to as a DBA name.
Paypoint legal name.
Custom identifier to indicate the transaction or request source.
100Internal status of transaction.
Status of payout transaction.
Transaction total amount (including service fee or sub-charge).
Vendor related to the payout transaction.
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"
}
}
Vendor's address.
Additional line for vendor's address.
Masked account number for bank account.
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0: Deposit1: Withdrawal2: Deposit and withdrawal
The accountholder's name.
Describes whether the bank is a personal or business account.
Personal, Business Name of bank for account.
The bank's ID in Payabli.
Routing number of bank account.
Type of bank account: Checking or Savings.
Checking, Savings Vendor's city.
List of contacts.
Contact email address.
Contact name.
Contact phone number.
Contact title.
Vendor's country.
Timestamp of when record was created, in UTC.
Account number of paypoint in the vendor system.
Business EIN or tax ID.
Vendor's email address.
Enrollment status of vendor in payables program.
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.
Internal identifier for global vendor account.
Timestamp of when record was last updated, in UTC.
Additional location code used to identify the vendor.
Business Merchant Category Code (MCC). This resource lists MCC codes.
Primary name for vendor.
Secondary name for vendor.
The name of the parent organization.
Alternative name used to receive paper check.
Alternative name used to receive paper check.
Object containing details about the payment method to use for the payout.
Payment method to use for payout. Leave empty for managed payables.
managed, vcard, ach, check The alternate or common name that this business is doing business under usually referred to as a DBA name.
The entrypoint identifier.
50Business legal name.
Vendor's phone number.
Remittance address. Used for mailing paper checks.
Remittance address additional line. Used for mailing paper checks.
Remittance address city. Used for mailing paper checks.
Remittance address country. Used for mailing paper checks.
Remittance address state. Used for mailing paper checks.
Remittance address ZIP code. Used for mailing paper checks.
Vendor's state.
Payabli identifier for vendor record.
Custom number identifying the vendor. Must be unique in paypoint.
Vendor's status. Allowed status:
-
0 Inactive
-
1 Active
Vendor's zip code.
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"
}
}
Vendor's address.
Additional line for vendor's address.
Object containing vendor's bank information.
Masked account number for bank account.
Describes whether the bank account is used for deposits or withdrawals in Payabli:
0: Deposit1: Withdrawal2: Deposit and withdrawal
The accountholder's name.
Describes whether the bank is a personal or business account.
Personal, Business Name of bank for account.
The bank's ID in Payabli.
Routing number of bank account.
Type of bank account: Checking or Savings.
Checking, Savings Vendor's city.
List of contacts.
Vendor's country. Payabli supports only US and Canadian vendors.
Account number of paypoint in the Vendor side.
EIN/Tax ID for vendor. In some GET responses, this field is masked, and looks like: "ein": "XXXXX6789".
Vendor's email address.
Internal identifier for global vendor account.
Additional location code used to identify the vendor.
Business Merchant Category Code (MCC). This resource lists MCC codes.
Primary name for vendor.
Secondary name for vendor.
Alternative name used to receive paper check.
Alternative name used to receive paper check.
Preferred payment method for vendor.
vcard, ach, check, card Vendor's phone number.
Remittance address. Used for mailing paper checks.
Remittance address additional line. Used for mailing paper checks.
Remittance address city. Used for mailing paper checks.
Remittance address country. Used for mailing paper checks.
Remittance address state. Used for mailing paper checks.
Remittance address ZIP code. Used for mailing paper checks.
Vendor's state. Must be a two-character state code.
Payabli identifier for vendor record.
Custom number identifying the vendor. Must be unique in paypoint.
Vendor's status. Allowed status:
-
0 Inactive
-
1 Active
Vendor's zip code.
Response text for operation: 'Success' or 'Declined'.
Was this page helpful?