latestOpenAPI 3.0.02026-07-13393178.8 KB

669a30d937df

Reference Data

Lookup values by type

This endpoint is designed for loading lookup values (reference data).

A lookup consists of a sequence of values. A lookup value is essentially a code-and-description pair and optionally a sort-order value. Where present, the sort-order provides the correct ordering of the lookup values.

There's a number of lookups of different types available in the system. This endpoint enables retrieval of the full set of lookup values of a provided lookup type.

Lookup types grouped by area of use Valuation of shop/warehouse/office/land/misc - `basisOfMeasurement` - `useCode` - `floor` - `year` - `adjCode` - `oaCode` - `otherAdditionsDfe` Valuation of licensed premises - `lpAgeDfe` - `lpClass` - `lpExtension` - `lpGrade` - `lpLocation` - `lpType` Check case submission - `codeOfGroundsDfe` Challenge case submission - `challengeCodeOfGroundsDfe`

get/lookup-codes/{lookupName}

Path parameters

lookupNamestring required

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used

Response

LookupsResponseSchemaJson required— unresolved $ref