This is the object that will be passed in using the Invoice Payment Page endpoint.

Parameter

Type

Description

editable

Boolean

Default is True. If set to true, amount to pay can be changed on page. If not, then amount is locked in at whatever is entered for paymentAmount.

invoiceNumber*

string

The invoice number as presented to the payer.

invoiceDate*

string

Date invoice was issued. yyyy-mm-dd or mm/dd/yyyy

dueDate

string

Date invoice is due. yyyy-mm-dd or mm/dd/yyyy

subtotalAmount

decimal

Amount of invoice before any tax or discount.

discountAmount

decimal

Amount being discounted.

tax

decimal

Amount allocated to tax.

outstandingBalance*

decimal

Amount that factors in any discount, tax, and previously made payments against this invoice. This is the maximum amount that can be paid on this invoice.

paymentAmount

decimal

If none passed in, payment amount will default to outstanding balance.

clientID

string

Numerical Identifier for the client/payer.

clientName

string

Name of client/payer

pdfLink

string

If provided, will surface a clickable link on payment page that routes to the URL provided. Commonly used to reference a PDF version of the invoice.

{
      "editable": true,
      "invoiceNumber": "12345",
      "invoiceDate": "2019-10-15",
      "dueDate": "2019-11-15",
      "subtotalAmount": 1000,
      "discountAmount": 0,
      "tax": 100,
      "outstandingBalance": 1100,
      "paymentAmount": 1100,
      "clientID": "123",
      "clientName": "Jones Industries",
      "pdfLink": "https://linktopdf.com/1765923874"
    }