Get invoice
Path parameters
Headers
Response
Success. Fields marked optional may return null
if not set.
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.
The Payabli-generated unique ID for the customer.
Date in YYYY-MM-DD format.
Date in YYYY-MM-DD format.
Date in YYYY-MM-DD format.
Payment terms for invoice. If no terms are defined, then response data for this field defaults to NET30
.
Available Values:
-
PIA
: Payment in advance -
CIA
: Cash in advance -
UR
: Upon receipt -
NET10
: 10 days after invoice date -
NET20
: 20 days after invoice date -
NET30
: 30 days after invoice date -
NET45
: 45 days after invoice date -
NET60
: 60 days after invoice date -
NET90
: 90 days after invoice date -
EOM
: Due end of this month -
MFI
: 1st of the month following the invoice date -
5MFI
: 5th of the month following the invoice date -
10MFI
: 10th of the month following the invoice date -
15MFI
: 15th of the month following the invoice date -
20MFI
: 20th of the month following the invoice date -
2/10NET30
: 2% discount if paid within 10 days, otherwise net 30 days -
UF
: Until further notice -
10UF
: 10 days until further notice -
20UF
: 20 days until further notice -
25UF
: 25 days until further notice -
50UF
: 50 days until further notice
Freight/shipping amount.
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”.
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:
A custom identifier for the paypoint, if applicable. Like entrypoint
is the Payabli identifier for the merchant, externalPaypointId
is a custom field you can use to include the merchant’s ID from your own systems.