Get Payment Rates

Nxsys Umbrella - Production

https://api.nxsys.tech

GET

/nxsys/payment-rate

Retrieve a paginated list of payment rates with optional filters and sorting. Returns an array of payment rate objects.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.nxsys.tech/nxsys/payment-rate' \
--header 'Authorization;'

Response Example

200 - Example 1

{
    "data": [
        {
            "id": "PR-1914",
            "incrementId": 1914,
            "description": "Commission",
            "displayOnPayslip": true,
            "status": "ACTIVE",
            "code": "PRCOMS",
            "type": "RATE",
            "units": "MONTHLY",
            "hoursPerUnit": "1",
            "includeInCisCalculation": false,
            "includeNICalculation": true,
            "includeTaxCalculation": true,
            "includePensionCalculation": true,
            "includeAccrueHolidayPay": false,
            "raiseInvoice": true,
            "includeInPayeUmbrellaCalculation": true,
            "isStatutory": null,
            "companyParentId": "7fb1ac20-3fed-456c-aa93-46f534b41317",
            "author": "USRP-159863",
            "createdAt": "2025-07-02T07:25:21.949Z",
            "updatedAt": "2025-07-02T07:25:21.949Z",
            "includeInPayeCalculation": true,
            "taxCanBeDeducted": true,
            "employeePRSICanBeDeducted": true,
            "employerPRSICanBeDeducted": true,
            "uscCanBeDeducted": true,
            "ascCanBeDeducted": true,
            "pensionSchemaDeductionCanBeDeducted": true,
            "lptCanBeDeducted": true,
            "repetition": null,
            "defaultVATCode": {
                "id": "VC-2",
                "incrementId": 1,
                "description": "Standard",
                "VATRate": "20%",
                "VATCode": "S",
                "author": null,
                "companyParentId": "7fb1ac20-3fed-456c-aa93-46f534b41317",
                "createdAt": "2021-05-19T04:00:21.250Z",
                "updatedAt": "2025-07-10T13:33:28.093Z",
                "deletedAt": null
            }
        },
        {
            "id": "PR-25",
            "incrementId": 24,
            "description": "Salary",
            "displayOnPayslip": true,
            "status": "ACTIVE",
            "code": "PR100",
            "type": "RATE",
            "units": "HOURLY",
            "hoursPerUnit": null,
            "includeInCisCalculation": true,
            "includeNICalculation": true,
            "includeTaxCalculation": true,
            "includePensionCalculation": true,
            "includeAccrueHolidayPay": true,
            "raiseInvoice": true,
            "includeInPayeUmbrellaCalculation": true,
            "isStatutory": false,
            "companyParentId": "7fb1ac20-3fed-456c-aa93-46f534b41317",
            "author": "USR435",
            "createdAt": "2021-06-03T12:06:52.908Z",
            "updatedAt": "2025-05-28T12:50:57.970Z",
            "includeInPayeCalculation": true,
            "taxCanBeDeducted": null,
            "employeePRSICanBeDeducted": null,
            "employerPRSICanBeDeducted": null,
            "uscCanBeDeducted": null,
            "ascCanBeDeducted": null,
            "pensionSchemaDeductionCanBeDeducted": null,
            "lptCanBeDeducted": null,
            "repetition": null,
            "defaultVATCode": {
                "id": "VC-2",
                "incrementId": 1,
                "description": "Standard",
                "VATRate": "20%",
                "VATCode": "S",
                "author": null,
                "companyParentId": "7fb1ac20-3fed-456c-aa93-46f534b41317",
                "createdAt": "2021-05-19T04:00:21.250Z",
                "updatedAt": "2025-07-10T13:33:28.093Z",
                "deletedAt": null
            }
        }
    ],
    "totalDocs": 37,
    "success": true
}

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Responses

🟢200OK

application/json

Request successful

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Create Payment Rate

Get Single Payment Rate