Payabli Invoice API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Invoice. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
11 operations
across 8 paths,
and defines 86 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.
The identity and technical contract details declared by the specification.
File
object
A file containing the response data, in the format specified in the request.
QuerySummary
object
6 properties
Shippingaddress
string
The shipping address.
InvoiceId
integer
Identifier of invoice.
FreightAmount
number
Freight/shipping amount.
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
BillDataPaymentTerms
string
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30. Mirrors the values in [Terms](schema-terms).
Email
string
Email address.
BillingStateNullable
string
Billing state. Must be a 2-letter state code for addresses in the US.
BillingCountryNullable
string
Billing address country.
CustomerStatus
integer
Customer Status. Possible values: - -99 Deleted - 0 Inactive - 1 Active - 85 Locked (typically due to multiple failed login attempts)
RoomIdNotInUse
integer
Field not in use on this endpoint. It always returns 0.
SummaryCommodityCode
string
Commodity code.
ItemUnitofMeasure
string
Unit of measurement. Max length of 100 characters.
Entrypointfield
string
The entrypoint identifier.
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…
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
DutyAmount
number
Duty amount.
Pagesize
integer
Number of records on each response page.
Tax
number
Tax rate in percent applied to the invoice.
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
InvoiceDataRequest
object
3 properties
ItemDescription
string
Item or product description. Max length of 250 characters.
CreatedAt
string
Timestamp of when record was created, in UTC.
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
InvoicePaidAmount
number
Amount partially paid to the invoice.
Shippingstate
string
Shipping state or province.
CustomerId
integer
The Payabli-generated unique ID for the customer.
BillOptions
object
2 properties
BillingCityNullable
string
Billing city.
CustomerNumberNullable
string
User-provided unique identifier for the customer. This is typically the customer ID from your own system.
BillItem
object
12 properties
BillingAddressAddtlNullable
string
Additional line for the billing address.
ItemProductCode
string
Item or product code. Max length of 250 characters.
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.
BillData
object
32 properties
PaypointId
integer
The paypoint's ID. Note that this is different than the entryname.
Totalrecords
integer
Total number of records in response.
TermsConditions
string
Custom terms and conditions included in the invoice.
GeneralEvents
object
5 properties
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
BillingAddressNullable
string
Billing address.
Dbaname
string
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
PayorDataResponse
object
Customer information.
22 properties
22 required
Shippingcountry
string
Shipping address country.
PaylinkId
string
Identifier of payment link associated to the invoice or bill.
GetInvoiceRecord
object
48 properties
38 required
InvoiceNumberResponse
object
Response schema for operations for sending invoices or getting next invoice number.
3 properties
3 required
ForceCustomerCreation
boolean
When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false.
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](…
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](…
InvoiceResponseWithoutData
object
Response schema for invoice operations.
6 properties
6 required
Shippingcity
string
Shipping city.
FileContentFtype
string
The MIME type of the file (if content is provided).
QueryInvoiceResponseRecordsItem
object
50 properties
45 required
QueryInvoiceResponse
object
2 properties
2 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…
Responsedatanonobject
The response data.
InvoiceNumber
string
Invoice number. Identifies the invoice under a paypoint.
Shippingaddressadditional
string
Additional line for shipping address.
ShippingFromZip
string
Sender shipping ZIP code.
Invoicestatus
integer
Invoice status code.
ExternalPaypointId
string
A custom identifier for the paypoint, if applicable.
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.
SendInvoiceResponse
object
2 properties
2 required
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.
PayorDataRequest
object
Customer information. May be required, depending on the paypoint's settings. Required for subscriptions.
21 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.
BillingZip
string
Billing address ZIP code.
Shippingzip
string
Shipping ZIP code. For Pay In functions, this field supports 5-digit and 9-digit ZIP codes and alphanumeric Canadian postal codes. For example: 37615-1234 or 3…
PhoneNumber
string
Phone number.
InvoiceAmount
number
The invoice amount.
Source
string
Custom identifier to indicate the transaction or request source.
InvoiceType
integer
Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.
PairFiles
object
3 properties
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
PurchaseOrder
string
Purchase order number.
Identifierfields
array
List of fields acting as customer identifiers, to be used instead of CustomerNumber.
Legalname
string
Business legal name.
Discount
number
Discount applied to the invoice.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Payabli publishes across the network.
