OpenAPIPaymentRateController_findAllPaymentRates

Nxsys Umbrella - Production

https://api.nxsys.tech

GET

/nxsys/payment-rate

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Query Params

Responses

🟢200OK

application/json

Request successful

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.nxsys.tech/nxsys/payment-rate?sortType&sortField&raiseInvoice&isStatutory&ignoreCodes&code&page&size&search' \
--header 'Authorization: <api-key>'

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
            }
        }
    ],
    "totalDocs": 1,
    "success": true
}

Create new Payment Rate

OpenAPIPaymentRateController_findPaymentRateById