Get PAYE key information document details

GET

/v1/key-information-for-paye-workers

curl --request GET \
  --url https://api2.recruso.co.uk/v1/key-information-for-paye-workers \
  --header 'Authorization: <Authorization>'

• Production

Returns one of your agency’s PAYE key information documents by id. Nothing calculates from these values — they are reproduced as text in reports, which is the whole of what the document is for.

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

• Bearer

Responses

200

OK

Media typeapplication/json

object

employerName

string

nullable

contractType

string

nullable

paymentFrom

string

nullable

expectedPayRate

string

nullable

deductionFromPay

string

nullable

extraDeductionFromPay

string

nullable

feesForServices

string

nullable

holidayEntitlementAndPay

string

nullable

additionalBenefits

string

nullable

examplePayRate

string

nullable

deductionFromWages

string

nullable

extraDeductionFromWages

string

nullable

exampleFeesForService

string

nullable

exampleNetHomeTakePay

string

nullable

Example^generated

{
  "employerName": "example",
  "contractType": "example",
  "paymentFrom": "example",
  "expectedPayRate": "example",
  "deductionFromPay": "example",
  "extraDeductionFromPay": "example",
  "feesForServices": "example",
  "holidayEntitlementAndPay": "example",
  "additionalBenefits": "example",
  "examplePayRate": "example",
  "deductionFromWages": "example",
  "extraDeductionFromWages": "example",
  "exampleFeesForService": "example",
  "exampleNetHomeTakePay": "example"
}

401

Unauthorized

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

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

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}