Skip to content
Recruso API

Get rate type details

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

Returns one of your agency’s rate types by id. A rate type is one of the rates a worker’s hours can be paid at — basic, overtime, Saturday, Sunday, basic nights, night out, and pre- and post-tax expenses.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

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”
id
required
integer format: int32

The id path parameter

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
rateTypeId
required
integer format: int16
rateTypeName
required
string
isExpense
required
boolean
nullable
calculateInAverageRate
required
boolean
nullable
priorityOrder
required
integer format: int16
nullable
sagePayElementId
required
integer format: int32
nullable
isExpenseTaxable
required
boolean
nullable
primaryRateTypeId
required
integer format: int16
nullable
marginRate
required
number format: double
nullable
isVatable
required
boolean
nullable
Examplegenerated
{
  "rateTypeId": 1,
  "rateTypeName": "example",
  "isExpense": true,
  "calculateInAverageRate": true,
  "priorityOrder": 1,
  "sagePayElementId": 1,
  "isExpenseTaxable": true,
  "primaryRateTypeId": 1,
  "marginRate": 1,
  "isVatable": true
}

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"
}