Get Payslips

Nxsys Umbrella - Production

https://api.nxsys.tech

GET

/nxsys/payslips

Retrieve a paginated list of payslips for candidates. Supports filtering by tax year, tax period, pay frequency, payment model, and candidate IDs. Returns payslip details for each candidate.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.nxsys.tech/nxsys/payslips?page&size' \
--header 'Authorization;'

Response Example

200 - Example 1

{
    "items": [
        {
            "id": "PL-1181439",
            "incrementId": 181483,
            "taxPeriod": 52,
            "taxYear": 2025,
            "agencyName": null,
            "subcontractorName": "Alice Walton",
            "timesheetValue": "6666.67",
            "margin": 0,
            "gross": "6651.67",
            "materials": "0.00",
            "vat": "0.00",
            "net": "4746.97",
            "cisStatus": "0%",
            "cisDeduction": "0.00",
            "otherDeduction": 0,
            "otherPayment": 0,
            "payments": [],
            "totalPayment": 0,
            "payeeUmbrellaValue": {},
            "irelandValue": {},
            "invoiceNos": [],
            "paymentDate": "2025-03-28T00:00:00.000Z",
            "expenseClaimed": 0,
            "studentLoan": 0,
            "postgraduateLoan": 0,
            "holidayPaid": 0,
            "paymentModel": "PAYEE",
            "payFrequency": "MONTHLY",
            "paid": 4746.97,
            "outstanding": 0,
            "selfBillRef": {},
            "companyRef": {},
            "subcontractorRef": {},
            "timeSheets": [],
            "needSubmitRevertedFPS": false,
            "salary": 6666.67,
            "displayedTaxablePay": 6666.67,
            "additionalVoluntaryContribution": 0,
            "totalPensionContribution": 0,
            "retainedHolidayPay": 0,
            "rolledUpHolidayPay": null,
            "avcEEPension": 0,
            "avcERPension": 0,
            "mainEEPension": 0,
            "mainERPension": 0,
            "isConfirmedPaymentMade": true,
            "epsData": {}
        },
        {
            "id": "PL-1181650",
            "incrementId": 181694,
            "taxPeriod": 2,
            "taxYear": 2025,
            "agencyName": "Cool & Cool",
            "subcontractorName": "John Smith",
            "timesheetValue": "635.60",
            "margin": "17.50",
            "gross": "618.10",
            "materials": "0.00",
            "vat": "0.00",
            "net": "419.71",
            "cisStatus": "0%",
            "cisDeduction": "0.00",
            "otherDeduction": 0,
            "otherPayment": 0,
            "payments": [],
            "totalPayment": 0,
            "payeeUmbrellaValue": {},
            "irelandValue": {},
            "invoiceNos": [],
            "paymentDate": "2025-04-17T00:00:00.000Z",
            "expenseClaimed": 0,
            "studentLoan": 0,
            "postgraduateLoan": 0,
            "holidayPaid": 0,
            "paymentModel": "UMBRELLA",
            "payFrequency": "WEEKLY",
            "paid": 419.71,
            "outstanding": 0,
            "selfBillRef": {},
            "companyRef": {},
            "subcontractorRef": {},
            "timeSheets": [],
            "needSubmitRevertedFPS": false,
            "salary": 488.40000000000003,
            "displayedTaxablePay": 488.64,
            "additionalVoluntaryContribution": 0,
            "totalPensionContribution": 0,
            "retainedHolidayPay": 58.978848,
            "rolledUpHolidayPay": null,
            "avcEEPension": 0,
            "avcERPension": 0,
            "mainEEPension": 0,
            "mainERPension": 0,
            "isConfirmedPaymentMade": true,
            "epsData": {}
        }
    ],
    "meta": {
        "totalItems": 56,
        "itemCount": 2,
        "itemsPerPage": 2,
        "totalPages": 28,
        "currentPage": 1
    }
}

Request

Authorization

Add parameter in header

Authorization

Example:

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

Query Params

Responses

🟢200OK

application/json

Request successful

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Update Timesheet