Interface IPayrollService

Payroll service

Inherited Members

ICrudService<IPayroll, TenantServiceContext, Query>.UpdateAsync<T>(TenantServiceContext, T)

ICreateService<IPayroll, TenantServiceContext, Query>.CreateAsync<T>(TenantServiceContext, T)

ICreateService<IPayroll, TenantServiceContext, Query>.DeleteAsync(TenantServiceContext, int)

IReadService<IPayroll, TenantServiceContext, Query>.QueryAsync<T>(TenantServiceContext, Query)

IReadService<IPayroll, TenantServiceContext, Query>.QueryCountAsync(TenantServiceContext, Query)

IReadService<IPayroll, TenantServiceContext, Query>.QueryResultAsync<T>(TenantServiceContext, Query)

IReadService<IPayroll, TenantServiceContext, Query>.GetAsync<T>(TenantServiceContext, int)

IAttributeService<TenantServiceContext>.GetAttributeAsync(TenantServiceContext, int, string)

IAttributeService<TenantServiceContext>.SetAttributeAsync(TenantServiceContext, int, string, string)

IAttributeService<TenantServiceContext>.DeleteAttributeAsync(TenantServiceContext, int, string)

Namespace: PayrollEngine.Client.Service

Assembly: PayrollEngine.Client.Core.dll

Syntax

public interface IPayrollService : ICrudService<IPayroll, TenantServiceContext, Query>, ICreateService<IPayroll, TenantServiceContext, Query>, IReadService<IPayroll, TenantServiceContext, Query>, IAttributeService<TenantServiceContext>

Methods

AddCaseAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext, TCaseChangeSetup)

Add case change

Declaration

Task<TCaseChange> AddCaseAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext context, TCaseChangeSetup caseChangeSetup) where TCaseChangeSetup : class, ICaseChangeSetup where TCaseChange : class, ICaseChange

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
TCaseChangeSetup	caseChangeSetup	The case change setup

Returns

Type	Description
Task<TCaseChange>	The created case change

Type Parameters

Name	Description
TCaseChangeSetup
TCaseChange

AddCasesBulkAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext, IEnumerable<TCaseChangeSetup>)

Bulk create case changes

Declaration

Task<int> AddCasesBulkAsync<TCaseChangeSetup, TCaseChange>(PayrollServiceContext context, IEnumerable<TCaseChangeSetup> caseChangeSetups) where TCaseChangeSetup : class, ICaseChangeSetup where TCaseChange : class, ICaseChange

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<TCaseChangeSetup>	caseChangeSetups	The case change setups

Returns

Type	Description
Task<int>	The number of created case changes

Type Parameters

Name	Description
TCaseChangeSetup
TCaseChange

BuildCaseAsync<TCaseSet>(PayrollServiceContext, string, int, int?, string, string, DateTime?, DateTime?, ICaseChangeSetup)

Build case with fields and related cases

Declaration

Task<TCaseSet> BuildCaseAsync<TCaseSet>(PayrollServiceContext context, string caseName, int userId, int? employeeId = null, string clusterSetName = null, string culture = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, ICaseChangeSetup caseChangeSetup = null) where TCaseSet : class, ICaseSet

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
string	caseName	The case name
int	userId	The user id
int?	employeeId	The employee id
string	clusterSetName	The cluster set name
string	culture	The culture
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)
ICaseChangeSetup	caseChangeSetup	The case change setup (optional)

Returns

Type	Description
Task<TCaseSet>	The created case set

Type Parameters

Name	Description
TCaseSet

GetActionsAsync<TAction>(PayrollServiceContext, IEnumerable<string>, OverrideType?, FunctionType?, DateTime?, DateTime?)

Get payroll actions

Declaration

