APIPay In endpointsInvoices

Get invoice

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<=250 characters
Custom number identifying the bill or invoice. Must be unique in paypoint.
createdAtdatetime
Timestamp of when record was created, in UTC.
invoiceStatusinteger
Status for invoice. The accepted status values are: - 0 draft - 1 active - 2 partially paid - 4 paid/complete - 99 cancelled
invoiceTypeinteger

Type of invoice. Only 0 for one-time invoices is currently supported.

frequencyenum
Frequency for operation.
paymentTermsstring
Payment terms for invoice. If no terms are defined, then response data for this field defaults to `NET30`. **Available Values:** - `PIA`: Payment in advance - `CIA`: Cash in advance - `UR`: Upon receipt - `NET10`: 10 days after invoice date - `NET20`: 20 days after invoice date - `NET30`: 30 days after invoice date - `NET45`: 45 days after invoice date - `NET60`: 60 days after invoice date - `NET90`: 90 days after invoice date - `EOM`: Due end of this month - `MFI`: 1st of the month following the invoice date - `5MFI`: 5th of the month following the invoice date - `10MFI`: 10th of the month following the invoice date - `15MFI`: 15th of the month following the invoice date - `20MFI`: 20th of the month following the invoice date - `2/10NET30`: 2% discount if paid within 10 days, otherwise net 30 days - `UF`: Until further notice - `10UF`: 10 days until further notice - `20UF`: 20 days until further notice - `25UF`: 25 days until further notice - `50UF`: 50 days until further notice
termsConditionsstring or null
Custom terms and conditions included in the invoice.
notesstring or null
invoiceAmountdouble
Invoice total 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
invoiceDatedate or null

Date in YYYY-MM-DD format.

invoiceDueDatedate or null

Date in YYYY-MM-DD format.

invoiceSentDatedatetime or null
Timestamp for operation, in UTC.
invoiceEndDatedate or null

Date in YYYY-MM-DD format.

lastPaymentDatedatetime or null
Timestamp for operation, in UTC.
taxdouble or null
Tax rate in percent applied to the invoice.
discountdouble or null
Discount applied to the invoice.
freightAmountdouble or null

Freight/shipping amount.

dutyAmountdouble or null
Duty amount.
firstNamestring or null
First name of the recipient of the invoice.
lastNamestring or null
Last name of the recipient of the invoice.
companystring or null
Company name of the recipient of the invoice.
billEventslist of objects or null
Array of event objects with information related to events associated to the invoice.
AdditionalDatastring or 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: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
externalPaypointIDstring or 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.

Errors