InvoiceSummaryModel

Contains summarized data for an invoice

Required Fields

groupKey

uuid

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

invoiceId

uuid

The unique ID number of this invoice.

paymentCount

int32

The number of payments associated to this invoice.

supportsErpPdfRetrieval

boolean

Specific invoices have support for pdf retrieval from their respective erp. When this flag is true, an additional
call to Invoices/{id}/pdf can be made to retrieve a pdf directly from the erp.

modified

date-time

The modified date of the invoice.

Optional Fields

customerId

uuid, nullable

The ID number of the counterparty for the invoice, for example, a customer or vendor.

invoiceNumber

string, nullable

A reference code that is used to identify this invoice.
The meaning of this field is specific to the ERP or accounting system used by the user.

invoiceDate

date, nullable

The reporting date for this invoice.

invoiceClosedDate

date, nullable

The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
services.

customerName

string, nullable

The name of the counterparty for the invoice, for example, a customer or vendor.

status

string, nullable

The status of the invoice.

paymentDueDate

date, nullable

The due date of the invoice.

currencyCode

string, nullable, 0-3 characters

The currency code for the invoice.

invoiceAmount

double, nullable

The total amount of the Invoice.

outstandingBalance

double, nullable

The remaining balance value of this invoice.

baseCurrencyCode

string, nullable, 0-3 characters

The group's base currency code.

baseCurrencyInvoiceAmount

double, nullable

The invoice amount in the group's base currency

baseCurrencyOutstandingBalance

double, nullable

The outstanding balance amount in the group's base currency

invoiceTypeCode

string, nullable

A code identifying the type of this Invoice.

newestActivity

date, nullable

The date stamp for the newest Activity on this Invoice.

daysPastDue

int32, nullable

The number of days this Invoice is past due.

paymentNumbers

string[], nullable

The memo text of the payments associated to this invoice.

paymentIds

uuid[], nullable

The ids of the payments associated to this invoice.