Struct HmrcPayeReference

Namespace

Payetools.Common.Model

Assembly

Payetools.Common.dll

Represents an HMRC PAYE Reference, as defined at https://design.tax.service.gov.uk/hmrc-design-patterns/employer-paye-reference/, which is formatted as follows:

• 3 numbers
• a forward slash ('/')
• between 1 and 10 characters, which can be letters and numbers

public struct HmrcPayeReference

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

HmrcPayeReference(int, string)

Initialises a new instance of HmrcPayeReference using the Office number and Employer PAYE reference elements.

public HmrcPayeReference(int hmrcOfficeNumber, string employerPayeReference)

Parameters

hmrcOfficeNumber int

HMRC Office Number (always 3 digits).

employerPayeReference string

Employer PAYE reference (the part after the '/').

Properties

EmployerPayeReference

Gets or sets the PAYE reference portion of the full HMRC PAYE Reference, i.e., the portion on the right hand of '/'.

public string EmployerPayeReference { readonly get; set; }

Property Value

string

HmrcOfficeNumber

Gets or sets the HMRC office number portion of the full PAYE Reference. Always 3 digits.

public int HmrcOfficeNumber { readonly get; set; }

Property Value

int

Methods

IsValid(string?)

Verifies whether the supplied string could be a valid HMRC PAYE Reference.

public static bool IsValid(string? value)

Parameters

value string

String value to check.

Returns

bool

True if the supplied value could be a valid HMRC PAYE Reference; false otherwise.

Remarks

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

ToString()

Gets the string representation of this HmrcPayeReference.

public override readonly string ToString()

Returns

string

The value of this HmrcPayeReference as a string.

TryParse(string?, out HmrcPayeReference?)

Attempts to parse the supplied string into an HmrcPayeReference object.

public static bool TryParse(string? input, out HmrcPayeReference? payeReference)

Parameters

input string

String value containing candidate full HMRC PAYE Reference. Lower case characters are converted to upper case.

payeReference HmrcPayeReference?

Set to a new instance of HmrcPayeReference if parse succeeds; set to object default otherwise.

Returns

bool

True if the string could be parsed into a valid HMRC PAYE Reference; false otherwise.

Operators

implicit operator string(HmrcPayeReference)

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

public static implicit operator string(HmrcPayeReference value)

Parameters

value HmrcPayeReference

An instance of HmrcPayeReference.

Returns

string