Skip to content

FinanceCostTotals

The totals of the instance’s costs as the holders of view_finance read them over the periods from the one that holds from to the one that holds to, oldest first, and the instance settings that decide what they read.

object
granularity
required

The periods of the totals: ISO 8601 weeks (Monday to Sunday), calendar months, or calendar years, cut by date.

string
Allowed values: week month year
basis
required

How the totals place a payment. amortized (the default) spreads each payment of a schedule longer than a month (every 2 or more months, every year, every 5 or more weeks) by day over the days up to the next payment, with the cumulative rounding; the other payments stay on their dates. cash places every payment on its date. Imported usage charges spread by day over their billing period under both.

string
Allowed values: amortized cash
periods
required
Array<object>

A week, month, or year of the totals, as in CostPeriodTotal, with the item lines of the period: empty unless the instance shows the names or the memos of the items, and sorted by provider, category, name, and currency; without the names, by provider, category, currency, and the larger amount first.

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}$/
totals
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}$/
breakdown
required
Array<object>

The amount of a provider, category, and currency in a period. The costs group by the provider in NFKC and lower case, so ConoHa, conoha, and ConoHa share a line.

object
provider
required

The provider as entered, one spelling for every line of the same grouped provider in the period: the provider of the cost item whose current label was revised last among the items with payments in the period (the larger revision ID on a tie), or, for a provider of imported costs only, the import’s provider name (AWS, Google Cloud).

string
category
required

The fixed category of a cost; clients translate its name.

string
Allowed values: compute database storage network domain email software other
amount
required

Schema: Money

object
estimated
required
boolean
items
required
Array<object>

The amount of a cost item, or of a service of the imported costs, in a currency over a period, with the provider and the category of its breakdown line. provider is the spelling that the period’s breakdown lines of the item’s grouped provider show (CostBreakdownLine). name is the item’s name or the service, present only while the instance shows the names; memo is the item’s memo, present only while the instance shows the memos and the item has one (an imported cost has none).

object
provider
required
string
category
required

The fixed category of a cost; clients translate its name.

string
Allowed values: compute database storage network domain email software other
amount
required

Schema: Money

object
name
string
memo
string
rules
required
object
viewer
required
object

Example generated

{
"granularity": "week",
"basis": "amortized",
"periods": [
{
"label": "example",
"starts_on": "example",
"ends_on": "example",
"totals": [
{
"amount": "example",
"currency": "example"
}
],
"breakdown": [
{
"provider": "example",
"category": "compute",
"amount": {}
}
],
"estimated": true,
"items": [
{
"provider": "example",
"category": "compute",
"amount": {},
"name": "example",
"memo": "example"
}
]
}
],
"rules": {},
"viewer": {}
}

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

Analytics on this site