Interface IPayrunJobInvocation
The payrun job client object
Inherited Members
Namespace: PayrollEngine.Client.Model
Assembly: PayrollEngine.Client.Core.dll
Syntax
public interface IPayrunJobInvocation : IEquatable<IPayrunJobInvocation>
Properties
Attributes
Payrun job attributes
Declaration
Dictionary<string, object> Attributes { get; set; }
Property Value
| Type | Description |
|---|---|
| Dictionary<string, object> |
EmployeeIdentifiers
The payrun employee identifiers
Declaration
List<string> EmployeeIdentifiers { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> |
EvaluationDate
The evaluation date (immutable)
Declaration
DateTime? EvaluationDate { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? |
Forecast
The forecast name (immutable)
Declaration
string Forecast { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
JobResult
The payrun job result
Declaration
PayrunJobResult JobResult { get; set; }
Property Value
| Type | Description |
|---|---|
| PayrunJobResult |
JobStatus
The target payrun job status
Declaration
PayrunJobStatus JobStatus { get; set; }
Property Value
| Type | Description |
|---|---|
| PayrunJobStatus |
LogLevel
The function log level, default is information
Declaration
LogLevel LogLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| LogLevel |
Name
The job name (immutable)
Declaration
string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Owner
The job owner (immutable)
Declaration
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
int? ParentJobId { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
PayrunJobId
The payrun job id (immutable)
Declaration
int? PayrunJobId { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
PayrunName
The payrun name (immutable)
Declaration
string PayrunName { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
PeriodStart
The period start date (immutable)
Declaration
DateTime PeriodStart { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Reason
The execution reason (immutable)
Declaration
string Reason { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
RetroJobs
The retro payrun jobs, requires the ParentJobId (immutable)
Declaration
List<RetroPayrunJob> RetroJobs { get; set; }
Property Value
| Type | Description |
|---|---|
| List<RetroPayrunJob> |
RetroPayMode
The payrun retro pay mode (immutable)
Declaration
RetroPayMode RetroPayMode { get; set; }
Property Value
| Type | Description |
|---|---|
| RetroPayMode |
StoreEmptyResults
Store empty employee results (default: false)
Declaration
bool StoreEmptyResults { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Tags
The job tags (immutable)
Declaration
List<string> Tags { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> |
UserIdentifier
The user identifier (immutable)
Declaration
string UserIdentifier { get; set; }
Property Value
| Type | Description |
|---|---|
| string |