Create Payment Rate

Nxsys Umbrella - Production

https://api.nxsys.tech

POST

/nxsys/payment-rate

Create a new payment rate. Returns the created payment rate object. Fails if the code already exists or the VAT code is invalid.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.nxsys.tech/nxsys/payment-rate' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "description": "Standard Hourly Rate",
    "displayOnPayslip": true,
    "status": "ACTIVE",
    "code": "PR001",
    "type": "RATE",
    "units": "DAILY",
    "hoursPerUnit": 20,
    "includeInCisCalculation": true,
    "includeNICalculation": true,
    "includeTaxCalculation": true,
    "includePensionCalculation": true,
    "includeAccrueHolidayPay": true,
    "raiseInvoice": true,
    "defaultVATCode": "VC-2",
    "includeInPayeCalculation": true
}'

Response Example

201 - 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
}

Request

Authorization

Add parameter in header

Authorization

Example:

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

Body Params application/json

Examples

Responses

🟢201Created

application/json

Request successful

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Get Default VAT Codes

Get Payment Rates