/
IN
intect
/
Intect REST API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 18h ago · Updated 18h ago
Details
Filter operations
AbsenceInterval
6
Account
20
Audit
7
Auth
19
Backend
2
Balances
24
Companies
27
CompanyCars
5
CompanyUsers
15
CustomValues
10
DimensionValues
5
Employments
25
EmploymentTemplates
30
Expense
13
Formulae
9
Holidays
6
Import
8
ImportMapping
15
Insights
22
Integrations
43
Miscellaneous
14
Modules
4
PaymentPlanRecipient
6
Preferences
4
Reports
10
SalaryBatches
30
get
Retrieves a list of all payroll batches in the currently active company. Note that this method has the side-effect of recalculating all open draft batches with pending changes, so response time can sometimes be longer than usual.
put
Updates an existing payroll batch. Only the Message, PayoutDate and PayoutAllFlex/PayoutNewFlex properties can be modified. NOTE: This re-runs validation logic on the batch but does not recalculate it.
post
Creates and calculates a new payroll batch for the specified salary period, optionally as a preview-only operation.
patch
Updates an existing payroll batch. Only the Message, PayoutDate and PayoutAllFlex/PayoutNewFlex properties can be modified. NOTE: This re-runs validation logic on the batch but does not recalculate it.
get
Retrieves a list of all non-finalized payroll batches in the currently active company.
get
Retrieves details about a single payroll batch, including all its records and salary statements.
delete
Deletes a payroll batch.
get
Retrieves a list of E-Income response lines for the specified payroll batch. Note that this request is only relevant for finalized payroll batches.
get
Retrieves a list of validation warnings and errors for the specified payroll batch. Note that this request is only relevant for non-finalized payroll batches.
get
Retrieves a sum of amounts by salary type for the specified payroll batch.
get
Retrieves a sum of amounts by employee for the specified salary type within the specified payroll batch.
get
Retrieves a sum of relevant units (time entries, vacation days etc.) for the specified payroll batch.
get
Retrieves a sum of relevant unit totals (time entries, vacation days etc.) by employee for the specified payroll batch and category.
put
Fully recalculates a payroll batch, deleting all existing batch records and re-fetching employee salary records.
put
Prepares a batch for finalization by fully recalculating it, checking that it does not contain validation errors, and setting a temporary StatusId of 35, "Being finalized". This status will automatically revert after 30 minutes if the batch has not been finalized in the meantime. The function requires the permission salarybatch.canfinalize
put
Recalculates a single employment within an existing payroll batch. This is possible even for batches that are awaiting approval (NOT finalized ones). Use this when you know that only one employee's data has been changed and do not wish to recalculate the entire batch.
put
Recalculates all open draft payroll batches in the currently active company. NOTE: This method only recalculates employees that have been updated since the last recalculation.
post
Approves a payroll batch, locking it for editing. This prevents re-calculation but does not finalize the batch. Employees are notified and given access to preliminary payslips.
post
Approves a payroll batch, locking it for editing. This prevents re-calculation but does not finalize the batch. (Another way to think of it is submitting the batch for final approval). Employees are NOT notified nor given access to preliminary paylips - to enable this, call the /withpreliminarypayslips route instead.
post
Reverts all approval/locking of the payroll batch, resetting it to draft status and allowing it to be recalculated.
post
Finalizes a payroll batch. Note that you must first call the /preparefinalize route and submit the GUID you receive back from that request. The function requires the permission salarybatch.canfinalize
post
Reverts a finalized payroll batch, setting its status to Cancelled.
post
Rejects approval of a payroll batch, optionally specifying a reason. This moves the batch back to draft status.
post
Resends a payroll batch to E-Income. Dispatch and response are usually processed within 5-10 minutes. This will also clear the error status of the batch.
post
Sends or resends a payroll batch to the general ledger of the company's ERP system. Requires an active integration with a supported system.
post
Re-sends a payroll batch to the configured external system.
delete
Clears E-Income error and warning status for the specified payroll batch. Use this when errors have been resolved manually. The actual error data will not be deleted.
get
Retrieves a list of accounting records for the specified payroll batch, to be imported into the general ledger of an external ERP system. This method returns the totals with no grouping.
get
Retrieves a list of accounting records for the specified payroll batch, to be imported into the general ledger of an external ERP system. This method returns the totals grouped by department.
get
Retrieves a list of accounting records for the specified payroll batch, to be imported into the general ledger of an external ERP system. This method returns the totals grouped by employee - notice that this may expose sensitive data.
SalaryCycles
14
SalaryLedgers
6
SalaryRecords
14
SalaryStatements
22
SalaryTypes
21
Startuptasks
4
StaticData
156
TimeEntry
19
TimeEntryTypes
19
Users
18
SalaryBatches
Deletes a payroll batch.
delete
/api/salarybatches/{batchId}
Path parameters
batchId
integer
required
The ID of the batch to delete.
Response
OK
SystemWebHttpResultsOkResult
required
Request
object
Changes