Skip to content
Recruso API

Get cost centre details

GET
/v1/branches/{branchId}/cost-centres/{id}
curl --request GET \
  --url https://api2.recruso.co.uk/v1/branches/1/cost-centres/1 \
  --header 'Authorization: <Authorization>'

Returns a single cost centre with its Sage department and nominal code.

Both ids must line up: a cost centre that exists but belongs to a different branch returns 404. A deleted cost centre, one outside your agency, or one under a branch you cannot access also returns 404 rather than 403.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
branchId
required
integer format: int32

The branchId path parameter

id
required
integer format: int32

The id path parameter

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

A single cost centre belonging to one branch.

object
costCentreId

The cost centre’s identifier. Unique within the agency, not within the branch.

integer format: int16
branchId

The branch the cost centre belongs to. A cost centre cannot be moved between branches.

integer format: int16
costCentreName

The cost centre name. Unique among the branch’s cost centres, deleted ones included.

string
sageDepartmentId

The cost centre’s Sage department. The parent branch carries a sageDepartmentId of its own; which one a posting uses is decided by the Sage integration, not by this endpoint.

integer format: int32
nullable
nominalCode

The nominal (general-ledger) code this cost centre posts against.

integer format: int64
nullable
Example
{
  "costCentreId": 31,
  "branchId": 4,
  "costCentreName": "Warehouse Operatives",
  "sageDepartmentId": 21,
  "nominalCode": 4001
}

401

Section titled “401”

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}