APIPay In endpointsInvoices

Get invoice

View as MarkdownOpen in Claude
Retrieves a single invoice by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

idInvoiceintegerRequired
Invoice ID

Response

Success. Fields marked optional may return null if not set.

invoiceIdlong
Identifier of invoice.
customerIdlong

The Payabli-generated unique ID for the customer.

paypointIdlong
The paypoint's ID. Note that this is different than the entryname.
invoiceNumberstring
Invoice number. Identifies the invoice under a paypoint.
invoiceDatedate or null
invoiceDueDatedate or null
invoiceSentDatedatetime or null
invoiceEndDatedate or null
lastPaymentDatedatetime or null
createdAtdatetime
Timestamp of when record was created, in UTC.
invoiceStatusinteger
Invoice status code.
invoiceTypeinteger

Invoice type. Value 0 is for single/one-time invoices, 1 for scheduled invoices.

frequencyenum

Frequency for operation. The firstofmonth, fifteenthofmonth, and endofmonth values are only valid on subscriptions — they aren’t accepted by other endpoints (such as invoice scheduling) that use this enum.

paymentTermsenum

Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30.

termsConditionsstring or null
Custom terms and conditions included in the invoice.
notesstring or null
invoiceAmountdouble
The invoice amount.
invoicePaidAmountdouble
Amount partially paid to the invoice.
purchaseOrderstring
Purchase order number.
shippingAddress1string<=250 characters
The shipping address.
shippingAddress2string<=100 characters
Additional line for shipping address.
shippingCitystring<=250 characters
Shipping city.
shippingStatestring
Shipping state or province.
shippingZipstring<=50 characters

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

shippingFromZipstring
Sender shipping ZIP code.
shippingCountrystring
Shipping address country.
shippingEmailstringformat: "email"<=320 characters
Email address.
shippingPhonestring
summaryCommodityCodestring
Commodity code.
itemslist of objects
Customerobject
Customer information.
paylinkIdstring
Identifier of payment link associated to the invoice or bill.
scheduledOptionsobject
PaypointLegalnamestring
PaypointDbanamestring
The alternate or common name that this business is doing business under, usually referred to as a DBA name.
PaypointEntrynamestring<=50 characters
The entrypoint identifier.
ParentOrgNamestring
The name of the parent organization.
DocumentsRefobject
taxdouble
Tax rate in percent applied to the invoice.
discountdouble
Discount applied to the invoice.
freightAmountdouble

Freight/shipping amount.

dutyAmountdouble
Duty amount.
firstNamestring
First name of the recipient of the invoice.
lastNamestring
Last name of the recipient of the invoice.
companystring
Company name of the recipient of the invoice.
billEventslist of objects
Array of event objects with information related to events associated to the invoice.
AdditionalDatamap from strings to strings

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system.

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
externalPaypointIDstring
A custom identifier for the paypoint, if applicable.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error