GET
/
Invoice
/
{idInvoice}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Invoice/{idInvoice} \
  --header 'requestToken: <api-key>'
{
  "invoiceId": 236,
  "customerId": 4440,
  "paypointId": 56,
  "invoiceNumber": "INV-2345",
  "invoiceDate": "10/25/2023",
  "invoiceDueDate": "2024-07-01",
  "invoiceType": 0,
  "invoiceEndDate": "2024-07-01",
  "invoiceStatus": 1,
  "invoiceSentDate": "2025-10-19T00:00:00",
  "lastPaymentDate": "2025-10-19T00:00:00",
  "createdAt": "2022-07-01 15:00:01",
  "frequency": "<string>",
  "paymentTerms": "NET30",
  "termsConditions": "<string>",
  "notes": "<string>",
  "tax": 2.05,
  "discount": 10,
  "invoiceAmount": 105,
  "freightAmount": 10,
  "dutyAmount": 0,
  "purchaseOrder": "PO-345",
  "invoicePaidAmount": 0,
  "firstName": "<string>",
  "lastName": "<string>",
  "company": "<string>",
  "shippingAddress1": "123 Walnut St",
  "shippingAddress2": "STE 900",
  "shippingCity": "Johnson City",
  "shippingState": "TN",
  "shippingZip": "37619",
  "shippingCountry": "US",
  "shippingEmail": "example@email.com",
  "shippingPhone": "<string>",
  "shippingFromZip": "30040",
  "summaryCommodityCode": "501718",
  "items": [
    {
      "itemProductCode": "M-DEPOSIT",
      "itemProductName": "Materials deposit",
      "itemDescription": "Deposit for materials.",
      "itemCommodityCode": "010",
      "itemUnitOfMeasure": "SqFt",
      "itemCost": 5,
      "itemQty": 1,
      "itemMode": 0,
      "itemCategories": [
        "<string>"
      ],
      "itemTotalAmount": 123,
      "itemTaxAmount": 7,
      "itemTaxRate": 0.075
    }
  ],
  "customer": {
    "CustomerId": 4440,
    "FirstName": "John",
    "LastName": "Doe",
    "CompanyName": "Sunshine LLC",
    "CustomerNumber": "3456-7645A",
    "BillingAddress1": "1111 West 1st Street",
    "BillingAddress2": "Suite 200",
    "BillingCity": "Miami",
    "BillingState": "FL",
    "BillingZip": "45567",
    "BillingCountry": "US",
    "BillingPhone": "5555555555",
    "BillingEmail": "example@email.com",
    "ShippingAddress1": "123 Walnut St",
    "ShippingAddress2": "STE 900",
    "ShippingCity": "Johnson City",
    "ShippingState": "TN",
    "ShippingZip": "37619",
    "ShippingCountry": "US",
    "AdditionalData": {
      "key1": "value1",
      "key2": "value2",
      "key3": "value3"
    },
    "CreatedAt": "2022-07-01 15:00:01",
    "customerId": 4440,
    "customerStatus": 1,
    "Identifiers": [
      "\\\"firstname\\\"",
      "\\\"lastname\\\"",
      "\\\"email\\\"",
      "\\\"customId\\\""
    ]
  },
  "paylinkId": "<string>",
  "billEvents": [
    {
      "description": "TransferCreated",
      "eventTime": "2023-07-05T22:31:06.8317486+00:00",
      "refData": "<string>",
      "extraData": {},
      "source": "api"
    }
  ],
  "scheduledOptions": {
    "includePaylink": true,
    "includePdf": true
  },
  "paypointLegalname": "<string>",
  "paypointDbaname": "<string>",
  "paypointEntryname": "<string>",
  "parentOrgName": "<string>",
  "AdditionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  },
  "documentsRef": {
    "zipfile": "zx45.zip",
    "filelist": [
      {
        "originalName": "<string>",
        "zipName": "<string>"
      }
    ]
  }
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
idInvoice
integer
required

Invoice ID

Example:

23548884

Response

200
application/json
Success
​
invoiceId
integer

Identifier of invoice.

Example:

236

​
customerId
integer | null

Identifier of customer associated to the invoice

Example:

4440

​
paypointId
integer

Internal identifier of paypoint associated to the invoice.

Example:

56

​
invoiceNumber
string | null

Custom number identifying the bill or invoice. Must be unique in paypoint.

Maximum length: 250
Example:

"INV-2345"

​
invoiceDate
string | null

Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY

Example:

"10/25/2023"

​
invoiceDueDate
string | null

Invoice due date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY

Example:

"2024-07-01"

​
invoiceType
integer | null

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

Example:

0

​
invoiceEndDate
string | null

The end date for a scheduled invoice cycle (invoiceType = 1).

Example:

"2024-07-01"

​
invoiceStatus
enum<integer> | null

Status for invoice.

The accepted status values are:

  • 0 draft
  • 1 active
  • 2 partially paid
  • 4 paid/complete
  • 99 cancelled
Available options:
0,
1,
2,
4,
99
Example:

1

​
invoiceSentDate
string | null

Timestamp of when invoice was sent, in UTC.

Example:

"2025-10-19T00:00:00"

​
lastPaymentDate
string | null

Timestamp of last payment, in UTC.

Example:

"2025-10-19T00:00:00"

​
createdAt
string

Timestamp of when invoice was created, in UTC.

Example:

"2022-07-01 15:00:01"

​
frequency
string | null

Frequency of scheduled invoice.

​
paymentTerms
string | null

The payment terms for the invoice. If no terms were defined initially, then reponse data for this field will default to N30.

Example:

"NET30"

​
termsConditions
string | null

Custom terms and conditions included in the invoice.

​
notes
string | null

Notes included in the invoice.

​
tax
number | null

Tax rate in percent applied to the invoice.

Example:

2.05

​
discount
number | null

Discount applied to the invoice.

Example:

10

​
invoiceAmount
number | null

Invoice total amount.

Example:

105

​
freightAmount
number | null

Freight/shipping amount.

Example:

10

​
dutyAmount
number | null

Duty amount.

Example:

0

​
purchaseOrder
string | null

Purchase order number.

Example:

"PO-345"

​
invoicePaidAmount
number | null

Amount partially paid to the invoice.

Example:

0

​
firstName
string | null

First name of the recipient of the invoice

​
lastName
string | null

Last name of the recipient of the invoice

​
company
string | null

Company name of the recipient of the invoice

​
shippingAddress1
string | null

The shipping address.

Maximum length: 250
Example:

"123 Walnut St"

​
shippingAddress2
string | null

Additional line for shipping address.

Maximum length: 100
Example:

"STE 900"

​
shippingCity
string | null

Shipping city.

Maximum length: 250
Example:

"Johnson City"

​
shippingState
string | null

Shipping state or province.

Example:

"TN"

​
shippingZip
string | null

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

Maximum length: 50
Example:

"37619"

​
shippingCountry
string | null

Shipping address country.

Example:

"US"

​
shippingEmail
string | null

Shipping recipient's contact email address.

Maximum length: 320
Example:

"example@email.com"

​
shippingPhone
string | null

Recipient phone number

​
shippingFromZip
string | null

Sender shipping ZIP code.

Example:

"30040"

​
summaryCommodityCode
string | null

Commodity code.

Example:

"501718"

​
items
object[] | null

Array of line items included in the invoice

​
customer
object

Customer object associated to the invoice

​
paylinkId
string | null

Identifier of paymentlink associated to the invoice.

​
billEvents
object[] | null

Array of event objects with information related to events associated to the invoice.

​
scheduledOptions
object

Options to be applied for scheduled invoices

​
paypointLegalname
string | null

Paypoint legal name

​
paypointDbaname
string | null

Paypoint DBA name

​
paypointEntryname
string | null

Paypoint entry name

​
parentOrgName
string | null

Name of paypoint's parent organization

​
AdditionalData
string | 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:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}
​
documentsRef
object

Object containing attachments associated to the invoice.

Was this page helpful?