⚖️Vats
This page provides a description of the available API routes for managing VAT rates.
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 Vat
class.
API methods
Get VATs
GET
http://{server-address}/vats
Returns all VATs that matches query parameters. Result is of type QueryResult<Vat>
.
Query Parameters
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
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}
Result is of type Vat.
Path Parameters
category*
int
Unique VAT category.
Headers
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
}
Create VAT
POST
http://{server-address}/vats
Creates new VAT. Result is of type Vat.
Required rights
Authorized user must have VatCreate
right assigned.
Headers
Authorization*
string
Authorization header with authorization token.
Request Body
(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}
Updates existing or creates new VAT. Result is of type Vat.
Required rights
Authorized user must have assigned VatCreate
or VatUpdate
right.
Path Parameters
category*
int
Unique VAT category.
Headers
Authorization*
string
Authorization header with authorization token.
Request Body
(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
Authorized user must have VatDelete
right assigned.
Path Parameters
category*
int
Unique VAT category.
Headers
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
}
Last updated
Was this helpful?