1. Introduction
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)
      GET
  • 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
  1. Introduction

Base URL and Environments

The Nxsys Payroll and Nxsys Umbrella platforms each provide dedicated APIs, available in two distinct environments: Testing and Production. These environments are designed to support different stages of development, integration, and live operations. This section outlines the base URLs for API and authorization requests for both systems across their respective environments.

Nxsys Umbrella Platform#

Nxsys Umbrella - Testing Environment
Nxsys Umbrella - Production Enviroment

API Base URL#

All API requests for the Nxsys Umbrella Platform should use the following base URL:
https://staging-api.nxsys.tech
This URL provides access to the full suite of Nxsys API endpoints.

Authorization Base URL#

All authorization requests for the Nxsys API should be directed to the following base URL:
https://staging.nxsys.tech
This endpoint serves as the entry point for authentication workflows.

Nxsys Payroll Platform#

Nxsys Payroll - Testing Environment
Nxsys Payroll - Production Enviroment

API Base URL#

All API requests for the Nxsys Payroll Platfrom should use the following base URL:
https://staging-api.nxsys.tech
This URL provides access to the full suite of Nxsys API endpoints.

Authorization Base URL#

All authorization requests for the Nxsys API should be directed to the following base URL:
https://bureau-stg.nxsys.tech
This endpoint serves as the entry point for authentication workflows.
Previous
Nxsys API Documentation
Next
Handling Errors
Built with