Skip to main content
PUT
Update a cost sheet

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

cost_sheet_id
string<uuid>
required

The unique identifier for the cost sheet.

Body

application/vnd.api+json

The cost sheet to update. The organisation cannot be changed, and neither can the node the sheet costs — move the sheet by deleting it and creating another.

data
object
required

Response

The updated cost sheet.

JSON API response object

data
object
required

A cost sheet — the costing of one node of the job hierarchy.

A sheet holds no money itself. The cost lives on its cost lines, which are a separately permissioned resource, so a principal may be allowed to see that a job has been costed without being allowed to see what it cost.

The link to the node it costs is polymorphic: cost_centre_type names the resource type and cost_centre_id identifies the record.

jsonapi
object
required
included
object[]

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