Skip to main content
GET
One month of this client's marketing-fee statement

Authorizations

x-api-key
string
header
required

Path Parameters

month
string<date>
required

First day of the month (UTC).

Response

The month's statement

month
string<date>
required
y_bps_monthly
number<double>
required

The rate APPLIED to this month, in monthly basis points: the annual contract rate charged for the days this month actually has (y_bps_annual x days_in_month / 365), rounded to 2 decimal places — the precision it is charged and stored at. A later rate change does not rewrite it.

y_bps_annual
number<double>
required

The CONTRACT rate, in basis points per year, as the Order Form quotes it. Stated beside the applied rate so a client can check the month was charged from the rate they signed.

days_in_month
integer
required

Calendar days in the month — the divisor, never the number of rows stored.

days_stamped
integer
required

Days whose principal is stored. Lower than days_in_month while the month is still being derived or still running, which is how a partial month is shown as partial rather than as a complete small one.

daily
object[]
required
owed_minor
string

What the month owes this client, RD minor units. ABSENT until the month is priced — never zero, which would state that nothing is owed.

avg_daily_balance_minor
string

The mean of the month's stored daily principals. Absent while the month is incomplete.