API referencePay In endpointsInvoices

Get invoice

Retrieves a single invoice by ID.

Path parameters

idInvoiceintegerRequired
Invoice ID

Headers

requestTokenstringRequired

Response

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

invoiceIdlong
Identifier of invoice.
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.
termsConditionsstring
invoicePaidAmountdouble
Amount partially paid to the invoice.
purchaseOrderstring
Purchase order number.
shippingCitystring<=250 characters
Shipping city.
shippingStatestring
Shipping state or province.
shippingFromZipstring
Sender shipping ZIP code.
shippingCountrystring
Shipping address country.
shippingPhonestring
itemslist of objects
Customerobject
Customer information.
scheduledOptionsobject
PaypointLegalnamestring
PaypointEntrynamestring<=50 characters
The entrypoint identifier.
ParentOrgNamestring
The name of the parent organization.
DocumentsRefobject
customerIdlong or null

The Payabli-generated unique ID for the customer.

paypointIdlong or null
The paypoint's ID. Note that this is different than the entryname.
invoiceNumberstring or null<=250 characters
Custom number identifying the bill or invoice. Must be unique in paypoint.
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.
paymentTermsstring or null
Description of payment terms.
notesstring or null
taxdouble or null
Tax rate in percent applied to the invoice.
discountdouble or null
Discount applied to the invoice.
invoiceAmountdouble or null
Invoice total amount.
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.
shippingAddress1string or null<=250 characters
The shipping address.
shippingAddress2string or null<=100 characters
Additional line for shipping address.
shippingZipstring or null<=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”.

shippingEmailstring or nullformat: "email"<=320 characters
Email address.
summaryCommodityCodestring or null
Commodity code.
paylinkIdstring or null
Identifier of paymentlink associated to the invoice.
billEventslist of objects or null
Array of event objects with information related to events associated to the invoice.
PaypointDbanamestring or null
The alternate or common name that this business is doing business under usually referred to as a DBA name.
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:

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
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