Nxsys API Documentation
  1. PaymentRate
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
    • Candidates Ireland
      • Create Candidate
      • Get Candidates
      • Update Candidate
      • Get Candidate by ID
    • VAT Codes
      • Get list default VAT Code
    • PaymentRate
      • Create new Payment Rate
        POST
      • OpenAPIPaymentRateController_findAllPaymentRates
        GET
      • OpenAPIPaymentRateController_findPaymentRateById
        GET
      • Update Payment Rate
        PUT
    • Timesheet
      • Create timesheets
      • OpenAPITimesheetController_findAllTimeSheet
      • OpenAPITimesheetController_findTimeSheetById
      • OpenAPITimesheetController_editTimeSheetById
    • Payslips
      • Get Payslips
  1. PaymentRate

OpenAPIPaymentRateController_findPaymentRateById

Nxsys Umbrella - Production
https://api.nxsys.tech
Nxsys Umbrella - Production
https://api.nxsys.tech
GET
https://api.nxsys.tech
/nxsys/payment-rate/{id}

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Responses

🟢200OK
application/json
Request successful
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.nxsys.tech/nxsys/payment-rate/' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Example 1
{
    "data": {
        "id": "PR-1",
        "incrementId": 1,
        "description": "Standard Hourly Rate",
        "displayOnPayslip": true,
        "status": "ACTIVE",
        "code": "PR001",
        "type": "FIXED",
        "units": "HOURLY",
        "hoursPerUnit": "20",
        "includeInCisCalculation": true,
        "includeNICalculation": true,
        "includeTaxCalculation": true,
        "includePensionCalculation": true,
        "includeAccrueHolidayPay": true,
        "raiseInvoice": true,
        "includeInPayeUmbrellaCalculation": true,
        "isStatutory": null,
        "author": "USRP-2",
        "createdAt": "2025-03-19T07:01:07.573Z",
        "updatedAt": "2025-03-19T14:01:07.573Z",
        "defaultVATCode": {
            "id": "VC-1",
            "incrementId": 1,
            "description": "Standard",
            "VATRate": "20%",
            "VATCode": "S",
            "author": null,
            "createdAt": "2024-07-18T07:40:28.638Z",
            "updatedAt": "2025-03-07T15:11:21.545Z",
            "deletedAt": null
        }
    },
    "success": true
}
Previous
OpenAPIPaymentRateController_findAllPaymentRates
Next
Update Payment Rate
Built with