This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /invoices/{invoiceId}/lines-extract
Get summarised extract of lines on invoice
Description
Returns summarised extract of lines on invoice
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| invoiceId | required | Target orderInvoice. |
Parameters (query)
| Name | Required | Description | Values |
|---|---|---|---|
| include | optional | The resources that can be included in this request, delimited by a comma: sku, lot, delivery_lot, order, order_lot, order_service_line |
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
{
"properties": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"calculation": {
"description": "The calculation method used for the invoice line",
"type": "string",
"format": "string",
"example": "A string"
},
"category": {
"description": "Category of the line. Primarily used with the service lines",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_edi_unit": {
"description": "EDI unit code preferred by the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_line_number": {
"description": "Customer line number from sales order",
"format": "",
"example": ""
},
"customer_order_ean": {
"description": "The ean number used by the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_partner_id": {
"description": "Id of customer partner of the customer on the order. Not the invoice to partner of the invoice!",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"customer_location_id": {
"description": "Id of customer location of the customer on the order. Not the invoice to location of the invoice!",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"deliver_to_location_id": {
"description": "The id of the deliver to location. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"deliver_to_partner_id": {
"description": "The id of the deliver to partner. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"delivery_date": {
"description": "The delivery date. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"delivery_id": {
"description": "Id of the delivery",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"delivery_lot_id": {
"description": "Id of the lot line on the actual delivery",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"delivery_number": {
"description": "Number of the delivery",
"type": "integer",
"format": "int32",
"example": 1234
},
"delivery_term_incoterm": {
"description": "Incoterm on the delivery",
"type": "string",
"format": "string",
"example": "A string"
},
"delivery_term_text": {
"description": "Delivery term text",
"type": "string",
"format": "string",
"example": "A string"
},
"forwarder_location_id": {
"description": "The id of the forwarder location. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"forwarder_partner_id": {
"description": "The id of the forwarder partner. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"free_units": {
"description": "Number of free units given on this invoice line",
"type": "integer",
"format": "int32",
"example": 1234
},
"line_text": {
"description": "Line text",
"type": "string",
"format": "string",
"example": "A string"
},
"line_total": {
"description": "Line total excluding VAT",
"type": "number",
"format": "double",
"example": 1234.123
},
"line_vat_amount": {
"description": "Total VAT amount",
"type": "number",
"format": "double",
"example": 1234.123
},
"line_vat_rates": {
"description": "VAT rates",
"type": "string",
"format": "string",
"example": "A string"
},
"line_vat_texts": {
"description": "VAT texts",
"type": "string",
"format": "string",
"example": "A string"
},
"lot_id": {
"description": "Id of the lot",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_id": {
"description": "Id of the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_lot_id": {
"description": "Id of the lot line on the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_marking": {
"description": "Marking on the order",
"type": "string",
"format": "string",
"example": "A string"
},
"order_number": {
"description": "Number of the order",
"type": "integer",
"format": "int32",
"example": 1234
},
"order_service_line_id": {
"description": "Id of the service line",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_type": {
"description": "The order type invoiced",
"type": "string",
"format": "string",
"example": "A string"
},
"pickup_from_location_id": {
"description": "The id of the pickup from location. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"pickup_from_partner_id": {
"description": "The id of the pickup from partner. For lot lines this is taken from the actual delivery, for service lines this is taken\nfrom the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"quantity": {
"description": "Quantity in the *base_unit*",
"type": "number",
"format": "double",
"example": 1234.123
},
"quantity_parcels": {
"description": "Quantity of parcels",
"type": "integer",
"format": "int32",
"example": 1234
},
"base_unit": {
"description": "Unit used for quantity",
"type": "string",
"format": "string",
"example": "A string"
},
"quantity_uom": {
"description": "UoMs in the unit of measure of the SKU",
"type": "number",
"format": "double",
"example": 1234.123
},
"service_id": {
"description": "Id of the related service for service lines",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"customer_code_name": {
"description": "The code name taken from the sku partner relation linked to the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_edi_unit_code": {
"description": "The EDI unit code taken from the sku partner relation linked to the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_sku_ean": {
"description": "The order EAN taken from the sku partner relation linked to the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_req_days_expiry": {
"description": "Required days until expiry taken from the sku partner relation linked to the customer",
"type": "integer",
"format": "int32",
"example": 1234
},
"customer_sku_code": {
"description": "Customer SKU code from the sku partner relation linked to the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"customer_sku_code_uom": {
"description": "Customer SKU code of the UoM from the sku partner relation linked to the customer",
"type": "string",
"format": "string",
"example": "A string"
},
"sku_id": {
"description": "Id of the SKU",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"source": {
"description": "Source",
"type": "string",
"format": "string",
"example": "A string"
},
"unit_price": {
"description": "Unit price in invoice currency",
"type": "number",
"format": "double",
"example": 1234.123
},
"uom_conversion": {
"description": "The conversion between one *base_unit* and one *UoM*",
"type": "number",
"format": "double",
"example": 1234.123
},
"uoms_per_price_unit": {
"description": "The number of uoms used for one price unit",
"type": "number",
"format": "double",
"example": 1234.123
},
"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