Reference data

One rate by id

A single rate by its stable id, for example acc-earner-levy.

Ids do not change when a value does, so they are safe to store and to key on. Call GET /v1/rates to see them all.

get/v1/rates/{rate_id}

Request

  • Base URL: https://api.calculate.co.nz
  • URL: https://api.calculate.co.nz/v1/rates/{rate_id}
  • Auth: API key in header X-API-Key

Path parameters

rate_idstring required

Response

The rate, its effective date, source and review cycle.

idstring required

Stable identifier. Safe to store and to key on.

labelstring required

What the figure is, in words.

valuestring required

The current value, as published. A string so 1.75 and 0.0175 are never confused by a float.

effective_fromstring nullable

ISO date the value took effect, where the source states one.

sourcestring nullable

Where it was read from. A URL for anything verified against an issuing body.

verified_onstring nullable

ISO date this figure was last checked against the issuing body. NULL means recorded but not yet verified, and is deliberately visible rather than hidden.

review_cyclestring required

When it next changes: annual-1-april, budget-may, periodic, or on-legislative-change. This is the field to filter on if you want to know what to re-check and when.

previous_valuesstring[] nullable

Prior values, most recent first. Undated for now.

history_notestring nullable

The limits of previous_values.

notestring nullable

Anything a consumer needs to know about this figure.

Changes

No recorded changes to this operation across all 1 revision of this API.