Invoices

Field

Description

id string

Unique identifier for the invoice. This field is read-only.

amount_cents
integer

Invoice amount in specified currency's smallest unit. e.g. $10 would be represented as 1000. min_value=1. max_value=999999900

currency
string

Currency to be used for invoice payment. The accepted value is "USD"

discount_amount_cents
integer

Optional invoice discount amount in specified currency's smallest unit. min_value=1. max_value=999999900

invoice_number
string

Uniquely identifies an invoice for the recipient. Allowed characters for this field are ted, listed and displayed

invoice_date
date

Date of invoice provided by recipient. Must be +/- 365 days from today.

invoice_due_date
date

Optional invoice due date

note
string

The optional additional information you would like to include regarding this invoice. Max-length = 1000.

originating_counterparty_id
string

The ID of one of your organization's internal counterparties (Buyer) that will send payment.

receiving_counterparty_id
string

The ID of one of your external counterparty (Supplier) that will receive invoice payment.

metadata
object

Additional private data represented as key-value pairs. Both the key and value must be strings or integers.

payment_id
string

The id of the most recent Payment associated with this invoice. This field is read-only.

reconciliation_id
string

A string to identify the invoice in your accounting system. Max-length = 50

account_number
string

Account number. This sensitive information is stored encrypted and can only be retrieved through the API. Max-length = 250.

created
timestamp

Date the Invoice was created.

updated
timestamp

Date the Invoice was last updated.

payment_group_id
string

Optional value that will be used to group invoices into payments. When specified, only invoices with the same value will be included in a single payment.

can_be_resubmitted
boolean

Indicates if the same invoice number can be submitted again. Resubmitting the same invoice number for a specific buyer and supplier is only allowed if the prior payment was refunded.

accounting_id
string

Max-length = 70.

status
string

Current invoice status:

  • pending*: Invoice is being prepared for payment.
  • in-progress*: Payment for this invoice is in-progress.
  • sent*:
  • complete*: Payment for this invoice has been resolved.
  • failed*: An exception has occurred during payment processing.
  • canceled*: Funding for payment has an unrecoverable failure, or a pre-funding stop was performed.