Get subcontractor key information document details

GET

/v1/key-information-for-subcontractor-workers

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

• Production

Returns one of your agency’s subcontractor 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

contractType

string

nullable

businessConnectionWithSubContractor

string

nullable

expectedGrossPayRate

string

nullable

deductionFromSubContractorIncome

string

nullable

otherDeductionFromSubContractorIncome

string

nullable

expectedPayRate

string

nullable

deductionFromWage

string

nullable

extraDeductionFromWage

string

nullable

feesForServices

string

nullable

holidayEntitlementAndPay

string

nullable

additionalBenefits

string

nullable

exampleGrossPayRateToSubContractor

string

nullable

deductionFromSubContractor

string

nullable

extraDeductionFromSubContractorIncome

string

nullable

examplePayRate

string

nullable

deductionFromWorkersPay

string

nullable

extraDeductionFromWorkersPay

string

nullable

extraFeesForServices

string

nullable

netTakeHomePay

string

nullable

exampleGrossPayRateToWorker

string

nullable

deductionFromWorker

string

nullable

extraDeductionFromWorkerIncome

string

nullable

examplePayRateSubContractor

string

nullable

deductionFromSubContractorPay

string

nullable

extraDeductionFromSubContractorPay

string

nullable

extraFeesForServicesForSubContractor

string

nullable

netTakeHomePaySubContractor

string

nullable

Example^generated

{
  "contractType": "example",
  "businessConnectionWithSubContractor": "example",
  "expectedGrossPayRate": "example",
  "deductionFromSubContractorIncome": "example",
  "otherDeductionFromSubContractorIncome": "example",
  "expectedPayRate": "example",
  "deductionFromWage": "example",
  "extraDeductionFromWage": "example",
  "feesForServices": "example",
  "holidayEntitlementAndPay": "example",
  "additionalBenefits": "example",
  "exampleGrossPayRateToSubContractor": "example",
  "deductionFromSubContractor": "example",
  "extraDeductionFromSubContractorIncome": "example",
  "examplePayRate": "example",
  "deductionFromWorkersPay": "example",
  "extraDeductionFromWorkersPay": "example",
  "extraFeesForServices": "example",
  "netTakeHomePay": "example",
  "exampleGrossPayRateToWorker": "example",
  "deductionFromWorker": "example",
  "extraDeductionFromWorkerIncome": "example",
  "examplePayRateSubContractor": "example",
  "deductionFromSubContractorPay": "example",
  "extraDeductionFromSubContractorPay": "example",
  "extraFeesForServicesForSubContractor": "example",
  "netTakeHomePaySubContractor": "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"
}