Task<List<TAction>> GetActionsAsync<TAction>(PayrollServiceContext context, IEnumerable<string> scriptNames = null, OverrideType? overrideType = null, FunctionType? functionType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TAction : ActionInfo

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	scriptNames	The script names filter (default is all)
OverrideType?	overrideType	The override type filter (default: active)
FunctionType?	functionType	The function type (default: all)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TAction>>	Payroll actions

Type Parameters

Name	Description
TAction

GetAsync<T>(TenantServiceContext, string)

Get payroll by name

Declaration

Task<T> GetAsync<T>(TenantServiceContext context, string name) where T : class, IPayroll

Parameters

Type	Name	Description
TenantServiceContext	context	The service context
string	name	The payroll name

Returns

Type	Description
Task<T>	The payroll, null if missing

Type Parameters

Name	Description
T

GetAvailableCaseFieldValuesAsync(PayrollServiceContext, int, IEnumerable<string>, DateTime, DateTime, int?, DateTime?, DateTime?, string)

Get available case period values

Declaration

Task<List<CaseFieldValue>> GetAvailableCaseFieldValuesAsync(PayrollServiceContext context, int userId, IEnumerable<string> caseFieldNames, DateTime startDate, DateTime endDate, int? employeeId = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null)

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
int	userId	The user id
IEnumerable<string>	caseFieldNames	The case field names
DateTime	startDate	The time period start date
DateTime	endDate	The time period end date
int?	employeeId	The employee id, mandatory for employee case
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)
string	culture	The query culture name based on RFC 4646

Returns

Type	Description
Task<List<CaseFieldValue>>	Case period values

GetAvailableCasesAsync<TCase>(PayrollServiceContext, int, CaseType, IEnumerable<string>, int?, string, string, string, bool?, DateTime?, DateTime?)

Get all active and available cases

Declaration

