IPayRunService1

Operations

NameSignatureDescription
CancelPayRunvoid CancelPayRun(PayRunTargetParameter1 target)Mark a draft pay run as cancelled and release its payable items
CreatePayrollDataBatchUri CreatePayrollDataBatch(Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression)Create a batch to return all rows of data for the selected columns, sort and filter expression same as for GetData, use BatchManagement services to start and monitor the batch
CreatePayrollDownloadBatchUri CreatePayrollDownloadBatch(Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression, Uri fileFormatScriptUri)Create a batch to generate a payroll download file
CreatePayrollRowCountsBatchUri CreatePayrollRowCountsBatch(FilterExpression1[] filterExpressions, Uri[] columnUris)Create a batch that calculates the number of rows that are expected to be available, for a given set of filter expressions and the columns. A filter expression can be 'null' to represent a complete row count without filtering. The result is not guaranteed to be accurate; approximations may be used when large numbers of records are available.
CreatePayrollTotalsBatchUri CreatePayrollTotalsBatch(FilterExpression1 filterExpression, Uri[] columnUris)Creates a batch that calculates per-column totals over the range of data. "filterExpression" is used to exclude some data rows from the calculation, and can be null; "columnUris" is an array of column Uri to total. A data row is returned; for columns that cannot be aggregated (eg. text columns like "Name"), a data cell of null type is expected.
CreatePayRunPayRunReference1 CreatePayRun(FilterExpression1 filterExpression, Uri[] columnUris, String unitOfWorkId)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreatePayRunBatch. Generate a pay run and add all of the payable time that matches the filters
CreatePayRunBatchUri CreatePayRunBatch(Uri[] columnUris, FilterExpression1 filterExpression)Create a batch to create a pay run based on the filters and columns selected, use BatchManagement services to start and monitor the batch
DeletePayRunvoid DeletePayRun(PayRunTargetParameter1 target)Delete a pay run
DisablePayrollMetadataColumnvoid DisablePayrollMetadataColumn(PayrollMetadataColumnTargetParameter1 target)Disable a metadata column so to make it unavailable for list service
EnablePayrollMetadataColumnvoid EnablePayrollMetadataColumn(PayrollMetadataColumnTargetParameter1 target)Enable a metadata column so to make it available for list service
GetActivePayrollMetadataColumnsPayrollMetadataColumnReference1[] GetActivePayrollMetadataColumns()Get all enabled metadata columns for list service
GetAllColumnsListColumnGroup1[] GetAllColumns()Retrieves all the supported columns for the list service; this includes their display name and a URI to refer to the column.
GetAllFilterDefinitionsFilterDefinitionDetails1[] GetAllFilterDefinitions()Retrieves all the different filter definitions which can be used in filter expressions on this list service.
GetAllPayrollMetadataColumnsPayrollMetadataColumnReference1[] GetAllPayrollMetadataColumns()Get all metadata columns for list service
GetCreatePayRunBatchResultsCreatePayRunBatchResult GetCreatePayRunBatchResults(Uri payRunBatchUri)Get the results of the specified CreatePayRunBatch batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetDataListData1 GetData(Int32 page, Int32 pagesize, Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreatePayrollDataBatch. Retrieves a page of data. "page" is a one-based page count; "pagesize" is the number of records on each page; "sort" is an array of sort clauses to apply to the data, and can be null; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output.
GetPayrollDataBatchResultsPayrollDataBatchResult GetPayrollDataBatchResults(Uri payrollDataBatchUri)Get the results of the specified PayrollExportData batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetPayrollDownloadBatchResultsPayrollDownloadBatchResult1 GetPayrollDownloadBatchResults(Uri payrollDownloadBatchUri)Get the results of the specified PayrollDownload batch. Will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetPayrollMetadataColumnDetailsPayrollMetadataColumnDetails1 GetPayrollMetadataColumnDetails(PayrollMetadataColumnTargetParameter1 target)Get a single metadata column detail for list service
GetPayrollRowCountsBatchResultsPayrollRowCountsBatchResults1 GetPayrollRowCountsBatchResults(Uri payrollRowCountsBatchUri)Get the results of the specified PayrollRowCounts batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetPayrollTotalsBatchResultsPayrollTotalsBatchResults1 GetPayrollTotalsBatchResults(Uri payrollRowCountsBatchUri)Get the results of the specified PayrollTotals batch. The will return null if the batch has not completed. Use IBatchManagementService1.GetStatus to get the progress information of an existing batch
GetPayRunDetailsPayRunDetails1 GetPayRunDetails(PayRunTargetParameter1 target)Get the details of a given pay run
GetRowCountsInt32[] GetRowCounts(FilterExpression1[] filterExpressions, Uri[] columnUris)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreatePayrollRowCountsBatch. Calculates the number of rows that are expected to be available, for a given set of filter expressions and the columns. A filter expression can be 'null' to represent a complete row count without filtering. The result is not guaranteed to be accurate; approximations may be used when large numbers of records are available.
GetTotalsListDataRow1 GetTotals(FilterExpression1 filterExpression, Uri[] columnUris)NOTE: This method is prone to timing out on large datasets; it is recommended to use CreatePayrollTotalsBatch. Calculates per-column totals over the range of data. "filterExpression" is used to exclude some data rows from the calculation, and can be null; "columnUris" is an array of column Uri to total. A data row is returned; for columns that cannot be aggregated (eg. text columns like "Name"), a data cell of null type is expected.
MarkPayRunAsCompletevoid MarkPayRunAsComplete(PayRunTargetParameter1 target)Mark a draft pay run as complete
MarkPayRunAsDraftvoid MarkPayRunAsDraft(PayRunTargetParameter1 target)Mark a complete pay run as draft
PutPayrollMetadataColumnPayrollMetadataColumnReference1 PutPayrollMetadataColumn(PayrollMetadataColumnParameter1 metadataColumn)Define a metadata column for list service
SetNextPayRunNumbervoid SetNextPayRunNumber(Int32 startingPayRunNumber)Update the intitial pay run's starting number on new payruns to be an autogenerated number incremented by 1 for each new payrun, starting with the specified number
UpdatePayrollMetadataColumnNamevoid UpdatePayrollMetadataColumnName(PayrollMetadataColumnTargetParameter1 target, String name)Change the display name of metadata column
UpdatePayRunDescriptionvoid UpdatePayRunDescription(PayRunTargetParameter1 target, String description)Update the pay run's description
UpdatePayRunNamevoid UpdatePayRunName(PayRunTargetParameter1 target, String name)Update the pay run's name