Get Invoice

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

Invoice ID

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

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

Company name of the recipient of the invoice

Timestamp of when invoice was created, in UTC.

Customer object associated to the invoice

Identifier of customer associated to the invoice

Discount applied to the invoice.

Object containing attachments associated to the invoice.

Duty amount.

First name of the recipient of the invoice

Freight/shipping amount.

Frequency of scheduled invoice.

Invoice total amount.

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

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

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

Identifier of invoice.

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

Amount partially paid to the invoice.

Timestamp of when invoice was sent, in UTC.

Status for invoice.

The accepted status values are:

• 0 draft
• 1 active
• 2 partially paid
• 4 paid/complete
• 99 cancelled

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

Array of line items included in the invoice

Last name of the recipient of the invoice

Timestamp of last payment, in UTC.

Notes included in the invoice.

Name of paypoint's parent organization

Identifier of paymentlink associated to the invoice.

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

Paypoint DBA name

Paypoint entry name

Internal identifier of paypoint associated to the invoice.

Paypoint legal name

Purchase order number.

Options to be applied for scheduled invoices

The shipping address.

Additional line for shipping address.

Shipping city.

Shipping address country.

Shipping recipient's contact email address.

Sender shipping ZIP code.

Recipient phone number

Shipping state or province.

Shipping ZIP code.

Commodity code.

Tax rate in percent applied to the invoice.

Custom terms and conditions included in the invoice.