Skip to content

IncomePeriodTotal

A week, month, or year of the income totals (label: 2026-W17, 2026-04, or 2026): the net income of each currency (what the payments brought less the provider’s fees and the refunds), never converted, sorted by currency code. balance is the net less the costs of each currency under the same basis, present only where the balance is shown: a currency of one side alone shows that side’s amount.

object
label
required
string
starts_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
ends_on
required

A calendar date YYYY-MM-DD without a time or a time zone, such as the day of a payment on a card statement or an invoice.

string
/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/
net
required
Array<object>

An amount of money: a decimal string in the major unit with the digits of its currency (12.34 USD, 1650 JPY), never a JSON number, and its ISO 4217 code.

object
amount
required
string
/^-?[0-9]+(\.[0-9]+)?$/
currency
required
string
/^[A-Z]{3}$/
balance
Array<object>

An amount of money: a decimal string in the major unit with the digits of its currency (12.34 USD, 1650 JPY), never a JSON number, and its ISO 4217 code.

object
amount
required
string
/^-?[0-9]+(\.[0-9]+)?$/
currency
required
string
/^[A-Z]{3}$/

Example generated

{
"label": "example",
"starts_on": "example",
"ends_on": "example",
"net": [
{
"amount": "example",
"currency": "example"
}
],
"balance": [
{
"amount": "example",
"currency": "example"
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site