Class PayrunJob

The payrun job client object

Inheritance
object
ModelBase
PayrunJob
Implements
Inherited Members
Namespace: PayrollEngine.Client.Model
Assembly: PayrollEngine.Client.Core.dll
Syntax
public class PayrunJob : ModelBase, IPayrunJob, IModel, IAttributeObject, IEquatable<IPayrunJob>

Constructors

PayrunJob()

Initializes a new instance

Declaration
public PayrunJob()

PayrunJob(PayrunJob)

Initializes a new instance from a copy

Declaration
public PayrunJob(PayrunJob copySource)
Parameters
Type Name Description
PayrunJob copySource

The copy source

Properties

Attributes

Declaration
[JsonPropertyOrder(140)]
public Dictionary<string, object> Attributes { get; set; }
Property Value
Type Description
Dictionary<string, object>

CreatedReason

The created reason (immutable)

Declaration
[Required]
[JsonPropertyOrder(129)]
public string CreatedReason { get; set; }
Property Value
Type Description
string

CreatedUserId

The created user id (immutable)

Declaration
[JsonPropertyOrder(107)]
public int CreatedUserId { get; set; }
Property Value
Type Description
int

Culture

The culture including the calendar

Declaration
[JsonPropertyOrder(118)]
public string Culture { get; set; }
Property Value
Type Description
string

CycleEnd

The cycle end date (immutable)

Declaration
[JsonPropertyOrder(121)]
public DateTime CycleEnd { get; set; }
Property Value
Type Description
DateTime

CycleName

The cycle name (immutable)

Declaration
[Required]
[JsonPropertyOrder(119)]
public string CycleName { get; set; }
Property Value
Type Description
string

CycleStart

The cycle start date (immutable)

Declaration
[Required]
[JsonPropertyOrder(120)]
public DateTime CycleStart { get; set; }
Property Value
Type Description
DateTime

DivisionId

The division id (immutable)

Declaration
[JsonPropertyOrder(106)]
public int DivisionId { get; set; }
Property Value
Type Description
int

Employees

The payrun employees

Declaration
[JsonPropertyOrder(139)]
public List<PayrunJobEmployee> Employees { get; set; }
Property Value
Type Description
List<PayrunJobEmployee>

ErrorMessage

The job error message (immutable)

Declaration
[JsonPropertyOrder(138)]
public string ErrorMessage { get; set; }
Property Value
Type Description
string

EvaluationDate

The evaluation date (immutable)

Declaration
[Required]
[JsonPropertyOrder(125)]
public DateTime? EvaluationDate { get; set; }
Property Value
Type Description
DateTime?

Finished

The job finish date (immutable)

Declaration
[JsonPropertyOrder(128)]
public DateTime? Finished { get; set; }
Property Value
Type Description
DateTime?

FinishedReason

The finished reason (immutable)

Declaration
[JsonPropertyOrder(132)]
public string FinishedReason { get; set; }
Property Value
Type Description
string

FinishedUserId

The finished user id (immutable)

Declaration
[JsonPropertyOrder(110)]
public int? FinishedUserId { get; set; }
Property Value
Type Description
int?

Forecast

The forecast name (immutable)

Declaration
[StringLength(128)]
[JsonPropertyOrder(114)]
public string Forecast { get; set; }
Property Value
Type Description
string

JobEnd

The job end date (immutable)

Declaration
[JsonPropertyOrder(136)]
public DateTime? JobEnd { get; set; }
Property Value
Type Description
DateTime?

JobResult

The payrun job result

Declaration
[JsonPropertyOrder(117)]
public PayrunJobResult JobResult { get; set; }
Property Value
Type Description
PayrunJobResult

JobStart

The job start date (immutable)

Declaration
[JsonPropertyOrder(135)]
public DateTime JobStart { get; set; }
Property Value
Type Description
DateTime

JobStatus

The payrun job status (immutable)

Declaration
[JsonPropertyOrder(116)]
public PayrunJobStatus JobStatus { get; set; }
Property Value
Type Description
PayrunJobStatus

Message

The job message (immutable)

Declaration
[JsonPropertyOrder(137)]
public string Message { get; set; }
Property Value
Type Description
string

Name

The job name (immutable)

