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

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

Freight/shipping amount.

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

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

invoiceDueDatedate

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

invoiceEndDatedate

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

invoiceIdlong
Identifier of invoice.
invoiceNumberstring<=250 characters
Custom number identifying the bill or invoice. Must be unique in paypoint.
invoicePaidAmountdouble
Amount partially paid to the invoice.
invoiceSentDatedatetime
Timestamp of when invoice was sent, 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.

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

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

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

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error