Skip to main content
GET
Get a cost line

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

cost_line_id
string<uuid>
required

The unique identifier for the cost line.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
cost_sheet,
cost_item,
cost_item_version

Response

An individual cost line.

JSON API response object

data
object
required

A cost line — one costed entry on a cost sheet: a quantity of a rate code, priced at the rate that was in force on the day the work was done.

The pricing is a snapshot, on both sides. rate and amount are resolved once, on write, from the register version in force on work_date, and that version is referenced by the cost_item_version relationship. margin and charge — what the line sells for — are frozen at the same moment. None of them are ever recomputed: revising a rate or a margin in the register changes what future lines cost and sell for, and leaves every existing line exactly as it was recorded.

This resource carries monetary values and is permissioned separately from the cost sheet it belongs to.

jsonapi
object
required
included
object[]

Related resources that can be included when a cost line is returned.

cost-items and cost-item-versions are both optional on a line, so asking for either simply yields nothing for the lines that have none — an ad-hoc line has no rate code, and a line priced on the job has no register version behind its rate. Neither is an error, and a request for both across a mixed collection comes back with whatever exists.

An organisation