Add Invoice

Authorizations

requestToken

string

header

required

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

Headers

idempotencyKey

string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Path Parameters

entry

string

required

The paypoint's entrypoint identifier. Learn more

Query Parameters

forceCustomerCreation

boolean

default:

false

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.

Body

customerData

object

Object describing the customer/payor. Required for POST requests. Which fields are required depends on the paypoint's custom identifier settings. See PayorData Object Model for a complete reference.

customerData.additionalData

object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Example usage:

{
  "additionalData": {
    "CustomIdentifier": "value",
    "key2": "value2",
    "key3": "value3"
  }
}

customerData.billingAddress1

string | null

Customer's billing address.

Maximum length: 250

customerData.billingAddress2

string | null

Additional line for Customer's billing address.

Maximum length: 100

customerData.billingCity

string | null

Customer's billing city.

Maximum length: 250

customerData.billingCountry

string | null

Customer's billing country.

Maximum length: 100

customerData.billingEmail

string | null

Customer's email address.

Maximum length: 250

customerData.billingPhone

string | null

Customer's phone number.

Maximum length: 50

customerData.billingState

string | null

Customer's billing state. Must be 2-letter state code for address in US.

Maximum length: 250

customerData.billingZip

string | null

Customer's billing ZIP code.

Maximum length: 50

customerData.company

string | null

Customer's company name.

Maximum length: 250

customerData.customerId

integer | null

The Payabli-generated unique ID for the customer.

customerData.customerNumber

string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250

customerData.firstName

string | null

Customer/Payor first name.

Maximum length: 250

customerData.identifierFields

(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

customerData.lastName

string | null

Customer/Payor last name.

Maximum length: 250

customerData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

customerData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

customerData.shippingCity

string | null

Shipping city.

Maximum length: 250

customerData.shippingCountry

string | null

Shipping address country.

Maximum length: 100

customerData.shippingState

string | null

Shipping state or province.

customerData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

invoiceData

object

Object describing the invoice. Required for POST requests.

invoiceData.AdditionalData

string | 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:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

invoiceData.attachments

object | null

Array of fileContent objects with attached documents. Max upload size is 30 MB.

invoiceData.company

string | null

Company name of the recipient of the invoice.

invoiceData.discount

number | null

Discount applied to the invoice.

invoiceData.dutyAmount

number | null

Duty amount.

invoiceData.firstName

string | null

First name of the recipient of the invoice.

invoiceData.freightAmount

number | null

Freight/shipping amount.

invoiceData.frequency

enum<string> | null

Frequency of scheduled invoice.

Available options:

one-time,

weekly,

every2weeks,

every6months,

monthly,

every3months,

annually

invoiceData.invoiceAmount

number | null

Invoice total amount.

invoiceData.invoiceDate

string | null

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

invoiceData.invoiceDueDate

string | null

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

invoiceData.invoiceEndDate

string | null

Indicate the date to finish a scheduled invoice cycle (`invoiceType`` = 1) in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY.

invoiceData.invoiceNumber

string | null

Invoice number. Identifies the invoice under a paypoint.

Maximum length: 250

invoiceData.invoiceStatus

enum<integer> | null

Status for invoice.

The accepted status values are:

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

Available options:

0,

1,

2,

4,

99

invoiceData.invoiceType

integer | null

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

invoiceData.items

object[] | null

Array of line items included in the invoice.

invoiceData.lastName

string | null

Last name of the recipient of the invoice.

invoiceData.notes

string | null

Notes included in the invoice.

invoiceData.paymentTerms

enum<string> | null

Payment terms for invoice. If no terms are defined, then reponse data for this field defaults to N30.

Available options:

PIA,

CIA,

UR,

NET10,

NET20,

NET30,

NET45,

NET60,

NET90,

EOM,

MFI,

5MFI,

10MFI,

15MFI,

20MFI,

2/10NET30,

UF,

10UF,

20UF,

25UF,

50UF

invoiceData.purchaseOrder

string | null

Purchase order number.

invoiceData.shippingAddress1

string | null

The shipping address.

Maximum length: 250

invoiceData.shippingAddress2

string | null

Additional line for shipping address.

Maximum length: 100

invoiceData.shippingCity

string | null

Shipping city.

Maximum length: 250

invoiceData.shippingCountry

string | null

Shipping address country.

invoiceData.shippingEmail

string | null

Shipping recipient's contact email address.

invoiceData.shippingFromZip

string | null

Sender shipping ZIP code.

invoiceData.shippingPhone

string | null

Recipient phone number.

invoiceData.shippingState

string | null

Shipping state or province.

invoiceData.shippingZip

string | null

Shipping ZIP code.

Maximum length: 50

invoiceData.summaryCommodityCode

string | null

Commodity code.

invoiceData.tax

number | null

Tax rate in percent applied to the invoice.

invoiceData.termsConditions

string | null

Custom terms and conditions included in the invoice.

scheduledOptions

object

Object with options for scheduled invoices.

Response

200 - application/json

Response schema for invoice operations.

isSuccess

boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageidentifier

string | null

Auxiliary validation used internally by payment pages and components.

responseCode

integer | null

Code for the response. Learn more in API Response Codes.

responseData

If isSuccess = true, this contains the identifier of the invoice. If isSuccess = false, this contains the reason for the failure.

responseText

string | null

Response text for operation: 'Success' or 'Declined'.

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response