API referencePay In endpointsInvoices

Get invoice

Retrieves a single invoice by ID.

Authentication

requestTokenstring
API Key authentication via header

Path Parameters

idInvoiceintegerRequired
Invoice ID

Response

Success
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" } } ```
billEventslist of objects or null
Array of event objects with information related to events associated to the invoice.
companystring or null
Company name of the recipient of the invoice
createdAtdatetime or null
Timestamp of when invoice was created, in UTC.
customerobject or null
Customer object associated to the invoice
customerIdlong or null
Identifier of customer associated to the invoice
discountdouble or null
Discount applied to the invoice.
documentsRefobject or null
Object containing attachments associated to the invoice.
dutyAmountdouble or null
Duty amount.
firstNamestring or null
First name of the recipient of the invoice
freightAmountdouble or null

Freight/shipping amount.

frequencystring or null
Frequency of scheduled invoice.
invoiceAmountdouble or null
Invoice total amount.
invoiceDatedate or null

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

invoiceDueDatedate or null

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

invoiceEndDatedate or null

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

invoiceIdlong or null
Identifier of invoice.
invoiceNumberstring or null<=250 characters
Custom number identifying the bill or invoice. Must be unique in paypoint.
invoicePaidAmountdouble or null
Amount partially paid to the invoice.
invoiceSentDatedatetime or null
Timestamp of when invoice was sent, in UTC.
invoiceStatusinteger or null
Status for invoice. The accepted status values are: - 0 draft - 1 active - 2 partially paid - 4 paid/complete - 99 cancelled
invoiceTypeinteger or null

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

itemslist of objects or null
Array of line items included in the invoice
lastNamestring or null
Last name of the recipient of the invoice
lastPaymentDatedatetime or null
Timestamp of last payment, in UTC.
notesstring or null
Notes included in the invoice.
parentOrgNamestring or null
Name of paypoint's parent organization
paylinkIdstring or null
Identifier of paymentlink associated to the invoice.
paymentTermsstring or null

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

paypointDbanamestring or null
Paypoint DBA name
paypointEntrynamestring or null
Paypoint entry name
paypointIdlong or null
Internal identifier of paypoint associated to the invoice.
paypointLegalnamestring or null
Paypoint legal name
purchaseOrderstring or null
Purchase order number.
scheduledOptionsobject or null
Options to be applied for scheduled invoices
shippingAddress1string or null<=250 characters
The shipping address.
shippingAddress2string or null<=100 characters
Additional line for shipping address.
shippingCitystring or null<=250 characters
Shipping city.
shippingCountrystring or null
Shipping address country.
shippingEmailstring or nullformat: "email"<=320 characters
Shipping recipient's contact email address.
shippingFromZipstring or null
Sender shipping ZIP code.
shippingPhonestring or null
Recipient phone number
shippingStatestring or null
Shipping state or province.
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”.

summaryCommodityCodestring or null
Commodity code.
taxdouble or null
Tax rate in percent applied to the invoice.
termsConditionsstring or null
Custom terms and conditions included in the invoice.

Errors