Update Timesheet

Nxsys Umbrella - Production

https://api.nxsys.tech

PUT

/nxsys/time-sheets/{id}

Updates an existing timesheet by its unique ID. Returns the updated timesheet object. Fails if the timesheet is not found or cannot be updated.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.nxsys.tech/nxsys/time-sheets/' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "rates": [
        {
            "rateId": "PR-6",
            "rate": 10,
            "units": 10,
            "vatID": "VC-2"
        }
    ]
}'

Response Example

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

Request

Authorization

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Request successful

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Get Single Timesheet

Get Payslips