PApayroll-engine
Payrolls

GET /api/tenants/{tenantId}/payrolls/{payrollId}/actions

Changed on

Request

Path parameters

tenantIdinteger required
payrollIdinteger required

Query parameters

evaluationDatestring date-time
functionType'CaseAvailable' | 'CaseBuild' | 'CaseValidate' | 'CaseChange' | 'Case' | 'CaseRelationBuild' | 'CaseRelationValidate' | 'CaseRelation' | 'CollectorStart' | 'CollectorApply' | 'CollectorEnd' | 'Collector' | 'WageTypeValue' | 'WageTypeResult' | 'WageType' | 'PayrunStart' | 'PayrunEmployeeAvailable' | 'PayrunEmployeeStart' | 'PayrunEmployeeEnd' | 'PayrunWageTypeAvailable' | 'PayrunEnd' | 'PayrunBase' | 'Payrun' | 'Payroll' | 'ReportBuild' | 'ReportStart' | 'ReportEnd' | 'Report' | 'All'
overrideType'Active' | 'Inactive'
regulationDatestring date-time
scriptNamesstring[]

Response

OK

namestring required
functionType'CaseAvailable' | 'CaseBuild' | 'CaseValidate' | 'CaseChange' | 'Case' | 'CaseRelationBuild' | 'CaseRelationValidate' | 'CaseRelation' | 'CollectorStart' | 'CollectorApply' | 'CollectorEnd' | 'Collector' | 'WageTypeValue' | 'WageTypeResult' | 'WageType' | 'PayrunStart' | 'PayrunEmployeeAvailable' | 'PayrunEmployeeStart' | 'PayrunEmployeeEnd' | 'PayrunWageTypeAvailable' | 'PayrunEnd' | 'PayrunBase' | 'Payrun' | 'Payroll' | 'ReportBuild' | 'ReportStart' | 'ReportEnd' | 'Report' | 'All'
namespacestring nullable
descriptionstring nullable
categoriesstring[] nullable
source'Script' | 'System'

Changes

  • e70510c47700Revision changes
    • warning

      added the new PayrunBase enum value to the / response property for the response status

    • info

      added the new enum value PayrunBase to the query request parameter functionType

  • fd1b5146be4aRevision changes
    • breaking

      removed the enum value PayrunBase from the query request parameter functionType

    • info

      removed the PayrunBase enum value from the / response property for the response status