Task<List<TCase>> GetAvailableCasesAsync<TCase>(PayrollServiceContext context, int userId, CaseType caseType, IEnumerable<string> caseNames = null, int? employeeId = null, string caseSlot = null, string clusterSetName = null, string culture = null, bool? hidden = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCase : class, ICase

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
int	userId	The user id
CaseType	caseType	The case type
IEnumerable<string>	caseNames	The case names (default: all)
int?	employeeId	The employee id
string	caseSlot	The case slot
string	clusterSetName	The cluster set name
string	culture	The culture
bool?	hidden	Hidden cases (default: all)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TCase>>	Available derived cases

Type Parameters

Name	Description
TCase

GetCaseFieldsAsync<TCaseField>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Get payroll case fields

Declaration

Task<List<TCaseField>> GetCaseFieldsAsync<TCaseField>(PayrollServiceContext context, IEnumerable<string> caseFieldNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCaseField : class, ICaseField

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	caseFieldNames	The case field names (default: all)
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TCaseField>>	Payroll case fields

Type Parameters

Name	Description
TCaseField

GetCaseRelationsAsync<TCaseRelation>(PayrollServiceContext, string, string, OverrideType?, DateTime?, DateTime?)

Get payroll case relations

Declaration

Task<List<TCaseRelation>> GetCaseRelationsAsync<TCaseRelation>(PayrollServiceContext context, string sourceCaseName = null, string targetCaseName = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCaseRelation : class, ICaseRelation

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
string	sourceCaseName	The relation source case name (default: all)
string	targetCaseName	The relation target case name (default: all)
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TCaseRelation>>	Payroll case relations

Type Parameters

Name	Description
TCaseRelation

GetCaseTimeValuesAsync(PayrollServiceContext, CaseType, int?, IEnumerable<string>, DateTime?, DateTime?, DateTime?)

Get payroll case values from a specific time moment

Declaration

Task<List<CaseValue>> GetCaseTimeValuesAsync(PayrollServiceContext context, CaseType caseType, int? employeeId = null, IEnumerable<string> caseFieldNames = null, DateTime? valueDate = null, DateTime? regulationDate = null, DateTime? evaluationDate = null)

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
CaseType	caseType	The case type
int?	employeeId	The employee id
IEnumerable<string>	caseFieldNames	The case field names
DateTime?	valueDate	The moment of the value (default: UTC now)
DateTime?	regulationDate	The regulation date (default: value date)
DateTime?	evaluationDate	The evaluation date (default: value date)

Returns

Type	Description
Task<List<CaseValue>>	The payroll case value of the case field

GetCaseValuesAsync(PayrollServiceContext, DateTime, DateTime, IEnumerable<string>, int?, DateTime?, DateTime?, string)

Get raw case values by date range and case field name

Declaration

Task<List<CaseFieldValue>> GetCaseValuesAsync(PayrollServiceContext context, DateTime startDate, DateTime endDate, IEnumerable<string> caseFieldNames, int? employeeId = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string caseSlot = null)

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
DateTime	startDate	The time period start date
DateTime	endDate	The time period end date
IEnumerable<string>	caseFieldNames	The case field names
int?	employeeId	The employee id
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	The evaluation date (default: UTC now)
string	caseSlot	The case slot

Returns

Type	Description
Task<List<CaseFieldValue>>	The case value periods

GetCasesAsync<TCase>(PayrollServiceContext, CaseType?, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Get payroll cases

Declaration

Task<List<TCase>> GetCasesAsync<TCase>(PayrollServiceContext context, CaseType? caseType = null, IEnumerable<string> caseNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCase : class, ICase

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
CaseType?	caseType	The case type (default: all)
IEnumerable<string>	caseNames	The case names
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TCase>>	Payroll cases

Type Parameters

Name	Description
TCase

GetCollectorsAsync<TCollector>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Get payroll collectors

Declaration

Task<List<TCollector>> GetCollectorsAsync<TCollector>(PayrollServiceContext context, IEnumerable<string> collectorNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TCollector : class, ICollector

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	collectorNames	The collector names filter (Default is all)
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TCollector>>	Payroll collectors

Type Parameters

Name	Description
TCollector

GetLookupDataAsync<TLookupData>(PayrollServiceContext, IEnumerable<string>, DateTime?, DateTime?, string)

Get payroll lookup data

Declaration

Task<List<TLookupData>> GetLookupDataAsync<TLookupData>(PayrollServiceContext context, IEnumerable<string> lookupNames, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null) where TLookupData : class, ILookupData

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	lookupNames	The lookup names
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	The evaluation date (default: UTC now)
string	culture	The content culture

Returns

Type	Description
Task<List<TLookupData>>	The lookup data

Type Parameters

Name	Description
TLookupData

GetLookupRangesAsync(PayrollServiceContext, IEnumerable<string>, decimal?, DateTime?, DateTime?, string)

Get payroll lookup range brackets

Declaration

Task<List<LookupRangeResult>> GetLookupRangesAsync(PayrollServiceContext context, IEnumerable<string> lookupNames, decimal? rangeValue = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null)

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	lookupNames	The lookup names (case-insensitive)
decimal?	rangeValue	Optional value to find matching bracket(s)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	The evaluation date (default: UTC now)
string	culture	The content culture

Returns

Type	Description
Task<List<LookupRangeResult>>	The lookup range results

GetLookupValueDataAsync(PayrollServiceContext, string, string, decimal?, DateTime?, DateTime?, string)

Get payroll lookup value data

Declaration

Task<LookupValueData> GetLookupValueDataAsync(PayrollServiceContext context, string lookupName, string lookupKey = null, decimal? rangeValue = null, DateTime? regulationDate = null, DateTime? evaluationDate = null, string culture = null)

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
string	lookupName	The lookup name
string	lookupKey	The lookup key, optionally with range value
decimal?	rangeValue	The lookup range value
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	The evaluation date (default: UTC now)
string	culture	The culture

Returns

Type	Description
Task<LookupValueData>	The lookup value data

GetLookupValuesAsync<TLookupValue>(PayrollServiceContext, IEnumerable<string>, IEnumerable<string>, DateTime?, DateTime?)

Get payroll lookup values

Declaration

Task<List<TLookupValue>> GetLookupValuesAsync<TLookupValue>(PayrollServiceContext context, IEnumerable<string> lookupNames = null, IEnumerable<string> lookupKeys = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TLookupValue : class, ILookupValue

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	lookupNames	The lookup names filter (default is all)
IEnumerable<string>	lookupKeys	The lookup-value key filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TLookupValue>>	Payroll lookup values

Type Parameters

Name	Description
TLookupValue

GetLookupsAsync<TLookup>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Get payroll lookups

Declaration

Task<List<TLookup>> GetLookupsAsync<TLookup>(PayrollServiceContext context, IEnumerable<string> lookupNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TLookup : class, ILookup

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	lookupNames	The lookup names filter (default is all)
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TLookup>>	Payroll lookups

Type Parameters

Name	Description
TLookup

GetRegulationsAsync<T>(PayrollServiceContext, DateTime?, DateTime?)

Get payroll regulations

Declaration

Task<List<T>> GetRegulationsAsync<T>(PayrollServiceContext context, DateTime? regulationDate = null, DateTime? evaluationDate = null) where T : class, IRegulation

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<T>>	The payroll regulations, including the shared regulations

Type Parameters

Name	Description
T

GetReportParametersAsync<TReportParameter>(PayrollServiceContext, IEnumerable<string>, DateTime?, DateTime?)

Get payroll report parameters

Declaration

Task<List<TReportParameter>> GetReportParametersAsync<TReportParameter>(PayrollServiceContext context, IEnumerable<string> reportNames = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TReportParameter : class, IReportParameter

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	reportNames	The report names
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	The evaluation date (default: UTC now)

Returns

Type	Description
Task<List<TReportParameter>>	Payroll report parameters

Type Parameters

Name	Description
TReportParameter

GetReportTemplatesAsync<TReportTemplate>(PayrollServiceContext, IEnumerable<string>, string, DateTime?, DateTime?)

Get payroll report templates

Declaration

Task<List<TReportTemplate>> GetReportTemplatesAsync<TReportTemplate>(PayrollServiceContext context, IEnumerable<string> reportNames = null, string culture = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TReportTemplate : class, IReportTemplate

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	reportNames	The report names
string	culture	The report culture
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	The evaluation date (default: UTC now)

Returns

Type	Description
Task<List<TReportTemplate>>	Payroll report templates

Type Parameters

Name	Description
TReportTemplate

GetReportsAsync<TReportSet>(PayrollServiceContext, IEnumerable<string>, OverrideType?, UserType?, DateTime?, DateTime?)

Get payroll report sets

Declaration

Task<List<TReportSet>> GetReportsAsync<TReportSet>(PayrollServiceContext context, IEnumerable<string> reportNames = null, OverrideType? overrideType = null, UserType? userType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TReportSet : class, IReportSet

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	reportNames	The report names filter (default is all)
OverrideType?	overrideType	The override type filter (default: active)
UserType?	userType	The user type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TReportSet>>	Payroll report sets

Type Parameters

Name	Description
TReportSet

GetScriptsAsync<TScript>(PayrollServiceContext, IEnumerable<string>, OverrideType?, DateTime?, DateTime?)

Get payroll scripts

Declaration

Task<List<TScript>> GetScriptsAsync<TScript>(PayrollServiceContext context, IEnumerable<string> scriptNames = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TScript : class, IScript

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<string>	scriptNames	The script names filter (default is all)
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TScript>>	Payroll scripts

Type Parameters

Name	Description
TScript

GetWageTypesAsync<TWageType>(PayrollServiceContext, IEnumerable<decimal>, OverrideType?, DateTime?, DateTime?)

Get payroll wage types

Declaration

Task<List<TWageType>> GetWageTypesAsync<TWageType>(PayrollServiceContext context, IEnumerable<decimal> wageTypeNumbers = null, OverrideType? overrideType = null, DateTime? regulationDate = null, DateTime? evaluationDate = null) where TWageType : class, IWageType

Parameters

Type	Name	Description
PayrollServiceContext	context	The service context
IEnumerable<decimal>	wageTypeNumbers	The wage type numbers (default: all)
OverrideType?	overrideType	The override type filter (default: active)
DateTime?	regulationDate	The regulation date (default: UTC now)
DateTime?	evaluationDate	Creation date filter (default: UTC now)

Returns

Type	Description
Task<List<TWageType>>	Payroll wage types

Type Parameters

Name	Description
TWageType

Extension Methods

ConsoleExtensions.WriteProperties(object, bool)

ValueTypeExtensions.GetValueType(object)

ObjectInfo.GetPropertyValue(object, string)

ObjectInfo.GetPropertyValue<T>(object, string, T)

ObjectInfo.ResolvePropertyValue(object, string)

ObjectInfo.SetPropertyValue(object, string, object)