This page was automatically generated from tracezilla’s Swagger API documentation 2026-07-17

GET /vats/{vatId}

Get vat

Description

Returns vat

Parameters (path)

Name Required Description Values
vatId required Target vat.  

Parameters (query)

Name Required Description Values
include optional The resources that can be included in this request, delimited by a comma: alt_sender_partner, alt_sender_location  

Responses

200

successful operation

406

not acceptable

500

internal server error

PUT /vats/{vatId}

Update existing vat

Description

Update the specified resource in storage.

Parameters (path)

Name Required Description Values
vatId required Target vat.  

Request body

Description

Target vat.

Required

This parameter is required.

Request body JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

{
  "properties": {
    "id": {
      "description": "Id of the record",
      "type": "string",
      "format": "uuid",
      "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
    },
    "calculation_base": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account_invoice": {
      "description": "Earnings account for this VAT",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account_invoice_vat": {
      "description": "VAT account for invoiced revenue",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account_cogs": {
      "description": "COGS account for invoiced revenue",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account_expense": {
      "description": "Expense account for this VAT",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account_expense_vat": {
      "description": "VAT account for expenses revenue",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "gl_account_contra": {
      "description": "No description is available",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "locked": {
      "description": "If this VAT have been used and are locked for deletion",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "name": {
      "description": "Internal name to show in the system",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "text_on_documents": {
      "description": "Text to show on documents",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "rate": {
      "description": "Percentage tax rate",
      "type": "number",
      "format": "double",
      "example": 1234.123
    },
    "recoverable": {
      "description": "If the tax is recoverable",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "ref": {
      "description": "Reference code of this VAT",
      "type": "string",
      "format": "string",
      "example": "A string"
    },
    "vat_reporting_only": {
      "description": "No description is available",
      "type": "boolean",
      "format": "boolean",
      "example": true
    },
    "weight": {
      "description": "The weighted order in which this VAT should apply",
      "format": "",
      "example": ""
    },
    "created_at": {
      "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2019-01-01T13:25:32.312Z"
    },
    "updated_at": {
      "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T13:25:32.312Z"
    }
  },
  "type": "object"
}

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error

DELETE /vats/{vatId}

Delete vat

Description

Remove the specified resource from storage.

Parameters (path)

Name Required Description Values
vatId required Target vat.  

Responses

403

Unauthorized request

406

not acceptable

500

Internal server error