This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /quantity-declarations/{quantityDeclarationId}
Get Quantity Declarations
Description
Returns Quantity Declarations
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| quantityDeclarationId | required | Target QuantityDeclaration. |
Responses
200
successful operation
Response content 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
{
"properties": {
"required": [
"name",
"unit"
],
"properties": {
"id": {
"description": "Id of the QuantityDeclaration record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"name": {
"description": "Name of the quantity declaration. Only used for internal purposes. Never shown on documents",
"type": "string",
"format": "string",
"example": "Weight of packaging"
},
"ref": {
"description": "Alphanumeric reference code to be used for the quantity declaration. If set it must be unique.",
"type": "string",
"format": "string",
"example": "A string"
},
"calculation_base": {
"description": "On what basis the calculation should take place",
"type": "string",
"format": "string",
"enum": [
"purchased",
"invoiced"
],
"example": "invoiced"
},
"country": {
"description": "ISO 3166-1 alpha-2 Country Code that this QUD is limited to",
"type": "string",
"format": "string",
"example": "DK"
},
"unit": {
"description": "The unit to used when the calculation is set to *per_unit*",
"type": "string",
"format": "string",
"enum": [
"μg",
"mg",
"g",
"kg",
"ml",
"l",
"pcs"
],
"example": "pcs"
},
"component": {
"description": "Component class",
"type": "string",
"format": "string",
"enum": [
"alcohol",
"packaging",
"soy",
"palm_oil",
"other"
],
"example": "alcohol"
},
"as_service_line": {
"description": "Boolean indicating if the quantity declaration should be added as both a budget and a service line",
"type": "boolean",
"format": "boolean",
"example": true
},
"service_id": {
"description": "Service that should be used when this quantity declaration is applied as a service line",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"tag_ids": {
"description": "Tag ids related to the QuantityDeclaration entity. \nNotice that these will only be included if *tags* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"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"
},
"type": "object"
}
406
not acceptable
500
internal server error
PUT /quantity-declarations/{quantityDeclarationId}
Update existing Quantity Declaration
Description
Update the specified resource in storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| quantityDeclarationId | required | Target QuantityDeclaration. |
Request body
Description
Target QuantityDeclaration.
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
{
"required": [
"name",
"unit"
],
"properties": {
"id": {
"description": "Id of the QuantityDeclaration record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"name": {
"description": "Name of the quantity declaration. Only used for internal purposes. Never shown on documents",
"type": "string",
"format": "string",
"example": "Weight of packaging"
},
"ref": {
"description": "Alphanumeric reference code to be used for the quantity declaration. If set it must be unique.",
"type": "string",
"format": "string",
"example": "A string"
},
"calculation_base": {
"description": "On what basis the calculation should take place",
"type": "string",
"format": "string",
"enum": [
"purchased",
"invoiced"
],
"example": "invoiced"
},
"country": {
"description": "ISO 3166-1 alpha-2 Country Code that this QUD is limited to",
"type": "string",
"format": "string",
"example": "DK"
},
"unit": {
"description": "The unit to used when the calculation is set to *per_unit*",
"type": "string",
"format": "string",
"enum": [
"μg",
"mg",
"g",
"kg",
"ml",
"l",
"pcs"
],
"example": "pcs"
},
"component": {
"description": "Component class",
"type": "string",
"format": "string",
"enum": [
"alcohol",
"packaging",
"soy",
"palm_oil",
"other"
],
"example": "alcohol"
},
"as_service_line": {
"description": "Boolean indicating if the quantity declaration should be added as both a budget and a service line",
"type": "boolean",
"format": "boolean",
"example": true
},
"service_id": {
"description": "Service that should be used when this quantity declaration is applied as a service line",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"tag_ids": {
"description": "Tag ids related to the QuantityDeclaration entity. \nNotice that these will only be included if *tags* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"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
200
successful operation
Response content 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
{
"properties": {
"required": [
"name",
"unit"
],
"properties": {
"id": {
"description": "Id of the QuantityDeclaration record",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"name": {
"description": "Name of the quantity declaration. Only used for internal purposes. Never shown on documents",
"type": "string",
"format": "string",
"example": "Weight of packaging"
},
"ref": {
"description": "Alphanumeric reference code to be used for the quantity declaration. If set it must be unique.",
"type": "string",
"format": "string",
"example": "A string"
},
"calculation_base": {
"description": "On what basis the calculation should take place",
"type": "string",
"format": "string",
"enum": [
"purchased",
"invoiced"
],
"example": "invoiced"
},
"country": {
"description": "ISO 3166-1 alpha-2 Country Code that this QUD is limited to",
"type": "string",
"format": "string",
"example": "DK"
},
"unit": {
"description": "The unit to used when the calculation is set to *per_unit*",
"type": "string",
"format": "string",
"enum": [
"μg",
"mg",
"g",
"kg",
"ml",
"l",
"pcs"
],
"example": "pcs"
},
"component": {
"description": "Component class",
"type": "string",
"format": "string",
"enum": [
"alcohol",
"packaging",
"soy",
"palm_oil",
"other"
],
"example": "alcohol"
},
"as_service_line": {
"description": "Boolean indicating if the quantity declaration should be added as both a budget and a service line",
"type": "boolean",
"format": "boolean",
"example": true
},
"service_id": {
"description": "Service that should be used when this quantity declaration is applied as a service line",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"active": {
"description": "Boolean indicating if the record is active and could be referenced from other entities",
"type": "boolean",
"format": "boolean",
"example": true
},
"tag_ids": {
"description": "Tag ids related to the QuantityDeclaration entity. \nNotice that these will only be included if *tags* are included in the include parameter",
"type": "array",
"items": {
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
}
},
"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"
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
500
Internal server error
DELETE /quantity-declarations/{quantityDeclarationId}
Delete Quantity Declarations
Description
Remove the specified resource from storage.
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| quantityDeclarationId | required | Target QuantityDeclaration. |
Responses
204
The quantityDeclaration was deleted
403
Unauthorized request
406
not acceptable
500
Internal server error