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

ParameterTypeDescription
editableBooleanDefault 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*stringThe invoice number as presented to the payer.
invoiceDate*stringDate invoice was issued. yyyy-mm-dd or mm/dd/yyyy
dueDatestringDate invoice is due. yyyy-mm-dd or mm/dd/yyyy
subtotalAmountdecimalAmount of invoice before any tax or discount.
discountAmountdecimalAmount being discounted.
taxdecimalAmount allocated to tax.
outstandingBalance*decimalAmount 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.
paymentAmountdecimalIf none passed in, payment amount will default to outstanding balance.
clientIDstringNumerical Identifier for the client/payer.
clientNamestringName of client/payer
pdfLinkstringIf 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"
    }