GET
Get Computation

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
wage_type_id
string
required

Query Parameters

valid_at
string<date> | null

Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.

Response

Successful Response

computation
FixedSpec · object
required
edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

depends_on
string[]

Codes whose amounts the computation reads

precision
integer | null
default:2

Decimal places the result is rounded to; null leaves rounding to the computation itself

Required range: 0 <= x <= 6
rounding
enum<string>
default:HALF_UP

The eight rounding modes from Python's decimal module.

A closed mathematical set: every value maps 1:1 to a decimal.ROUND_* constant, exposed via :attr:decimal_mode. Exposing all eight once keeps the set stable — a country needing e.g. HALF_DOWN never forces a library release. (Nearest-multiple rounding — Swiss 0.05, Swedish öre — is not a decimal mode and needs a richer Round, not a new member.)

Available options:
HALF_UP,
HALF_DOWN,
HALF_EVEN,
UP,
DOWN,
CEILING,
FLOOR,
ZERO_FIVE_UP
locked_fields
string[]
read-only

Paths into computation that a write may not change; * locks the whole computation and depends_on