Payroll API Overview

Prev Next

Files

Softera.Payroll API documentation's postman collection:

Collection:
Softera Payroll API v1.05.postman_collection.json
Environment:
Softera Payroll API v1.03.postman_environment.json
Replace 4 variables in postman environment:

  1. [TENANTID] - GUID of microsoft tenant
  2. [ENVIRONMENTNAME] - BC environment name
  3. [CLIENTID] - app registration GUID from Azure
  4. [CLIENTSECRET] - app registration secret from Azure

Other constants:
{{sprAPIVersion}} - v1.0

Collection > Authorization > press "Get New Access Token"
Run GET {{url}}/softera/softeraPayroll/{{sprAPIVersion}}/schemaversion=2.0 - this should return full Payroll API metadata

Detailed tutorial how to create Client Id, Secret and use postman to connect to Business Central.

Info

Processes descriptions like employment, termination, position change and other are inside Postman collection documentation.

Processes

Hire employee (Minimum) New
Hire employee (Minimum) Old
Terminate employee
Change Contract Type
Change Allocation Position or Other Fields New
Change Allocation Position or Other Fields Old
Fill Work Schedule Entries
Fill Time Sheet Entries (Without Deep Insert)
Fill Time Sheet Entries (With Deep Insert)
Get Employee Vacation Balance

List of APIs

Personel

sprEmployees
sprEmplPersonalInformations
sprContracts
sprAllocations
sprAllocationSalaries
sprPaymentLocations
sprRelatives
sprRelativesHistory
sprVacationBalances

Time

sprAbsenceEntries
sprWorkScheduleEntries
sprTimeSheetJournals
sprTimeSheetJournalLines

Amounts

sprAmountsJournals
sprAmountsJournalLines
sprAmountsEntries
sprPaymentFiles

Setup

sprEmployeePostingGroups
sprGroundsForTermination
sprMaritalStatuses
sprNationalities
sprPositions
sprBanks
sprActivityCodes
sprWorkScheduleFormulas
sprBusinessTripLocations
sprBusinessTripAims
sprEDCodes
sprEmplPortalSetup

Other

sprIntegrationExchanges
sprVacationBalancesApprox
sprDimensionSetLines

Useful links