units convention.md

Units Convention

How to interpret monetary values in responses:

Monthly-rate endpoints (e.g. /commitments, /commitment-plans, /commitments/summary, /metrics/overview, /moneyback-guarantees/savings): monetary fields are monthly rates based on a 730-hour month (8760 hours / 12 months — an annual-average month, NOT a calendar month, which varies 672-744 hours). A field labeled "monthly" reflects a per-730-hour figure, not a specific calendar month's total.
Aggregated metrics / time-series endpoints (e.g. /metrics/daily-savings, /metrics/daily-reservable-cost, /commitments/metrics): top-level monetary fields are sums over the requested date range, and values in daily rows are sums for that day. Neither is a monthly rate; magnitude scales with range length.
commitment_upfront_cost (top-level on individual commitments, plans, and plan line items — a sibling of commitment_financials_monthly_rate): one-time total dollars paid at signing — not a rate. Do not sum with monthly-rate fields. Omitted on aggregates (summary, metrics, invoices) where a summed upfront is not meaningful.

Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the ask query parameter, and the optional goal query parameter:

GET https://docs.archera.ai/api-reference/beta-api/units-convention.md?ask=<question>&goal=<endgoal>

ask is the immediate question: it should be specific, self-contained, and written in natural language. goal is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.