PaymentDetailHeaderModel

Contains group level payment data.

Methods

The following API methods use this data model.

Retrieve Payment Detail Header

Required Fields

groupKey

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.

Optional Fields

baseCurrencyCode

string, nullable, 0-3 characters

The base currency code of the group.

customerCount

int32, nullable

The total number of Customers.

amountCollected

double, nullable

The total amount collected in the group's base currency.

unappliedAmount

double, nullable

The total unapplied amount in the group's base currency.

paidInvoiceCount

int32, nullable

The number of paid invoices.

openInvoiceCount

int32, nullable

The number of open invoices.