Nxsys API Documentation
  1. VAT Codes
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
      • Construct the Authorization URL
      • Exchange your Authorization Code for an Access Token
    • Candidates
      • Create Candidate
      • Get Candidates
      • Update Candidate
    • VAT Codes
      • Get Default VAT Codes
        GET
    • PaymentRate
      • Create Payment Rate
      • Get Payment Rates
      • Get Single Payment Rate
      • Update Payment Rate
    • Timesheet
      • Create Timesheet
      • Get Timesheets
      • Get Single Timesheet
      • Update Timesheet
    • Payslips
      • Get Payslips
  1. VAT Codes

Get Default VAT Codes

Nxsys Umbrella - Production
https://api.nxsys.tech
Nxsys Umbrella - Production
https://api.nxsys.tech
GET
https://api.nxsys.tech
/nxsys/vat-code
Retrieve a list of default VAT codes available. Supports pagination, filtering, and sorting. Returns an array of VAT code objects with their details.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.nxsys.tech/nxsys/vat-code' \
--header 'Authorization;'
Response Response Example
200 - Example 1
{
    "data": [
        {
            "id": "VC-2",
            "incrementId": 1,
            "description": "Standard",
            "VATRate": "20%",
            "VATCode": "S",
            "author": null,
            "companyParentId": "45c66746-1224-4dc9-aa70-9935dff52d60",
            "createdAt": "2021-05-19T04:00:21.250Z",
            "updatedAt": "2025-07-10T10:38:46.262Z",
            "deletedAt": null
        },
        {
            "id": "VC-3",
            "incrementId": 2,
            "description": "Exempt",
            "VATRate": "0%",
            "VATCode": "X",
            "author": null,
            "companyParentId": "45c66746-1224-4dc9-aa70-9935dff52d60",
            "createdAt": "2021-05-19T04:00:21.250Z",
            "updatedAt": "2025-07-10T10:38:46.262Z",
            "deletedAt": null
        },
        {
            "id": "VC-4",
            "incrementId": 3,
            "description": "No VAT",
            "VATRate": "0%",
            "VATCode": "NV",
            "author": null,
            "companyParentId": "45c66746-1224-4dc9-aa70-9935dff52d60",
            "createdAt": "2021-05-19T04:00:21.250Z",
            "updatedAt": "2025-07-10T10:38:46.262Z",
            "deletedAt": null
        },
        {
            "id": "VC-5",
            "incrementId": 4,
            "description": "Zero Rated",
            "VATRate": "0%",
            "VATCode": "Z",
            "author": null,
            "companyParentId": "45c66746-1224-4dc9-aa70-9935dff52d60",
            "createdAt": "2021-05-19T04:00:21.250Z",
            "updatedAt": "2025-07-10T10:38:46.262Z",
            "deletedAt": null
        },
        {
            "id": "VC-6",
            "incrementId": 5,
            "description": "Export to EU",
            "VATRate": "20%",
            "VATCode": "N",
            "author": null,
            "companyParentId": "45c66746-1224-4dc9-aa70-9935dff52d60",
            "createdAt": "2021-05-19T04:00:21.250Z",
            "updatedAt": "2025-07-10T10:38:46.262Z",
            "deletedAt": null
        },
        {
            "id": "VC-7",
            "incrementId": 6,
            "description": "Out of Scope",
            "VATRate": "0%",
            "VATCode": "OS",
            "author": null,
            "companyParentId": "45c66746-1224-4dc9-aa70-9935dff52d60",
            "createdAt": "2021-05-19T04:00:21.250Z",
            "updatedAt": "2025-07-10T10:38:46.262Z",
            "deletedAt": null
        }
    ],
    "totalDocs": 6,
    "success": true
}

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Query Params

Responses

🟢200OK
application/json
Request successful
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Previous
Update Candidate
Next
Create Payment Rate
Built with