Nxsys API Documentation
Introduction
Nxsys API Documentation
Base URL and Environments
Handling Errors
Pagination
Best Practices
Authentication
Overview
Step 1: Create a Client Application
Step 2: Obtain Authorization Code
Step 3: Exchange your Authorization Code for an Access Token
Step 4: Refresh your Access Token
APIs
Authentication
Get url to connect Nxsys system
Get access token
Candidates
Create Candidate
Get Candidates
Update Candidate
Get Candidate by ID
Candidates Ireland
ClientCandidatesIrelandController_createIrelandCandidate
Get Candidates
Update Candidate
Get Candidate by ID
VAT Codes
Get list default VAT Code
PaymentRate
Create new Payment Rate
OpenAPIPaymentRateController_findAllPaymentRates
OpenAPIPaymentRateController_findPaymentRateById
Update Payment Rate
Timesheet
Create timesheets
OpenAPITimesheetController_findAllTimeSheet
OpenAPITimesheetController_findTimeSheetById
OpenAPITimesheetController_editTimeSheetById
Payslips
Get list payslips (v2)
Documents
Create document on Employee profile
Get list of documents for Employee
Get document by id
Update document
Delete document
Payslips
Get Payslips (v1 — legacy shape)
Schemas
Schemas
AgencyCreateDto
PensionSettingDTO
GeneralSettingDTO
BankSettingDTO
OpeningBalanceDTO
PayrollSettingDTO
CreateCandidateDTO
GeneralSettingUpdateDTO
PayrollSettingUpdateDTO
UpdateCandidateDTO
IrelandGeneralSettingDTO
IrelandBankSettingDTO
IrelandPayrollSettingDTO
CreateIrelandCandidateDTO
UpdateIrelandGeneralSettingDTO
UpdateIrelandBankSettingDTO
UpdateIrelandPayrollSettingDTO
UpdateIrelandCandidateDTO
PayslipCandidateDto
PayslipCompanyDto
PayslipAmountsDto
PayslipEarningDto
PayslipLineDto
UkPayeStatutoryDto
PayslipHolidayAccrualDto
UkEmployerCostsDto
UkPayeYtdDto
UkPayeBreakdownDto
IrelandPayeYtdDto
IrelandPayeBreakdownDto
CisBreakdownDto
PayslipBreakdownDto
PayslipAgencyDto
PartnerPayslipDto
PartnerPayslipListResponseDto
PaymentRateCreateDto
PaymentRateEditDto
OpenAPIRateTimeSheet
OpenAPITimeSheetCreateDto
OpenAPITimeSheetEditDto
OpenAPIDocumentCreateDto
OpenAPIDocumentEditDto
PayslipEarningDto
{
"rateCode"
:
"PR100"
,
"description"
:
"Standard Rate"
,
"rate"
:
12.21
,
"units"
:
40
,
"amount"
:
488.4
}