RiskRateModel

Represents a risk rate calculation for a single month

Methods

The following API methods use this data model.

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.

reportDate

date-time

The month the risk rate was calculated for

totalInvoiceCount

int32

The count of all invoices in the calculation month

totalInvoiceAmount

double

The sum of the total amount for invoices in the calculation month in the group's base currency.

atRiskCount

int32

The count of open invoices over 90 days from the calculation month

atRiskAmount

double

The sum of the outstanding balance of open invoices over 90 days from the calculation month in the group's base currency.

atRiskCountPercentage

double

The percentage of all open invoices for the calculation month that are over 90 days based on count

atRiskPercentage

double

The percentage of all open invoices for the calculation month that are over 90 days based on outstanding balance

Optional Fields

baseCurrencyCode

string, nullable, 0-3 characters

The base currency code of the group.

invoiceMonthName

string, nullable

The string name of the month the risk rate was calculated for

Deprecated Fields

Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.

reportPeriod

date-time

The month the risk rate was calculated for