Interface IPayrollConsolidatedResultService
Payroll consolidated result service
Namespace: PayrollEngine.Client.Service
Assembly: PayrollEngine.Client.Core.dll
Syntax
public interface IPayrollConsolidatedResultService
Methods
GetCollectorResultsAsync<TCollectorResult>(TenantServiceContext, int, int, IEnumerable<DateTime>, int?, IEnumerable<string>, string, PayrunJobStatus, IEnumerable<string>, DateTime?)
Get consolidated collector results
Declaration
Task<List<TCollectorResult>> GetCollectorResultsAsync<TCollectorResult>(TenantServiceContext context, int payrunId, int employeeId, IEnumerable<DateTime> periodStarts, int? divisionId, IEnumerable<string> collectorNames, string forecast, PayrunJobStatus jobStatus, IEnumerable<string> tags, DateTime? evaluationDate) where TCollectorResult : class, ICollectorResult
Parameters
| Type | Name | Description |
|---|---|---|
| TenantServiceContext | context | The service context |
| int | payrunId | The payrun id |
| int | employeeId | The employee id |
| IEnumerable<DateTime> | periodStarts | Period start dates |
| int? | divisionId | The division id |
| IEnumerable<string> | collectorNames | The collector names |
| string | forecast | The forecast name |
| PayrunJobStatus | jobStatus | The payrun job status |
| IEnumerable<string> | tags | The result tags |
| DateTime? | evaluationDate | The evaluation date (default: UTC now) |
Returns
| Type | Description |
|---|---|
| Task<List<TCollectorResult>> | The period collector results |
Type Parameters
| Name | Description |
|---|---|
| TCollectorResult |
QueryPayrollResultAsync<TConsolidatedPayrollResult>(TenantServiceContext, int, int, DateTime, int?, string, PayrunJobStatus, IEnumerable<string>)
Query consolidated collector results
Declaration
Task<TConsolidatedPayrollResult> QueryPayrollResultAsync<TConsolidatedPayrollResult>(TenantServiceContext context, int payrunId, int employeeId, DateTime periodStart, int? divisionId, string forecast, PayrunJobStatus jobStatus, IEnumerable<string> tags) where TConsolidatedPayrollResult : class, IConsolidatedPayrollResult
Parameters
| Type | Name | Description |
|---|---|---|
| TenantServiceContext | context | The service context |
| int | payrunId | The payrun id |
| int | employeeId | The employee id |
| DateTime | periodStart | Period start date |
| int? | divisionId | The division id |
| string | forecast | The forecast name |
| PayrunJobStatus | jobStatus | The payrun job status |
| IEnumerable<string> | tags | The result tags |
Returns
| Type | Description |
|---|---|
| Task<TConsolidatedPayrollResult> | The period collector results |
Type Parameters
| Name | Description |
|---|---|
| TConsolidatedPayrollResult |
QueryPayrunResultsAsync<TPayrunResult>(TenantServiceContext, int, int, IEnumerable<DateTime>, int?, IEnumerable<string>, string, PayrunJobStatus, IEnumerable<string>, DateTime?)
Query consolidated payrun results
Declaration
Task<List<TPayrunResult>> QueryPayrunResultsAsync<TPayrunResult>(TenantServiceContext context, int payrunId, int employeeId, IEnumerable<DateTime> periodStarts, int? divisionId, IEnumerable<string> names, string forecast, PayrunJobStatus jobStatus, IEnumerable<string> tags, DateTime? evaluationDate) where TPayrunResult : class, IPayrunResult
Parameters
| Type | Name | Description |
|---|---|---|
| TenantServiceContext | context | The service context |
| int | payrunId | The payrun id |
| int | employeeId | The employee id |
| IEnumerable<DateTime> | periodStarts | Period start dates |
| int? | divisionId | The division id |
| IEnumerable<string> | names | The result names |
| string | forecast | The forecast name |
| PayrunJobStatus | jobStatus | The payrun job status |
| IEnumerable<string> | tags | The result tags |
| DateTime? | evaluationDate | The evaluation date (default: UTC now) |
Returns
| Type | Description |
|---|---|
| Task<List<TPayrunResult>> | The period payrun results |
Type Parameters
| Name | Description |
|---|---|
| TPayrunResult |
QueryWageTypeResultsAsync<TWageTypeResult>(TenantServiceContext, int, int, IEnumerable<DateTime>, int?, IEnumerable<decimal>, string, PayrunJobStatus, IEnumerable<string>, DateTime?)
Query consolidated wage type results
Declaration
Task<List<TWageTypeResult>> QueryWageTypeResultsAsync<TWageTypeResult>(TenantServiceContext context, int payrunId, int employeeId, IEnumerable<DateTime> periodStarts, int? divisionId, IEnumerable<decimal> wageTypeNumbers, string forecast, PayrunJobStatus jobStatus, IEnumerable<string> tags, DateTime? evaluationDate) where TWageTypeResult : class, IWageTypeResult
Parameters
| Type | Name | Description |
|---|---|---|
| TenantServiceContext | context | The service context |
| int | payrunId | The payrun id |
| int | employeeId | The employee id |
| IEnumerable<DateTime> | periodStarts | Period start dates |
| int? | divisionId | The division id |
| IEnumerable<decimal> | wageTypeNumbers | The wage type numbers |
| string | forecast | The forecast name |
| PayrunJobStatus | jobStatus | The payrun job status |
| IEnumerable<string> | tags | The result tags |
| DateTime? | evaluationDate | The evaluation date (default: UTC now) |
Returns
| Type | Description |
|---|---|
| Task<List<TWageTypeResult>> | The period wage type results |
Type Parameters
| Name | Description |
|---|---|
| TWageTypeResult |