Get Invoice
Retrieves a single invoice by ID.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
Invoice ID
23548884
Response
Identifier of invoice.
236
Identifier of customer associated to the invoice
4440
Internal identifier of paypoint associated to the invoice.
56
Custom number identifying the bill or invoice. Must be unique in paypoint.
250
"INV-2345"
Invoice date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY
"10/25/2023"
Invoice due date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY
"2024-07-01"
Type of invoice. Only 0
for one-time invoices is currently supported.
0
The end date for a scheduled invoice cycle (invoiceType
= 1).
"2024-07-01"
Status for invoice.
The accepted status values are:
- 0 draft
- 1 active
- 2 partially paid
- 4 paid/complete
- 99 cancelled
0
, 1
, 2
, 4
, 99
1
Timestamp of when invoice was sent, in UTC.
"2025-10-19T00:00:00"
Timestamp of last payment, in UTC.
"2025-10-19T00:00:00"
Timestamp of when invoice was created, in UTC.
"2022-07-01 15:00:01"
Frequency of scheduled invoice.
The payment terms for the invoice. If no terms were defined initially, then reponse data for this field will default to N30
.
"NET30"
Custom terms and conditions included in the invoice.
Notes included in the invoice.
Tax rate in percent applied to the invoice.
2.05
Discount applied to the invoice.
10
Invoice total amount.
105
Freight/shipping amount.
10
Duty amount.
0
Purchase order number.
"PO-345"
Amount partially paid to the invoice.
0
First name of the recipient of the invoice
Last name of the recipient of the invoice
Company name of the recipient of the invoice
The shipping address.
250
"123 Walnut St"
Additional line for shipping address.
100
"STE 900"
Shipping city.
250
"Johnson City"
Shipping state or province.
"TN"
Shipping ZIP code.
50
"37619"
Shipping address country.
"US"
Shipping recipient's contact email address.
320
"example@email.com"
Recipient phone number
Sender shipping ZIP code.
"30040"
Commodity code.
"501718"
Array of line items included in the invoice
Customer object associated to the invoice
Identifier of paymentlink associated to the invoice.
Array of event objects with information related to events associated to the invoice.
Options to be applied for scheduled invoices
Paypoint legal name
Paypoint DBA name
Paypoint entry name
Name of paypoint's parent organization
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"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Object containing attachments associated to the invoice.
Was this page helpful?