Skip to main content
GET
Get a cost kit

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

cost_kit_id
string<uuid>
required

The unique identifier for the cost kit.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

What a kit contains is deliberately not includable. The lines point at the kit rather than the other way round, so there is nothing on a kit to sideload through. Ask for it with GET /v3/cost-kit-lines?filter=eq(cost_kit,<id>).

Available options:
organisation

Response

An individual cost kit.

JSON API response object

data
object
required

A cost kit — a reusable bundle of rate codes with set quantities, so a common task can be priced in one step instead of a dozen.

A kit carries no rate and no total of its own. Its price is the sum of its lines at the rates in force on the day, which is a question about cost-item-versions and is answered behind that resource's own permission — so a kit is readable by principals who may not see money at all.

jsonapi
object
required
included
object[]

Related resources that can be included when a cost kit is returned