PORTOS Developers
  • πŸ‘‹Introduction
  • πŸ“–Glossary
  • HTTP Status codes
  • Error models
  • Error codes
  • Validation constraints
  • Resource names
  • πŸ”’User rights
  • Device environments
  • 🌍Localization
  • πŸ”NData query syntax
  • OpenAPI specification
  • Data models
  • Authentication
    • πŸ”Authentication schemes
      • JWT Bearer Authentication
      • HMAC Authentication
  • ⚑Notifications
    • SignalR
    • Webhooks
  • API reference
    • πŸ”‘API keys
    • πŸ›οΈArticle categories
    • πŸ’ΌCompanies
    • πŸ’±Currencies
    • πŸ‘«Customers
    • πŸ“ˆDaily sales reports
    • πŸ–₯️Devices
    • πŸ–¨οΈFiscals
    • ❀️Health check
    • πŸ“ƒLicense
    • 🎚️Modifiers
    • πŸ‘¨β€πŸ³Order endpoints
    • πŸ›ŽοΈOrders
    • πŸͺ™Payment types
    • β˜•Plus
    • πŸ”Roles
    • πŸ”Sessions
    • βš™οΈSettings
    • πŸ”ŽStock takings
    • πŸ”’Stock transfer numbering
    • 🚚Stock transfers
    • πŸ“¦Stocks
    • 🧾Tickets
      • Ticket Model States
      • Ticket Operations and User Rights
      • Ticket Model Mathematics
    • πŸ‘¨β€πŸ’ΌUsers
    • βš–οΈVats
    • πŸͺ‘Zones
  • 3rd Party Integrations
    • Introduction
    • Online orders API
    • Rewards API
    • PDA Files
  • Previous versions
    • Migration to V4.1
    • Migration to V4
    • Legacy documentation
Powered by GitBook
On this page
  • API methods
  • Get VATs
  • Get VAT by category
  • Create VAT
  • Create or update VAT
  • Delete VAT by category

Was this helpful?

  1. API reference

Vats

This page provides a description of the available API routes for managing VAT rates.

PreviousUsersNextZones

Last updated 5 months ago

Was this helpful?

Each VAT rate is identified by its numeric category identifier and associated VAT rate with value between 0 and 100. The VAT data model is represented by class.

API methods

Get VATs

GET http://{server-address}/vats

Returns all VATs that matches query parameters. Result is of type .

Query Parameters

Name
Type
Description

category

decimal

Supports NData syntax.

rate

decimal

Supports NData syntax.

$skip

int

Pagination property. Describing number of records to skip from beginning of result collection.

$take

int

Pagination property. Maximum count of items to be returned.

$sort

string[]

Comma separated list of property names. Please see NData syntax.

$count

bool

If set to true, response will not contain items collection. Use to get resource count, not the resources themselves.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "items":
    [
        {
            "category": 1,
            "rate": 20.0,
            "plannedRateChange":
            {
                "effectiveFrom": "2024-12-31T23:00:00Z",
                "rate": 23.0
            },
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 2,
            "rate": 10.0,
            "plannedRateChange":
            {
                "effectiveFrom": "2024-12-31T23:00:00Z",
                "rate": 5.0
            },
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 3,
            "rate": 0.0,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 4,
            "rate": 0.0,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 5,
            "rate": 0.0,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 6,
            "rate": 10.0,
            "plannedRateChange":
            {
                "effectiveFrom": "2024-12-31T23:00:00Z",
                "rate": 19.0
            },
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 7,
            "rate": 0.0,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 8,
            "rate": 0.0,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 9,
            "rate": 0.0,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        },
        {
            "category": 10,
            "rate": null,
            "plannedRateChange": null,
            "lastModifiedAt": null,
            "_v": 1
        }
    ],
    "count": 5,
    "totalCount": 5
}

Get VAT by category

GET http://{server-address}/vats/{category}

Path Parameters

Name
Type
Description

category*

int

Unique VAT category.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "category": 1,
    "rate": 20.0,
    "plannedRateChange":
    {
        "effectiveFrom": "2024-12-31T23:00:00Z",
        "rate": 23.0
    },
    "lastModifiedAt": null,
    "_v": 1
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Create VAT

POST http://{server-address}/vats

Required rights

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

Request Body

Name
Type
Description

(body)*

VAT

VAT model to create

{
    "category": 1,
    "rate": 20.0,
    "plannedRateChange":
    {
        "effectiveFrom": "2024-12-31T23:00:00Z",
        "rate": 23.0
    },
    "lastModifiedAt": null,
    "_v": 1
}

Create or update VAT

PUT http://{server-address}/vats/{category}

Required rights

Path Parameters

Name
Type
Description

category*

int

Unique VAT category.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

Request Body

Name
Type
Description

(body)*

VAT

VAT model to create or update.

{
    "category": 1,
    "rate": 20.0,
    "plannedRateChange":
    {
        "effectiveFrom": "2024-12-31T23:00:00Z",
        "rate": 23.0
    },
    "lastModifiedAt": null,
    "_v": 2
}

Delete VAT by category

DELETE http://{server-address}/vats/{category}

Required rights

Path Parameters

Name
Type
Description

category*

int

Unique VAT category.

Headers

Name
Type
Description

Authorization*

string

Authorization header with authorization token.

{
    "category": 1,
    "rate": 20.0,
    "plannedRateChange":
    {
        "effectiveFrom": "2024-12-31T23:00:00Z",
        "rate": 23.0
    },
    "lastModifiedAt": null,
    "_v": 2
}
{
    "title": "Zdroj nebol nΓ‘jdenΓ½",
    "status": 404
}

Result is of type .

Creates new VAT. Result is of type .

Authorized user must have VatCreate assigned.

Updates existing or creates new VAT. Result is of type .

Authorized user must have assigned VatCreate or VatUpdate .

Authorized user must have VatDelete assigned.

βš–οΈ
right
right
right
Vat
QueryResult<Vat>
Vat
Vat
Vat