Declaration
[Required]
[StringLength(128)]
[JsonPropertyOrder(100)]
public string Name { get; set; }
Property Value
Type Description
string

Owner

The job owner (immutable)

Declaration
[JsonPropertyOrder(101)]
public string Owner { get; set; }
Property Value
Type Description
string

ParentJobId

The parent payrun job id, e.g. the parent retro pay run job (immutable)

Declaration
[JsonPropertyOrder(113)]
public int? ParentJobId { get; set; }
Property Value
Type Description
int?

PayrollId

The payroll id (immutable)

Declaration
[JsonPropertyOrder(104)]
public int PayrollId { get; set; }
Property Value
Type Description
int

PayrollName

The payroll name (client only)

Declaration
[Required]
[JsonPropertyOrder(105)]
public string PayrollName { get; set; }
Property Value
Type Description
string

PayrunId

The payrun id (immutable)

Declaration
[JsonPropertyOrder(102)]
public int PayrunId { get; set; }
Property Value
Type Description
int

PayrunName

The payrun name (client only)

Declaration
[Required]
[JsonPropertyOrder(103)]
public string PayrunName { get; set; }
Property Value
Type Description
string

PeriodEnd

The period end date (immutable)

Declaration
[Required]
[JsonPropertyOrder(124)]
public DateTime PeriodEnd { get; set; }
Property Value
Type Description
DateTime

PeriodName

The period name (immutable)

Declaration
[Required]
[JsonPropertyOrder(122)]
public string PeriodName { get; set; }
Property Value
Type Description
string

PeriodStart

The period start date (immutable)

Declaration
[Required]
[JsonPropertyOrder(123)]
public DateTime PeriodStart { get; set; }
Property Value
Type Description
DateTime

Processed

The job process date (immutable)

Declaration
[JsonPropertyOrder(127)]
public DateTime? Processed { get; set; }
Property Value
Type Description
DateTime?

ProcessedEmployeeCount

Processed employee count (immutable)

Declaration
[JsonPropertyOrder(134)]
public int ProcessedEmployeeCount { get; set; }
Property Value
Type Description
int

ProcessedReason

The process reason (immutable)

Declaration
[JsonPropertyOrder(131)]
public string ProcessedReason { get; set; }
Property Value
Type Description
string

ProcessedUserId

The processed user id (immutable)

Declaration
[JsonPropertyOrder(109)]
public int? ProcessedUserId { get; set; }
Property Value
Type Description
int?

Released

The job release date (immutable)

Declaration
[JsonPropertyOrder(126)]
public DateTime? Released { get; set; }
Property Value
Type Description
DateTime?

ReleasedReason

The release reason (immutable)

Declaration
[JsonPropertyOrder(130)]
public string ReleasedReason { get; set; }
Property Value
Type Description
string

ReleasedUserId

The release user id (immutable)

Declaration
[JsonPropertyOrder(108)]
public int? ReleasedUserId { get; set; }
Property Value
Type Description
int?

RetroPayMode

The payrun retro pay mode (immutable)

Declaration
[JsonPropertyOrder(115)]
public RetroPayMode RetroPayMode { get; set; }
Property Value
Type Description
RetroPayMode

Tags

The job tags (immutable)

Declaration
[JsonPropertyOrder(112)]
public List<string> Tags { get; set; }
Property Value
Type Description
List<string>

TotalEmployeeCount

Total employee count (immutable)

Declaration
[JsonPropertyOrder(133)]
public int TotalEmployeeCount { get; set; }
Property Value
Type Description
int

UserIdentifier

The user unique identifier (client only)

Declaration
[Required]
[JsonPropertyOrder(111)]
public string UserIdentifier { get; set; }
Property Value
Type Description
string

Methods

Equals(IPayrunJob)

Declaration
public virtual bool Equals(IPayrunJob compare)
Parameters
Type Name Description
IPayrunJob compare
Returns
Type Description
bool

GetEvaluationPeriod()

Get job time period

Declaration
public DatePeriod GetEvaluationPeriod()
Returns
Type Description
DatePeriod

Date period from the job start until the job end

GetUiString()

The object UI string

Declaration
public override string GetUiString()
Returns
Type Description
string
Overrides

ToString()

Returns a string that represents this instance

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents this instance
Overrides

Implements

Extension Methods