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
AdditionalDatastringOptional

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 objectsOptional
Array of event objects with information related to events associated to the invoice.
companystringOptional
Company name of the recipient of the invoice
createdAtdatetimeOptional
Timestamp of when invoice was created, in UTC.
customerobjectOptional
Customer object associated to the invoice
customerIdlongOptional
Identifier of customer associated to the invoice
discountdoubleOptional
Discount applied to the invoice.
documentsRefobjectOptional
Object containing attachments associated to the invoice.
dutyAmountdoubleOptional
Duty amount.
firstNamestringOptional
First name of the recipient of the invoice
freightAmountdoubleOptional

Freight/shipping amount.

frequencystringOptional
Frequency of scheduled invoice.
invoiceAmountdoubleOptional
Invoice total amount.
invoiceDatedateOptional

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

invoiceDueDatedateOptional

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

invoiceEndDatedateOptional

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

invoiceIdlongOptional
Identifier of invoice.
invoiceNumberstringOptional<=250 characters
Custom number identifying the bill or invoice. Must be unique in paypoint.
invoicePaidAmountdoubleOptional
Amount partially paid to the invoice.
invoiceSentDatedatetimeOptional
Timestamp of when invoice was sent, in UTC.
invoiceStatusintegerOptional

Status for invoice.

The accepted status values are:

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

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

itemslist of objectsOptional
Array of line items included in the invoice
lastNamestringOptional
Last name of the recipient of the invoice
lastPaymentDatedatetimeOptional
Timestamp of last payment, in UTC.
notesstringOptional
Notes included in the invoice.
parentOrgNamestringOptional
Name of paypoint's parent organization
paylinkIdstringOptional
Identifier of paymentlink associated to the invoice.
paymentTermsstringOptional

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

paypointDbanamestringOptional
Paypoint DBA name
paypointEntrynamestringOptional
Paypoint entry name
paypointIdlongOptional
Internal identifier of paypoint associated to the invoice.
paypointLegalnamestringOptional
Paypoint legal name
purchaseOrderstringOptional
Purchase order number.
scheduledOptionsobjectOptional
Options to be applied for scheduled invoices
shippingAddress1stringOptional<=250 characters
The shipping address.
shippingAddress2stringOptional<=100 characters
Additional line for shipping address.
shippingCitystringOptional<=250 characters
Shipping city.
shippingCountrystringOptional
Shipping address country.
shippingEmailstringOptionalformat: "email"<=320 characters
Shipping recipient's contact email address.
shippingFromZipstringOptional
Sender shipping ZIP code.
shippingPhonestringOptional
Recipient phone number
shippingStatestringOptional
Shipping state or province.
shippingZipstringOptional<=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”.

summaryCommodityCodestringOptional
Commodity code.
taxdoubleOptional
Tax rate in percent applied to the invoice.
termsConditionsstringOptional
Custom terms and conditions included in the invoice.

Errors

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