domain's Introduction

domain

Micro-library for typing and validating UK tax identifiers.

Change History

v10.0 - 17 Jun 24

add Scala 3.0 support. Remove Scala 2.12 support, noting Scala 2.13 is still supported.
update library dependencies

v9.0 - 05 Dec 23

add support for Play 2.9 & Play 3.0, noting Play 2.8 is still supported
update Scala 2.13 version
update library dependencies
add 'Change History' section to README

v8.3.0 - 23 May 22

update broken sbt build

v8.1.0 - 06 May 22

update library dependencies

v8.0.0 - 14 Mar 22

add Scala 2.13 support

v7.0.0 - 21 Jan 22

drop Play 2.6 and Play 2.7 support

v6.0.0 - 24 Jun 21

Scala 2.12 only and add Play 2.8 support

Identifier Types

Types are provided for many common tax identifiers, such as:

Employment Reference (EmpRef)
National Insurance Number (NINO)
Unique Taxpayer References (UTR) - Self Assessment, Corporation Tax, Annual Tax on Enveloped Dwellings, Pension Scheme Administrator ID, Pension Scheme Practitioner ID, Alcohol Wholesale Registration Scheme,
Unique Agent Reference (UAR)
VAT Registration Number (VRN)
Agents - Code, UserId, PAYE Reference, Agent Business

JSON handling

Reads and Writes have been provided for Play's JSON library for all identifiers, and format validation is present for some. JSON objects with multiple tax identifiers as properties can be serialized or deserialized to a TaxIds:

import play.api.libs.json._
import uk.gov.hmrc.domain._

implicit val format =  TaxIds.format(TaxIds.defaultSerialisableIds :_*)

val input =
        """{
          |"nino": "NM439088A",
          |"sautr": "some-sa-utr"
        }""".stripMargin
val taxIds = Json.parse(input).as[TaxIds]

taxIds.nino  // Some(NM439088A)
taxIds.saUtr // Some(some-sa-utr)
taxIds.ctUtr // None

Installing

Before version 9.x.x

Add the following to your SBT build:

libraryDependencies += "uk.gov.hmrc" %% "domain" % "[LIB VERSION]-play-[PLAY VERSION]"

for example

libraryDependencies += "uk.gov.hmrc" %% "domain" % "8.3.0-play-28"

After version 9.x.x

Add the following to your SBT build:

libraryDependencies += "uk.gov.hmrc" %% "domain-play-[PLAY VERSION]" % "[LIB VERSION]"

for example

libraryDependencies += "uk.gov.hmrc" %% "domain-play-30" % "10.0.0"

License

This code is open source software licensed under the Apache 2.0 License.

domain's Issues

Nino should compare equal with or without spaces

At the moment, Nino("AA 00 00 00 A") does not equal Nino("AA000000A"). Really, they should canonicalised on creation so that they do compare equal.

Var reg number validation

A question about VRNs. There are not validations in this repo for them, but I believe they should be integers between 6 and 12 digits long. Could you please confirm the rules for VRN validation please?

Recommend Projects