Struct PayDate

Namespace

Payetools.Common.Model

Assembly

Payetools.Common.dll

Represents a specific pay date for a specific pay frequency.

public readonly struct PayDate

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PayDate(DateOnly, PayFrequency)

Initialises a new PayDate based on the supplied date and pay frequency.

public PayDate(DateOnly date, PayFrequency payFrequency)

Parameters

date DateOnly

Pay date.

payFrequency PayFrequency

Pay frequency.

PayDate(int, int, int, PayFrequency)

Initialises a new PayDate based on the supplied date and pay frequency.

public PayDate(int year, int month, int day, PayFrequency payFrequency)

Parameters

year int

Year.

month int

Month (1-12).

day int

Day.

payFrequency PayFrequency

Pay frequency.

Properties

Date

Gets the date of this PayDate.

public DateOnly Date { get; init; }

Property Value

DateOnly

PayFrequency

Gets the pay frequency for this PayDate.

public PayFrequency PayFrequency { get; init; }

Property Value

PayFrequency

TaxPeriod

Gets the tax period for this PayDate, for example, a pay date of 20th May for a monthly payroll would be tax period 2.

public int TaxPeriod { get; init; }

Property Value

int

TaxYear

Gets the TaxYear for this PayDate.

public TaxYear TaxYear { get; init; }

Property Value

TaxYear

Methods

GetWeekOrMonthNumber(out int, out bool)

Gets either the week number or the month number for this pay date, with the second out parameter indicating which.

public void GetWeekOrMonthNumber(out int periodNumber, out bool isWeekly)

Parameters

periodNumber int

Week number or month number for this pay date.

isWeekly bool

True if the first out parameter is a week number, false indicates it is a month number.

ToString()

Provides a string representation of this pay date in the form 'dd/mm/yyyy (frequency, period)'.

public override string ToString()

Returns

string

String representation of this PayDate.

Operators

implicit operator DateTime(PayDate)

Gets the equivalent DateTime for this paydate, with the time portion set to midday (12:00:00) UTC.

public static implicit operator DateTime(PayDate payDate)

Parameters

payDate PayDate

PayDate to get the DateTime for.

Returns

DateTime