Struct NiNumber

Namespace

Payetools.Common.Model

Assembly

Payetools.Common.dll

Represents a Uk National Insurance number, also referred to as NI number or NINO. A NINO is made up of 2 letters, 6 numbers and a final letter which is always A, B, C or D. (See HMRC's National Insurance Manual, section NIM39110 (https://www.gov.uk/hmrc-internal-manuals/national-insurance-manual/nim39110.)

public readonly struct NiNumber

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Marked partial as using GeneratedRegexAttribute for .NET 7.0 or above.

Constructors

NiNumber(string)

Initialises a new NiNumber instance.

public NiNumber(string niNumber)

Parameters

niNumber string

National insurance number as string.

Exceptions

ArgumentException

Thrown if the supplied string is not a valid NI number.

Properties

IsUnknown

Gets a value indicating whether this NiNumber instance represents an unknown National Insurance number.

public bool IsUnknown { get; }

Property Value

bool

Unknown

Gets the NiNumber to be used when an employee does not know their National Insurance number.

public static NiNumber Unknown { get; }

Property Value

NiNumber

Methods

IsValid(string)

Verifies whether the supplied string could be a valid NI number.

public static bool IsValid(string value)

Parameters

value string

String value to check.

Returns

bool

True if the supplied value could be a valid NI number; false otherwise.

Remarks

Although this method confirms whether the string supplied could be a valid Ni nummber, it does not guarantee that the supplied value is registered with HMRC against a given individual.

ToString()

Gets the string representation of this NiNumber.

public override string ToString()

Returns

string

String representation of this NI number in non-spaced format.

ToString(bool)

Gets the string representation of this NiNumber.

public string ToString(bool asSpacedFormat)

Parameters

asSpacedFormat bool

True if spaced format is to be returned (e.g., "NA 12 34 67 C"; false otherwise.

Returns

string

String representation of this NI number in either spaced or non-spaced format.

Operators

implicit operator string(NiNumber)

Operator for casting implicitly from a NiNumber instance to its string representation.

public static implicit operator string(NiNumber niNumber)

Parameters

niNumber NiNumber

NI number.

Returns

string

implicit operator NiNumber(string)

Operator for casting implicitly from a string to an instance of a NiNumber.

public static implicit operator NiNumber(string niNumber)

Parameters

niNumber string

NI number as string.

Returns

NiNumber

Exceptions

ArgumentException

Thrown if the supplied string is not a valid NI number.