This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26
GET /invoices/{invoiceId}
Get orderInvoice
Description
Returns orderInvoice resource
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: customer, customer_location, contact, order, credit_note, credit_note_for, last_sent_by, remark, lot_lines, service_lines, lines_extract, cogs_actual_total, cogs_budget_total, payment_method | Â |
Responses
200
successful operation
406
not acceptable
500
internal server error
PUT /invoices/{invoiceId}
Update existing orderInvoice
Parameters (path)
| Name | Required | Description | Values |
|---|---|---|---|
| invoiceId | required | Target Order Invoice. | Â |
Request body
Description
Data to store.
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
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
317
318
319
320
321
{
"required": [
"order_id",
"currency",
"customer_id",
"customer_location_id",
"exchange_rate",
"delivery_selection",
"invoice_date",
"payment_date",
"payment_term_method",
"payment_term_text",
"payment_term_days"
],
"properties": {
"id": {
"description": "Id of the invoice",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"contact_id": {
"description": "Id of the partner contact to be used on the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"created_by_id": {
"description": "Id of the user that created the order",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"credit_note_id": {
"description": "Id of full credit not if any",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"currency": {
"description": "ISO 4217 Currency Codes 3 letter currency code. This field is required if the *order_id* field has been omitted.",
"type": "string",
"format": "string",
"example": "DKK"
},
"customer_country": {
"description": "Country of the customer. Used for VAT rules",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"customer_id": {
"description": "Reference to the partner of the customer. This must be set if the *order_id* has not been set. Will create a collected invoice of all orders pending invoice for the selected customer.\nNotice that you will also have to set the currency attribute.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"customer_location_id": {
"description": "Reference to the partner location of the customer. Will need to be set if *order_id* has been omitted.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"delivery_selection": {
"description": "How delivery should be handled when creating the invoice. (Uninvoiced service lines will always be invoiced)\n- *deliver_order*: Deliver everything on the order and invoice everything uninvoiced.\n- *delivered*: Only invoice uninvoiced lot lines that have been delivered.\n- *all*: Invoice everything uninvoiced on the delivery, regardless of the delivery status. Do not deliver.",
"type": "string",
"format": "string",
"enum": [
"deliver_order",
"delivered",
"all"
],
"example": "A string"
},
"credit_reason": {
"description": "Credit reason GS1",
"type": "string",
"format": "string",
"enum": [
"108",
"140",
"141",
"79E",
"Z01",
"Z02",
"Z03",
"Z04"
],
"example": "108"
},
"exchange_rate": {
"description": "The exchange rate to use for the invoice",
"type": "number",
"format": "double",
"example": 1234.123
},
"ext_ref": {
"description": "Customer reference",
"type": "string",
"format": "string",
"example": "A string"
},
"gl_journal_id": {
"description": "Id if gl journal",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"invoice_date": {
"description": "The invoice date",
"type": "string",
"format": "date",
"example": "2025-12-01"
},
"posting_date": {
"description": "Posting date if different from invoice date",
"type": "string",
"format": "date",
"example": "2025-12-14"
},
"last_sent_at": {
"description": "When this invoice was last sent",
"type": "string",
"format": "date-time",
"readOnly": true,
"example": "2019-01-01T13:25:32.312Z"
},
"last_sent_by_id": {
"description": "Id of the user that sent the invoice",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"last_sent_note": {
"description": "Notes related to the last send of the invoice",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"last_sent_using": {
"description": "How this invoice was last sent",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"locked": {
"description": "If the invoice is locked and cannot be deleted",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"number": {
"description": "Number of the invoice",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"ocr": {
"description": "OCR string on the invoice",
"type": "string",
"format": "string",
"example": "34"
},
"order_id": {
"description": "Id of the order to invoice. This field is required unless the *customer_id, customer_location_id and currency* fields have been set.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_type": {
"description": "Order type when doing collective invoicing. Will limit the invoicing to this specific order type",
"type": "string",
"format": "string",
"example": "sales"
},
"payment_method_id": {
"description": "Id of the partner payment method",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"payment_date": {
"description": "The due date of the invoice",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"payment_term_days": {
"description": "Days of credit",
"type": "integer",
"format": "int32",
"example": 1234
},
"payment_term_method": {
"description": "The payment term on the order\n- *days*: Days from the *delivery date* of the order (*pickup date* for *Ex Works* orders)\n- *month_days*: Days from beginning of next month\n- *week_mon_days*: Days from coming week (week starting on mondays)\n- *week_sun_days*: Days from coming week (week starting on sundays)\n- *pia*: Payment in advance - specify a due date\n- *custom*: A due date will need to be specified manualle each time an order or invoice is created",
"type": "string",
"format": "string",
"default": "custom",
"enum": [
"days",
"month_days",
"week_mon_days",
"week_sun_days",
"pia",
"custom"
],
"example": "days"
},
"payment_term_text": {
"description": "Text to use when the *payment_term_method* is set to custom",
"type": "string",
"format": "string",
"example": "A string"
},
"status": {
"description": "The status of the invoice. If different from *draft* and the invoice have not yet been booked, the invoice will be booked,",
"type": "string",
"format": "string",
"enum": [
"draft",
"pending",
"booking",
"paid",
"partially_paid",
"overpaid",
"written_off"
],
"example": "pending"
},
"remark": {
"description": "A remark for the invoice. Notice that *remark* have to be in the *include* parameter, for this data to be loaded\nwith the request",
"type": "string",
"format": "string",
"example": "A comment on the order"
},
"invoice_sub_total": {
"description": "Invoice sub total as shown on document",
"type": "number",
"format": "double",
"example": 1234.123
},
"invoice_vats_total": {
"description": "Invoice vats as shown on document",
"type": "number",
"format": "double",
"example": 1234.123
},
"invoice_total": {
"description": "Invoice total as shown on document",
"type": "number",
"format": "double",
"example": 1234.123
},
"invoice_rounding_correction": {
"description": "The rounding correction that was applied to the invoice total before rounding",
"type": "number",
"format": "double",
"example": 1234.123
},
"cogs_actual_total": {
"description": "Actual COGS calculated from expenses and overhead budgets. \ncogs_actual* need to parsed with *include* to have this in the response.\nOnly relevant if the actual cost pricing flow is used.",
"type": "number",
"format": "double",
"example": 1234.123
},
"cogs_budget_total": {
"description": "Budgetted COGS. \ncogs_budget* need to parsed with *include* to have this in the response.",
"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",
"readOnly": true,
"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",
"readOnly": true,
"example": "2020-01-01T13:25:32.312Z"
},
"send_by_email": {
"description": "If the invoice should be send by email upon creation. Will send the mail upon creation",
"type": "boolean",
"format": "boolean",
"readOnly": false,
"writeOnly": true,
"example": true
},
"send_by_edi": {
"description": "If the invoice should be send by EDI through the accounting system after creation.\nThis feature requires that your connected accounting system supports electronic invoices",
"type": "boolean",
"format": "boolean",
"readOnly": false,
"writeOnly": true,
"example": true
},
"edi_error": {
"description": "This will contain an error message if there was a problem sending the electronic invoice",
"type": "string",
"format": "string",
"readOnly": true
}
},
"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
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
{
"properties": {
"order_invoice": {
"required": [
"order_id",
"currency",
"customer_id",
"customer_location_id",
"exchange_rate",
"delivery_selection",
"invoice_date",
"payment_date",
"payment_term_method",
"payment_term_text",
"payment_term_days"
],
"properties": {
"id": {
"description": "Id of the invoice",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"contact_id": {
"description": "Id of the partner contact to be used on the order",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"created_by_id": {
"description": "Id of the user that created the order",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"credit_note_id": {
"description": "Id of full credit not if any",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"currency": {
"description": "ISO 4217 Currency Codes 3 letter currency code. This field is required if the *order_id* field has been omitted.",
"type": "string",
"format": "string",
"example": "DKK"
},
"customer_country": {
"description": "Country of the customer. Used for VAT rules",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"customer_id": {
"description": "Reference to the partner of the customer. This must be set if the *order_id* has not been set. Will create a collected invoice of all orders pending invoice for the selected customer.\nNotice that you will also have to set the currency attribute.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"customer_location_id": {
"description": "Reference to the partner location of the customer. Will need to be set if *order_id* has been omitted.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"delivery_selection": {
"description": "How delivery should be handled when creating the invoice. (Uninvoiced service lines will always be invoiced)\n- *deliver_order*: Deliver everything on the order and invoice everything uninvoiced.\n- *delivered*: Only invoice uninvoiced lot lines that have been delivered.\n- *all*: Invoice everything uninvoiced on the delivery, regardless of the delivery status. Do not deliver.",
"type": "string",
"format": "string",
"enum": [
"deliver_order",
"delivered",
"all"
],
"example": "A string"
},
"credit_reason": {
"description": "Credit reason GS1",
"type": "string",
"format": "string",
"enum": [
"108",
"140",
"141",
"79E",
"Z01",
"Z02",
"Z03",
"Z04"
],
"example": "108"
},
"exchange_rate": {
"description": "The exchange rate to use for the invoice",
"type": "number",
"format": "double",
"example": 1234.123
},
"ext_ref": {
"description": "Customer reference",
"type": "string",
"format": "string",
"example": "A string"
},
"gl_journal_id": {
"description": "Id if gl journal",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"invoice_date": {
"description": "The invoice date",
"type": "string",
"format": "date",
"example": "2025-12-01"
},
"posting_date": {
"description": "Posting date if different from invoice date",
"type": "string",
"format": "date",
"example": "2025-12-14"
},
"last_sent_at": {
"description": "When this invoice was last sent",
"type": "string",
"format": "date-time",
"readOnly": true,
"example": "2019-01-01T13:25:32.312Z"
},
"last_sent_by_id": {
"description": "Id of the user that sent the invoice",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"last_sent_note": {
"description": "Notes related to the last send of the invoice",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"last_sent_using": {
"description": "How this invoice was last sent",
"type": "string",
"format": "string",
"readOnly": true,
"example": "A string"
},
"locked": {
"description": "If the invoice is locked and cannot be deleted",
"type": "boolean",
"format": "boolean",
"readOnly": true,
"example": true
},
"number": {
"description": "Number of the invoice",
"type": "integer",
"format": "int32",
"readOnly": true,
"example": 1234
},
"ocr": {
"description": "OCR string on the invoice",
"type": "string",
"format": "string",
"example": "34"
},
"order_id": {
"description": "Id of the order to invoice. This field is required unless the *customer_id, customer_location_id and currency* fields have been set.",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"order_type": {
"description": "Order type when doing collective invoicing. Will limit the invoicing to this specific order type",
"type": "string",
"format": "string",
"example": "sales"
},
"payment_method_id": {
"description": "Id of the partner payment method",
"type": "string",
"format": "uuid",
"readOnly": true,
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"payment_date": {
"description": "The due date of the invoice",
"type": "string",
"format": "date",
"example": "2019-01-01"
},
"payment_term_days": {
"description": "Days of credit",
"type": "integer",
"format": "int32",
"example": 1234
},
"payment_term_method": {
"description": "The payment term on the order\n- *days*: Days from the *delivery date* of the order (*pickup date* for *Ex Works* orders)\n- *month_days*: Days from beginning of next month\n- *week_mon_days*: Days from coming week (week starting on mondays)\n- *week_sun_days*: Days from coming week (week starting on sundays)\n- *pia*: Payment in advance - specify a due date\n- *custom*: A due date will need to be specified manualle each time an order or invoice is created",
"type": "string",
"format": "string",
"default": "custom",
"enum": [
"days",
"month_days",
"week_mon_days",
"week_sun_days",
"pia",
"custom"
],
"example": "days"
},
"payment_term_text": {
"description": "Text to use when the *payment_term_method* is set to custom",
"type": "string",
"format": "string",
"example": "A string"
},
"status": {
"description": "The status of the invoice. If different from *draft* and the invoice have not yet been booked, the invoice will be booked,",
"type": "string",
"format": "string",
"enum": [
"draft",
"pending",
"booking",
"paid",
"partially_paid",
"overpaid",
"written_off"
],
"example": "pending"
},
"remark": {
"description": "A remark for the invoice. Notice that *remark* have to be in the *include* parameter, for this data to be loaded\nwith the request",
"type": "string",
"format": "string",
"example": "A comment on the order"
},
"invoice_sub_total": {
"description": "Invoice sub total as shown on document",
"type": "number",
"format": "double",
"example": 1234.123
},
"invoice_vats_total": {
"description": "Invoice vats as shown on document",
"type": "number",
"format": "double",
"example": 1234.123
},
"invoice_total": {
"description": "Invoice total as shown on document",
"type": "number",
"format": "double",
"example": 1234.123
},
"invoice_rounding_correction": {
"description": "The rounding correction that was applied to the invoice total before rounding",
"type": "number",
"format": "double",
"example": 1234.123
},
"cogs_actual_total": {
"description": "Actual COGS calculated from expenses and overhead budgets. \ncogs_actual* need to parsed with *include* to have this in the response.\nOnly relevant if the actual cost pricing flow is used.",
"type": "number",
"format": "double",
"example": 1234.123
},
"cogs_budget_total": {
"description": "Budgetted COGS. \ncogs_budget* need to parsed with *include* to have this in the response.",
"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",
"readOnly": true,
"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",
"readOnly": true,
"example": "2020-01-01T13:25:32.312Z"
},
"send_by_email": {
"description": "If the invoice should be send by email upon creation. Will send the mail upon creation",
"type": "boolean",
"format": "boolean",
"readOnly": false,
"writeOnly": true,
"example": true
},
"send_by_edi": {
"description": "If the invoice should be send by EDI through the accounting system after creation.\nThis feature requires that your connected accounting system supports electronic invoices",
"type": "boolean",
"format": "boolean",
"readOnly": false,
"writeOnly": true,
"example": true
},
"edi_error": {
"description": "This will contain an error message if there was a problem sending the electronic invoice",
"type": "string",
"format": "string",
"readOnly": true
}
},
"type": "object"
},
"document": {
"properties": {
"id": {
"description": "Id of the record",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"created_by_id": {
"description": "No description is available",
"type": "integer",
"format": "int32",
"example": 1234
},
"document_data": {
"description": "No description is available",
"format": "",
"example": ""
},
"filters": {
"description": "No description is available",
"format": "",
"example": ""
},
"language": {
"description": "ISO 639-1 Code 2 letter language code",
"type": "string",
"format": "string",
"example": "da"
},
"last_sent_at": {
"description": "No description is available",
"type": "string",
"format": "date-time",
"example": "2019-01-01T13:25:32.312Z"
},
"last_sent_by_id": {
"description": "No description is available",
"type": "integer",
"format": "int32",
"example": 1234
},
"last_sent_note": {
"description": "No description is available",
"type": "string",
"format": "string",
"example": "A string"
},
"last_sent_using": {
"description": "No description is available",
"type": "string",
"format": "string",
"example": "A string"
},
"locked": {
"description": "No description is available",
"type": "boolean",
"format": "boolean",
"example": true
},
"number": {
"description": "No description is available",
"type": "integer",
"format": "int32",
"example": 1234
},
"origin_entity_id": {
"description": "No description is available",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"origin_model_name": {
"description": "No description is available",
"type": "string",
"format": "string",
"example": "A string"
},
"recipient_location_id": {
"description": "No description is available",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"recipient_partner_id": {
"description": "No description is available",
"type": "string",
"format": "uuid",
"example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
},
"status": {
"description": "No description is available",
"type": "string",
"format": "string",
"example": "A string"
},
"type": {
"description": "No description is available",
"type": "string",
"format": "string",
"example": "A string"
},
"version": {
"description": "No description is available",
"type": "integer",
"format": "int32",
"example": 1234
},
"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"
},
"queued": {
"description": "If the order has been queued for processing.",
"format": "bool",
"example": true
},
"queued_order_count": {
"description": "If the order has been queued, this will show the number of orders that is expected to be included in the invoice.",
"format": "int32",
"example": 12
}
},
"type": "object"
}
403
Unauthorized request
406
not acceptable
422
Has validation errors
500
Internal server error