Nxsys API Documentation
  1. Timesheet
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
      • OpenAPIPaymentRateController_findAllPaymentRates
      • OpenAPIPaymentRateController_findPaymentRateById
      • Update Payment Rate
    • Timesheet
      • Create timesheets
        POST
      • OpenAPITimesheetController_findAllTimeSheet
        GET
      • OpenAPITimesheetController_findTimeSheetById
        GET
      • OpenAPITimesheetController_editTimeSheetById
        PUT
    • Payslips
      • Get Payslips
  1. Timesheet

OpenAPITimesheetController_findAllTimeSheet

Nxsys Umbrella - Production
https://api.nxsys.tech
Nxsys Umbrella - Production
https://api.nxsys.tech
GET
https://api.nxsys.tech
/nxsys/time-sheets

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Query 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/time-sheets?page&size&search&payFrequency&paymentModel&bactchTo&bactchFrom&sortType=desc&sortField=id&isCurrentTaxPeriod&taxPeriodTo&taxPeriodFrom&monthConfig&taxPeriod&taxYear&endDate&startDate&approveStatus&invoiceStatus=&timesheetId=' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "invoicingAddress": {
                "address": [
                    "Address 1",
                    "Address 2",
                    "Address 3"
                ],
                "city": "Agency City",
                "county": "Bristan",
                "postCode": "EH21 6UU",
                "country": "GB"
            },
            "companyRef": {
                "id": "COM-1"
            },
            "workLocation": {},
            "siteId": null,
            "rates": [
                {
                    "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
                    }
                }
            ],
            "subcontractorRef": {
                "id": "SR-1"
            },
            "agencyRef": {
                "id": "AY-1"
            },
            "monthConfig": 12,
            "taxYear": 2024,
            "author": "USRP-2",
            "startDate": null,
            "endDate": null,
            "taxPeriod": 52,
            "taxPeriodConfig": 50,
            "currentYear": "2025",
            "approveStatus": "APPROVED",
            "invoiceStatus": "AWAITING_INVOICING",
            "employment": {
                "id": 462
            },
            "isIncludeCIS": false,
            "timesheetApprovalNeeded": "FALSE",
            "totalNet": 100,
            "totalPrices": 120,
            "totalVat": 20,
            "totalInvoiceNet": 100,
            "totalInvoicePrices": 120,
            "totalInvoiceVat": 20,
            "receipt": 0,
            "outstanding": 120,
            "outstandingInvoice": 120,
            "holidayPaid": 0,
            "isIssueP45": false,
            "invoiceNo": "",
            "creditNo": "",
            "raiseInvoice": true,
            "isOnlyHPRate": false,
            "isOnlyStatutory": false,
            "employmentId": 462,
            "idNo": 14248,
            "updatedAt": "2025-03-20T17:38:35.894Z",
            "payrollBreakdownId": null,
            "s3Url": null,
            "id": "TS-1",
            "incrementId": 1,
            "isInvoice": false,
            "createdAt": "2025-03-20T10:38:35.894Z",
            "deletedAt": null,
            "isProcessingGenerateInvoice": false
        }
    ],
    "totalDocs": 1,
    "success": true
}
Previous
Create timesheets
Next
OpenAPITimesheetController_findTimeSheetById
Built with