Payabli Bill API
The Bill API from Payabli — 7 operation(s) for bill.
Payabli Bill API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Bill. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 11 operations across 7 paths, and defines 145 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.
11 operations
7 paths
145 schemas
2 DELETE5 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Payabli Bill API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (BearerAuth).
An API key is passed in the header as requestToken (APIKeyAuth).
BearerAuth— OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).APIKeyAuth— Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).
Paths & Operations 11
Across 7 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Bill 11
POST
/Bill/single/{entry}
Add bill
GET
/Bill/{idBill}
Get bill
PUT
/Bill/{idBill}
Update bill
DELETE
/Bill/{idBill}
Delete bill
GET
/Query/bills/{entry}
Get list of bills for entrypoint
GET
/Query/bills/org/{orgId}
Get list of bills for organization
DELETE
/Bill/attachedFileFromBill/{idBill}/{filename}
Delete attached file from bill
GET
/Bill/attachedFileFromBill/{idBill}/{filename}
Get attached file from bill
POST
/Bill/approval/{idBill}
Send a bill to approval
PUT
/Bill/approval/{idBill}
Change bill approvers
GET
/Bill/approval/{idBill}/{approved}
Approve or disapprove a bill
Schemas 145
The contract defines 145 schemas that model the data the API accepts and returns. The most detailed are VendorQueryRecord (53 properties), VendorDataResponse (44 properties), TransactionOutQueryRecord (39 properties), BillQueryRecord2 (37 properties). Each schema is shown below with its type and property counts.
RiskReason
string
Reason for risk flagging.
IsSameDayACH
boolean
When true, this is a same-day ACH transaction.
ContactsField
array
List of contacts.
AccountId
string
Custom identifier for payment connector.
BillQueryRecord2BillApprovalsItem
object
5 properties
1 required
SettlementStatusPayout
string
The settlement status of the payout transaction. See [Payout Transaction Statuses](/guides/pay-out-status-referencepayout-transaction-statuses) for a full refe…
Maskedaccount
string
Masked card or bank account used in transaction. In the case of Apple Pay, this is a masked DPAN (device primary account number).
BankName
string
Name of bank for account.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
RiskFlaggedOn
string
Timestamp when the transaction was flagged for risk.
VendorOutData
object
30 properties
7 required
Email
string
Email address.
Accountexp
string
Expiration date of card used in transaction.
BillOutDataVendor
object
The vendor associated with the bill. Although you can create a vendor in a create bill request, Payabli recommends creating a vendor separately and passing a v…
1 property
CityNullable
string
The city.
VendorDataResponsePaymentMethod
string
Preferred payment method for vendor.
SetApprovedBillResponse
object
Response from the Approve or disapprove a bill endpoint.
3 properties
1 required
RoomIdNotInUse
integer
Field not in use on this endpoint. It always returns 0.
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
RemitEmail
string
Remittance email address. Used for sending virtual cards and other information about payouts.
PayeeName
string
Alternative name used to receive paper check.
Entrypointfield
string
The entrypoint identifier.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
IdempotencyKey
string
Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. Th…
Pagesize
integer
Number of records on each response page.
Vendorid
integer
Payabli identifier for vendor record.
RiskStatus
string
Current risk status of the transaction.
BillQueryResponseSummary
object
23 properties
Billitems
array
Array of LineItems contained in bill.
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
ItemDescription
string
Item or product description. Max length of 250 characters.
CreatedAt
string
Timestamp of when record was created, in UTC.
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…
11 properties
Holdername
string
The cardholder name.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
BillPayOutData
object
15 properties
2 required
BillQueryRecord2
object
37 properties
37 required
Initiator
string
The transaction's initiator. Indicates who initiated the transaction.
BillOutData
object
Bill payload sent when creating or updating a bill.
20 properties
Remitcountry
string
Remittance address country. Used for mailing paper checks. Must be US or CA. Defaults to US if not provided.
FeeAmount
number
Service fee or sub-charge applied.
EnrollmentStatus
string
Enrollment status of vendor in payables program.
InternalReferenceId
integer
An internal reference ID.
VendorDataResponse
object
44 properties
41 required
BillItem
object
12 properties
ItemProductCode
string
Item or product code. Max length of 250 characters.
PaymentIdString
string
The unique transaction ID. This value is a string representation of a long integer.
Comments
string
Any comment or description.
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties
2 required
BillEvents
array
Array of event objects with information related to events associated to the invoice.
ScheduleId
integer
ID of the recurring payment schedule associated with the transaction.
Vendorstatus
integer
Vendor's status. Allowed values: - 0 Inactive - 1 Active - -99 Deleted
BankAccountHolderType
string
Describes whether the bank is a personal or business account.
VendorPaymentMethod
object
Payment method object to use for the payout. - { method: "managed" } - Managed payment method - { method: "vcard" } - Virtual card payment method - { method: "…
2 properties
1 required
LocationCode
string
A location code used to identify the vendor's location.
AdditionalDataString
string
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"…
RoutingAccount
string
Routing number of bank account.
Totalrecords
integer
Total number of records in response.
RiskActionCode
integer
Numeric code representing the risk action.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
GeneralEvents
object
5 properties
Ein
string
Business EIN or tax ID. This value is masked in API responses.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
BillingDataResponse
object
14 properties
13 required
PaylinkId
string
Identifier of payment link associated to the invoice or bill.
VendorQueryRecord
object
53 properties
VendorNumber
string
Custom number identifying the vendor. Must be unique in paypoint. Can't be blank.
Remitzip
string
Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits o…
Signaturedata
string
Sequence
string
The order of the transaction for cardholder-initiated transaction (CIT) and merchant-initiated transaction (MIT) purposes. This field is automatically detected…
BankAccountHolderName
string
The accountholder's name.
StoredMethodUsageType
string
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 u…
ContactsResponse
object
4 properties
SplitFundingContent
object
4 properties
AdditionalDataMap
object
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](…
BillId
integer
The bill's ID in Payabli. This value is automatically generated by Payabli when the bill is created.
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. If you are using [custom identifiers](…
BillingData
object
8 properties
Remitaddress2
string
Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional.
Storedmethodid
string
Payabli identifier of a tokenized payment method. If this field is used in a request, the method field is overridden and the payment is made using the payment…
Accounttype
string
Bank account type or card brand.
ModifyApprovalBillResponse
object
Response from approval-modification endpoints.
3 properties
1 required
AccountingField
string
Optional custom field.
GetBillResponse
object
A successful response returns a bill object with all its details. If the bill isn't found, the response will contain an error message.
6 properties
1 required
FileContentFtype
string
The MIME type of the file (if content is provided).
PayoutProgram
string
The payout program associated with the transaction. Values are Managed (managed payables) or ODP (on-demand payables).
EditBillResponse
object
Response wrapper for the Update bill endpoint.
6 properties
1 required
Frequency
string
Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren't accepted by other endpoints (s…
Mcc
string
Business Merchant Category Code (MCC). [This resource](https://github.com/greggles/mcc-codes/blob/main/mcccodes.csv) lists MCC codes.
Responsedatanonobject
The response data.
OrgParentId
integer
The ID of the org's parent organization.
QueryPaymentData
object
14 properties
VendorPaymentMethodString
string
The vendor's preferred payment method. Can be one of: - managed — Managed payment method - vcard — Virtual card payment method - check — Check payment method -…
LastModified
string
Timestamp of when record was last updated, in UTC.
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
Remitcity
string
Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
NetAmountstring
string
Net amount owed in bill. Required when adding a bill.
Remitaddress1
string
Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided.
HasVcardTransactions
boolean
When true, indicates that the paypoint has vCard transactions.
Gatewayfield
string
The payment gateway used to process the transaction.
DocumentsRef
object
2 properties
ItemCommodityCode
string
Item or product commodity code. Max length of 250 characters.
Orgid
integer
Organization ID. Unique identifier assigned to an org by Payabli.
ItemProductName
string
Item or product name. Max length of 250 characters.
Attachments
array
Array of fileContent objects with attached documents. Max upload size is 30 MB.
Accountzip
string
ZIP code for card used in transaction.
EntityId
integer
The entity's ID in Payabli. If the entity is a paypoint, this is the paypoint ID. If the entity is an organization, this is the organization ID.
Contacts
object
5 properties
Terms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.
OrgParentName
string
The name of the parent organization.
ExportFormat
string
Export format for file downloads. When specified, returns data as a file instead of JSON.
TransactionOutQueryRecord
object
39 properties
Netamountnullable
number
Net amount.
VendorResponseSummary
object
Vendor bill summary statistics
16 properties
StateNullable
string
The state or province.
VendorResponseBillingData
object
Object containing vendor's bank information
14 properties
AddressNullable
string
The address.
PaymentCategories
object
4 properties
2 required
BillOutDataScheduledOptions
object
Options for scheduled bills.
1 property
BillQueryResponse
object
2 properties
SplitFunding
array
Split funding instructions for the transaction. The total amount of the splits must match the total amount of the transaction.
Billstatus
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…
Remitstate
string
Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian…
VendorResponseStoredMethod
object
Stored payment method information
17 properties
17 required
QueryTransactionEventsEventData
Any data associated to the event received from processor. Contents vary by event type.
VendorSummary
object
16 properties
Source
string
Custom identifier to indicate the transaction or request source.
BillApprovals
array
Approvals associated with the bill.
Zip
string
ZIP code for address.
PairFiles
object
3 properties
RiskAction
string
Action taken due to risk assessment.
TypeAccount
string
Type of bank account: Checking or Savings.
BillResponse
object
Response wrapper for bill operations.
6 properties
1 required
Totalpages
integer
Total number of pages in response.
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
Orderdescription
string
Text description of the transaction.
RiskFlagged
boolean
Indicates if the transaction was flagged for risk.
BillResponseData
object
37 properties
3 required
PaymentDetail
object
Details about the payment.
8 properties
1 required
QueryTransactionEvents
object
3 properties
BillQueryRecord2PaymentMethod
string
Preferred payment method used.
AccountNumber
string
Account number for bank account. This value is returned masked in responses.
Legalname
string
Business legal name.
AddressAddtlNullable
string
Additional line for the address.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Payabli 12
Other APIs Payabli publishes across the network.
Payabli Boarding API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Payabli lineItem API
#Bill
Where this information came from
This is an independent, third-party profile of Payabli Bill API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.