Class PayrollId

Namespace

Payetools.Common.Model

Assembly

Payetools.Common.dll

Represents a payroll ID (also known as a "worker ID", "payroll number", "works number") as reported to HMRC.

public sealed record PayrollId : IEquatable<PayrollId>

Inheritance

object

PayrollId

Implements

IEquatable<PayrollId>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This type is meant to aid payroll ID changes. Further work required.

Constructors

PayrollId(string, bool, string?)

Initialises a new instance of PayrollId with the supplied value.

public PayrollId(string payrollId, bool isUpdate = false, string? previousPayrollId = null)

Parameters

payrollId string

Payroll ID value.

isUpdate bool

True if this an update to a previously submitted payroll ID; false otherwise. Default is false.

previousPayrollId string

If isUpdate is set to true, then this parameter should be set to the previous payroll ID used.

Properties

IsUpdate

Gets a value indicating whether this payroll ID is an update to a previously submitted payroll ID.

public bool IsUpdate { get; }

Property Value

bool

PreviousPayrollId

Gets the previous payroll ID, where applicable.

public string? PreviousPayrollId { get; }

Property Value

string

Methods

Parse(string)

Parses the supplied payroll ID. TBA.

public static PayrollId Parse(string value)

Parameters

value string

Value to parse.

Returns

PayrollId

Parsed value. TBA.

Operators

implicit operator string(PayrollId)

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

public static implicit operator string(PayrollId payrollId)

Parameters

payrollId PayrollId

An instance of PayrollId.

Returns

string

implicit operator PayrollId(string)

Operator for casting implicitly from a payroll ID string value to a PayrollId instance.

public static implicit operator PayrollId(string payrollId)

Parameters

payrollId string

String representation of payroll ID.

Returns

PayrollId