Purchase Order¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/purchase-order/{id}
📋 Description: Returns the single resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "state": "INV_DRAFT",
18 "issueDate": "2019-08-24",
19 "expectedDeliveryDate": "2019-08-24",
20 "name": "string",
21 "shippingAddress": "string",
22 "notes": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "externalPurchaseOrderDisplayId": "string",
26 "vendor": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemDisplayId": "string"
32 },
33 "currency": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "decimalPoints": 0
39 },
40 "company": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "erpSystemId": 0,
45 "erpSystemDisplayId": "string",
46 "countryId": 0,
47 "countryDisplayId": "string",
48 "name": "string",
49 "postingPeriodVariantId": 0,
50 "fiscalVariantId": 0
51 },
52 "purchaseOrderLineItems": [
53 {
54 "id": 0,
55 "displayId": "string",
56 "quantity": 0,
57 "allocatedQuantity": 0,
58 "receivedQuantity": 0,
59 "unitPrice": 0,
60 "description": "string",
61 "expenseCategory": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "expenseCategoryType": "PAYMENT"
67 },
68 "costCenter": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemId": 0
74 },
75 "profitCenter": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "validTo": "2019-08-24",
81 "erpSystemId": 0,
82 "erpSystemDisplayId": "string"
83 },
84 "taxJurisdiction": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "erpSystemId": 0,
90 "schema": "string",
91 "countryDisplayId": "string"
92 },
93 "taxCode": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "taxLineItems": [
101 {
102 "id": 0,
103 "taxRate": 0.1,
104 "taxAmount": 0,
105 "taxType": "string",
106 "purchaseOrderLineItemId": 0
107 }
108 ],
109 "purchaseOrderId": 0,
110 "purchaseOrderDisplayId": "string",
111 "purchaseOrderState": "INV_DRAFT",
112 "invoiceLineItems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "expenseCategory": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "expenseCategoryType": "PAYMENT"
122 },
123 "description": "string",
124 "unitOfMeasure": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "quantity": 0,
132 "unitPrice": 0,
133 "taxJurisdiction": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0,
139 "schema": "string",
140 "countryDisplayId": "string"
141 },
142 "taxCode": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0
148 },
149 "taxExpenseAccount": {
150 "id": 0,
151 "displayId": "string",
152 "generalLedgerAccountName": "string",
153 "generalLedgerAccountCode": "string",
154 "openItemManagement": true,
155 "accountCategory": "BALANCESHEET",
156 "shortName": "string",
157 "longName": "string"
158 },
159 "taxLineItems": [
160 {
161 "id": 0,
162 "taxRate": 0.1,
163 "taxAmount": 0,
164 "taxType": "string",
165 "invoiceLineItemId": 0
166 }
167 ],
168 "workBreakdownStructure": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "costCenter": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 },
182 "profitCenter": {
183 "id": 0,
184 "displayId": "string",
185 "status": "CREATED",
186 "name": "string",
187 "validTo": "2019-08-24",
188 "erpSystemId": 0,
189 "erpSystemDisplayId": "string"
190 },
191 "functionalArea": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "businessArea": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 },
205 "segment": {
206 "id": 0,
207 "displayId": "string",
208 "status": "CREATED",
209 "name": "string",
210 "erpSystemId": 0
211 },
212 "network": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "internalOrderType": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "internalOrder": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0,
232 "internalOrderTypeId": 0
233 },
234 "additionalCurrencies": [
235 {
236 "id": 0,
237 "amount": 0,
238 "currency": {
239 "id": 0,
240 "displayId": "string",
241 "status": "CREATED",
242 "name": "string",
243 "decimalPoints": 0
244 },
245 "conversionRate": 0,
246 "conversionDate": "2019-08-24",
247 "translationDateType": "DOCUMENT_DATE",
248 "amountType": "NET_AMOUNT",
249 "currencyDefinitionType": "CONTRACT_CURRENCY",
250 "invoiceEntryId": 0,
251 "invoiceEntryDisplayId": "string"
252 }
253 ],
254 "scheduledPaymentMatches": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "amount": 0
260 }
261 ],
262 "goodsReceiptLineItemLinks": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "linkedQuantity": 0
268 }
269 ],
270 "invoiceId": 0,
271 "invoiceDisplayId": "string",
272 "invoiceState": "INV_DRAFT",
273 "vendorPaymentId": 0,
274 "purchaseOrderLineItemId": 0,
275 "netAmount": 0,
276 "allowsSystemGenerateNewId": true,
277 "numberRangeIdentifierValue": "string",
278 "numberRangeIdentifierType": {
279 "name": "string"
280 },
281 "numberRangeType": {
282 "name": "string"
283 }
284 }
285 ],
286 "goodsReceiptLineItems": [
287 {
288 "id": 0,
289 "displayId": "string",
290 "quantity": 0,
291 "invoicedQuantity": 0,
292 "description": "string",
293 "expenseCategory": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string",
298 "expenseCategoryType": "PAYMENT"
299 },
300 "goodsReceiptId": 0,
301 "goodsReceiptDisplayId": "string",
302 "goodsReceiptState": "INV_DRAFT",
303 "purchaseOrderLineItemId": 0,
304 "invoiceLineItemLinks": [
305 {
306 "id": 0,
307 "fromId": 0,
308 "toId": 0,
309 "linkedQuantity": 0
310 }
311 ],
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "vendorPaymentId": 0,
324 "purchaseRequisitionLineItemId": 0,
325 "purchaseRequisitionDisplayId": "string",
326 "purchaseRequisitionLineItemAvailableQuantity": 0,
327 "remainingQuantity": 0,
328 "availableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "purchaseRequisitionIds": [
340 0
341 ],
342 "purchaseRequisitionDisplayIds": [
343 "string"
344 ],
345 "invoices": [
346 {
347 "id": 0,
348 "displayId": "string",
349 "name": "string",
350 "invoiceType": "VENDOR_INV",
351 "state": "INV_DRAFT",
352 "externalDocumentNumber": "string",
353 "purchaseOrderReference": "string",
354 "invoiceDate": "2019-08-24",
355 "dueDate": "2019-08-24",
356 "notes": "string",
357 "billingPeriodFromDate": "2019-08-24",
358 "billingPeriodToDate": "2019-08-24",
359 "currency": {
360 "id": 0,
361 "displayId": "string",
362 "status": "CREATED",
363 "name": "string",
364 "decimalPoints": 0
365 },
366 "vendor": {
367 "id": 0,
368 "displayId": "string",
369 "status": "CREATED",
370 "name": "string",
371 "erpSystemDisplayId": "string"
372 },
373 "company": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "erpSystemId": 0,
378 "erpSystemDisplayId": "string",
379 "countryId": 0,
380 "countryDisplayId": "string",
381 "name": "string",
382 "postingPeriodVariantId": 0,
383 "fiscalVariantId": 0
384 },
385 "netAmount": 0,
386 "taxAmount": 0,
387 "totalAmount": 0,
388 "netAmountBalance": 0,
389 "taxAmountBalance": 0,
390 "paymentTerm": {
391 "id": 0,
392 "displayId": "string",
393 "status": "CREATED",
394 "name": "string"
395 },
396 "paymentMethod": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "type": "string"
402 },
403 "paymentBlock": {
404 "id": 0,
405 "displayId": "string",
406 "status": "CREATED",
407 "name": "string"
408 },
409 "defaultCostCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "defaultProfitCenter": {
417 "id": 0,
418 "displayId": "string",
419 "status": "CREATED",
420 "name": "string",
421 "validTo": "2019-08-24",
422 "erpSystemId": 0,
423 "erpSystemDisplayId": "string"
424 },
425 "invoiceLineItems": [
426 {
427 "id": 0,
428 "displayId": "string",
429 "expenseCategory": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "expenseCategoryType": "PAYMENT"
435 },
436 "description": "string",
437 "unitOfMeasure": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "erpSystemId": 0
443 },
444 "quantity": 0,
445 "unitPrice": 0,
446 "taxJurisdiction": {
447 "id": 0,
448 "displayId": "string",
449 "status": "CREATED",
450 "name": "string",
451 "erpSystemId": 0,
452 "schema": "string",
453 "countryDisplayId": "string"
454 },
455 "taxCode": {
456 "id": 0,
457 "displayId": "string",
458 "status": "CREATED",
459 "name": "string",
460 "erpSystemId": 0
461 },
462 "taxExpenseAccount": {
463 "id": 0,
464 "displayId": "string",
465 "generalLedgerAccountName": "string",
466 "generalLedgerAccountCode": "string",
467 "openItemManagement": true,
468 "accountCategory": "BALANCESHEET",
469 "shortName": "string",
470 "longName": "string"
471 },
472 "taxLineItems": [
473 {
474 "id": 0,
475 "taxRate": 0.1,
476 "taxAmount": 0,
477 "taxType": "string",
478 "invoiceLineItemId": 0
479 }
480 ],
481 "workBreakdownStructure": {
482 "id": 0,
483 "displayId": "string",
484 "status": "CREATED",
485 "name": "string",
486 "erpSystemId": 0
487 },
488 "costCenter": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "profitCenter": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "validTo": "2019-08-24",
501 "erpSystemId": 0,
502 "erpSystemDisplayId": "string"
503 },
504 "functionalArea": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "businessArea": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "segment": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "erpSystemId": 0
524 },
525 "network": {
526 "id": 0,
527 "displayId": "string",
528 "status": "CREATED",
529 "name": "string",
530 "erpSystemId": 0
531 },
532 "internalOrderType": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "internalOrder": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0,
545 "internalOrderTypeId": 0
546 },
547 "additionalCurrencies": [
548 {
549 "id": 0,
550 "amount": 0,
551 "currency": {
552 "id": 0,
553 "displayId": "string",
554 "status": "CREATED",
555 "name": "string",
556 "decimalPoints": 0
557 },
558 "conversionRate": 0,
559 "conversionDate": "2019-08-24",
560 "translationDateType": "DOCUMENT_DATE",
561 "amountType": "NET_AMOUNT",
562 "currencyDefinitionType": "CONTRACT_CURRENCY",
563 "invoiceEntryId": 0,
564 "invoiceEntryDisplayId": "string"
565 }
566 ],
567 "scheduledPaymentMatches": [
568 {
569 "id": 0,
570 "fromId": 0,
571 "toId": 0,
572 "amount": 0
573 }
574 ],
575 "goodsReceiptLineItemLinks": [
576 {
577 "id": 0,
578 "fromId": 0,
579 "toId": 0,
580 "linkedQuantity": 0
581 }
582 ],
583 "invoiceId": 0,
584 "invoiceDisplayId": "string",
585 "invoiceState": "INV_DRAFT",
586 "vendorPaymentId": 0,
587 "purchaseOrderLineItemId": 0,
588 "netAmount": 0,
589 "allowsSystemGenerateNewId": true,
590 "numberRangeIdentifierValue": "string",
591 "numberRangeIdentifierType": {
592 "name": "string"
593 },
594 "numberRangeType": {
595 "name": "string"
596 }
597 }
598 ],
599 "workspaceId": 0,
600 "workspaceDisplayId": "string",
601 "workspaceName": "string",
602 "workspaceState": "INV_DRAFT",
603 "remainingNetAmount": 0,
604 "remainingTaxAmount": 0,
605 "remainingTotalAmount": 0,
606 "pendingPaymentCount": 0,
607 "allPaymentsPosted": true,
608 "approvalInfo": {
609 "approverUsername": "string",
610 "approvedAt": "2019-08-24T14:15:22Z"
611 },
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "rejectionReason": "string",
624 "allowsSystemGenerateNewId": true,
625 "numberRangeIdentifierValue": "string",
626 "numberRangeIdentifierType": {
627 "name": "string"
628 },
629 "numberRangeType": {
630 "name": "string"
631 }
632 }
633}
Update A Resource¶
HTTP Request
PUT /api/v1/purchase-order/{id}
📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
body |
body |
true |
Request body containing the updated purchase order details, including item specifications, quantities, and pricing information. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "issueDate": "2019-08-24",
6 "expectedDeliveryDate": "2019-08-24",
7 "name": "string",
8 "shippingAddress": "string",
9 "notes": "string",
10 "netAmount": 0,
11 "taxAmount": 0,
12 "externalPurchaseOrderDisplayId": "string",
13 "vendor": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemDisplayId": "string"
19 },
20 "currency": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string",
25 "decimalPoints": 0
26 },
27 "company": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "erpSystemId": 0,
32 "erpSystemDisplayId": "string",
33 "countryId": 0,
34 "countryDisplayId": "string",
35 "name": "string",
36 "postingPeriodVariantId": 0,
37 "fiscalVariantId": 0
38 },
39 "purchaseOrderLineItems": [
40 {
41 "id": 0,
42 "displayId": "string",
43 "quantity": 0,
44 "allocatedQuantity": 0,
45 "receivedQuantity": 0,
46 "unitPrice": 0,
47 "description": "string",
48 "expenseCategory": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "expenseCategoryType": "PAYMENT"
54 },
55 "costCenter": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "erpSystemId": 0
61 },
62 "profitCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "validTo": "2019-08-24",
68 "erpSystemId": 0,
69 "erpSystemDisplayId": "string"
70 },
71 "taxJurisdiction": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "erpSystemId": 0,
77 "schema": "string",
78 "countryDisplayId": "string"
79 },
80 "taxCode": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "taxLineItems": [
88 {
89 "id": 0,
90 "taxRate": 0.1,
91 "taxAmount": 0,
92 "taxType": "string",
93 "purchaseOrderLineItemId": 0
94 }
95 ],
96 "purchaseOrderId": 0,
97 "purchaseOrderDisplayId": "string",
98 "purchaseOrderState": "INV_DRAFT",
99 "invoiceLineItems": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "expenseCategory": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "expenseCategoryType": "PAYMENT"
109 },
110 "description": "string",
111 "unitOfMeasure": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "erpSystemId": 0
117 },
118 "quantity": 0,
119 "unitPrice": 0,
120 "taxJurisdiction": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0,
126 "schema": "string",
127 "countryDisplayId": "string"
128 },
129 "taxCode": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "taxExpenseAccount": {
137 "id": 0,
138 "displayId": "string",
139 "generalLedgerAccountName": "string",
140 "generalLedgerAccountCode": "string",
141 "openItemManagement": true,
142 "accountCategory": "BALANCESHEET",
143 "shortName": "string",
144 "longName": "string"
145 },
146 "taxLineItems": [
147 {
148 "id": 0,
149 "taxRate": 0.1,
150 "taxAmount": 0,
151 "taxType": "string",
152 "invoiceLineItemId": 0
153 }
154 ],
155 "workBreakdownStructure": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0
161 },
162 "costCenter": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "profitCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "validTo": "2019-08-24",
175 "erpSystemId": 0,
176 "erpSystemDisplayId": "string"
177 },
178 "functionalArea": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "businessArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "segment": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "network": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "internalOrderType": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrder": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0,
219 "internalOrderTypeId": 0
220 },
221 "additionalCurrencies": [
222 {
223 "id": 0,
224 "amount": 0,
225 "currency": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "decimalPoints": 0
231 },
232 "conversionRate": 0,
233 "conversionDate": "2019-08-24",
234 "translationDateType": "DOCUMENT_DATE",
235 "amountType": "NET_AMOUNT",
236 "currencyDefinitionType": "CONTRACT_CURRENCY",
237 "invoiceEntryId": 0,
238 "invoiceEntryDisplayId": "string"
239 }
240 ],
241 "scheduledPaymentMatches": [
242 {
243 "id": 0,
244 "fromId": 0,
245 "toId": 0,
246 "amount": 0
247 }
248 ],
249 "goodsReceiptLineItemLinks": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "linkedQuantity": 0
255 }
256 ],
257 "invoiceId": 0,
258 "invoiceDisplayId": "string",
259 "invoiceState": "INV_DRAFT",
260 "vendorPaymentId": 0,
261 "purchaseOrderLineItemId": 0,
262 "netAmount": 0,
263 "allowsSystemGenerateNewId": true,
264 "numberRangeIdentifierValue": "string",
265 "numberRangeIdentifierType": {
266 "name": "string"
267 },
268 "numberRangeType": {
269 "name": "string"
270 }
271 }
272 ],
273 "goodsReceiptLineItems": [
274 {
275 "id": 0,
276 "displayId": "string",
277 "quantity": 0,
278 "invoicedQuantity": 0,
279 "description": "string",
280 "expenseCategory": {
281 "id": 0,
282 "displayId": "string",
283 "status": "CREATED",
284 "name": "string",
285 "expenseCategoryType": "PAYMENT"
286 },
287 "goodsReceiptId": 0,
288 "goodsReceiptDisplayId": "string",
289 "goodsReceiptState": "INV_DRAFT",
290 "purchaseOrderLineItemId": 0,
291 "invoiceLineItemLinks": [
292 {
293 "id": 0,
294 "fromId": 0,
295 "toId": 0,
296 "linkedQuantity": 0
297 }
298 ],
299 "allowsSystemGenerateNewId": true,
300 "numberRangeIdentifierValue": "string",
301 "numberRangeIdentifierType": {
302 "name": "string"
303 },
304 "numberRangeType": {
305 "name": "string"
306 }
307 }
308 ],
309 "vendorPaymentId": 0,
310 "purchaseRequisitionLineItemId": 0,
311 "purchaseRequisitionDisplayId": "string",
312 "purchaseRequisitionLineItemAvailableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "purchaseRequisitionIds": [
324 0
325 ],
326 "purchaseRequisitionDisplayIds": [
327 "string"
328 ],
329 "invoices": [
330 {
331 "id": 0,
332 "displayId": "string",
333 "name": "string",
334 "invoiceType": "VENDOR_INV",
335 "state": "INV_DRAFT",
336 "externalDocumentNumber": "string",
337 "purchaseOrderReference": "string",
338 "invoiceDate": "2019-08-24",
339 "dueDate": "2019-08-24",
340 "notes": "string",
341 "billingPeriodFromDate": "2019-08-24",
342 "billingPeriodToDate": "2019-08-24",
343 "currency": {
344 "id": 0,
345 "displayId": "string",
346 "status": "CREATED",
347 "name": "string",
348 "decimalPoints": 0
349 },
350 "vendor": {
351 "id": 0,
352 "displayId": "string",
353 "status": "CREATED",
354 "name": "string",
355 "erpSystemDisplayId": "string"
356 },
357 "company": {
358 "id": 0,
359 "displayId": "string",
360 "status": "CREATED",
361 "erpSystemId": 0,
362 "erpSystemDisplayId": "string",
363 "countryId": 0,
364 "countryDisplayId": "string",
365 "name": "string",
366 "postingPeriodVariantId": 0,
367 "fiscalVariantId": 0
368 },
369 "netAmount": 0,
370 "taxAmount": 0,
371 "totalAmount": 0,
372 "netAmountBalance": 0,
373 "taxAmountBalance": 0,
374 "paymentTerm": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "name": "string"
379 },
380 "paymentMethod": {
381 "id": 0,
382 "displayId": "string",
383 "status": "CREATED",
384 "name": "string",
385 "type": "string"
386 },
387 "paymentBlock": {
388 "id": 0,
389 "displayId": "string",
390 "status": "CREATED",
391 "name": "string"
392 },
393 "defaultCostCenter": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string",
398 "erpSystemId": 0
399 },
400 "defaultProfitCenter": {
401 "id": 0,
402 "displayId": "string",
403 "status": "CREATED",
404 "name": "string",
405 "validTo": "2019-08-24",
406 "erpSystemId": 0,
407 "erpSystemDisplayId": "string"
408 },
409 "invoiceLineItems": [
410 {
411 "id": 0,
412 "displayId": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "description": "string",
421 "unitOfMeasure": {
422 "id": 0,
423 "displayId": "string",
424 "status": "CREATED",
425 "name": "string",
426 "erpSystemId": 0
427 },
428 "quantity": 0,
429 "unitPrice": 0,
430 "taxJurisdiction": {
431 "id": 0,
432 "displayId": "string",
433 "status": "CREATED",
434 "name": "string",
435 "erpSystemId": 0,
436 "schema": "string",
437 "countryDisplayId": "string"
438 },
439 "taxCode": {
440 "id": 0,
441 "displayId": "string",
442 "status": "CREATED",
443 "name": "string",
444 "erpSystemId": 0
445 },
446 "taxExpenseAccount": {
447 "id": 0,
448 "displayId": "string",
449 "generalLedgerAccountName": "string",
450 "generalLedgerAccountCode": "string",
451 "openItemManagement": true,
452 "accountCategory": "BALANCESHEET",
453 "shortName": "string",
454 "longName": "string"
455 },
456 "taxLineItems": [
457 {
458 "id": 0,
459 "taxRate": 0.1,
460 "taxAmount": 0,
461 "taxType": "string",
462 "invoiceLineItemId": 0
463 }
464 ],
465 "workBreakdownStructure": {
466 "id": 0,
467 "displayId": "string",
468 "status": "CREATED",
469 "name": "string",
470 "erpSystemId": 0
471 },
472 "costCenter": {
473 "id": 0,
474 "displayId": "string",
475 "status": "CREATED",
476 "name": "string",
477 "erpSystemId": 0
478 },
479 "profitCenter": {
480 "id": 0,
481 "displayId": "string",
482 "status": "CREATED",
483 "name": "string",
484 "validTo": "2019-08-24",
485 "erpSystemId": 0,
486 "erpSystemDisplayId": "string"
487 },
488 "functionalArea": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "businessArea": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "erpSystemId": 0
501 },
502 "segment": {
503 "id": 0,
504 "displayId": "string",
505 "status": "CREATED",
506 "name": "string",
507 "erpSystemId": 0
508 },
509 "network": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "internalOrderType": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "internalOrder": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "erpSystemId": 0,
529 "internalOrderTypeId": 0
530 },
531 "additionalCurrencies": [
532 {
533 "id": 0,
534 "amount": 0,
535 "currency": {
536 "id": 0,
537 "displayId": "string",
538 "status": "CREATED",
539 "name": "string",
540 "decimalPoints": 0
541 },
542 "conversionRate": 0,
543 "conversionDate": "2019-08-24",
544 "translationDateType": "DOCUMENT_DATE",
545 "amountType": "NET_AMOUNT",
546 "currencyDefinitionType": "CONTRACT_CURRENCY",
547 "invoiceEntryId": 0,
548 "invoiceEntryDisplayId": "string"
549 }
550 ],
551 "scheduledPaymentMatches": [
552 {
553 "id": 0,
554 "fromId": 0,
555 "toId": 0,
556 "amount": 0
557 }
558 ],
559 "goodsReceiptLineItemLinks": [
560 {
561 "id": 0,
562 "fromId": 0,
563 "toId": 0,
564 "linkedQuantity": 0
565 }
566 ],
567 "invoiceId": 0,
568 "invoiceDisplayId": "string",
569 "invoiceState": "INV_DRAFT",
570 "vendorPaymentId": 0,
571 "purchaseOrderLineItemId": 0,
572 "netAmount": 0,
573 "allowsSystemGenerateNewId": true,
574 "numberRangeIdentifierValue": "string",
575 "numberRangeIdentifierType": {
576 "name": "string"
577 },
578 "numberRangeType": {
579 "name": "string"
580 }
581 }
582 ],
583 "workspaceId": 0,
584 "workspaceDisplayId": "string",
585 "workspaceName": "string",
586 "workspaceState": "INV_DRAFT",
587 "remainingNetAmount": 0,
588 "remainingTaxAmount": 0,
589 "remainingTotalAmount": 0,
590 "pendingPaymentCount": 0,
591 "allPaymentsPosted": true,
592 "approvalInfo": {
593 "approverUsername": "string",
594 "approvedAt": "2019-08-24T14:15:22Z"
595 },
596 "rejectionReason": "string",
597 "allowsSystemGenerateNewId": true,
598 "numberRangeIdentifierValue": "string",
599 "numberRangeIdentifierType": {
600 "name": "string"
601 },
602 "numberRangeType": {
603 "name": "string"
604 }
605 }
606 ],
607 "rejectionReason": "string",
608 "allowsSystemGenerateNewId": true,
609 "numberRangeIdentifierValue": "string",
610 "numberRangeIdentifierType": {
611 "name": "string"
612 },
613 "numberRangeType": {
614 "name": "string"
615 }
616}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "state": "INV_DRAFT",
18 "issueDate": "2019-08-24",
19 "expectedDeliveryDate": "2019-08-24",
20 "name": "string",
21 "shippingAddress": "string",
22 "notes": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "externalPurchaseOrderDisplayId": "string",
26 "vendor": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemDisplayId": "string"
32 },
33 "currency": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "decimalPoints": 0
39 },
40 "company": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "erpSystemId": 0,
45 "erpSystemDisplayId": "string",
46 "countryId": 0,
47 "countryDisplayId": "string",
48 "name": "string",
49 "postingPeriodVariantId": 0,
50 "fiscalVariantId": 0
51 },
52 "purchaseOrderLineItems": [
53 {
54 "id": 0,
55 "displayId": "string",
56 "quantity": 0,
57 "allocatedQuantity": 0,
58 "receivedQuantity": 0,
59 "unitPrice": 0,
60 "description": "string",
61 "expenseCategory": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "expenseCategoryType": "PAYMENT"
67 },
68 "costCenter": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemId": 0
74 },
75 "profitCenter": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "validTo": "2019-08-24",
81 "erpSystemId": 0,
82 "erpSystemDisplayId": "string"
83 },
84 "taxJurisdiction": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "erpSystemId": 0,
90 "schema": "string",
91 "countryDisplayId": "string"
92 },
93 "taxCode": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "taxLineItems": [
101 {
102 "id": 0,
103 "taxRate": 0.1,
104 "taxAmount": 0,
105 "taxType": "string",
106 "purchaseOrderLineItemId": 0
107 }
108 ],
109 "purchaseOrderId": 0,
110 "purchaseOrderDisplayId": "string",
111 "purchaseOrderState": "INV_DRAFT",
112 "invoiceLineItems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "expenseCategory": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "expenseCategoryType": "PAYMENT"
122 },
123 "description": "string",
124 "unitOfMeasure": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "quantity": 0,
132 "unitPrice": 0,
133 "taxJurisdiction": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0,
139 "schema": "string",
140 "countryDisplayId": "string"
141 },
142 "taxCode": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0
148 },
149 "taxExpenseAccount": {
150 "id": 0,
151 "displayId": "string",
152 "generalLedgerAccountName": "string",
153 "generalLedgerAccountCode": "string",
154 "openItemManagement": true,
155 "accountCategory": "BALANCESHEET",
156 "shortName": "string",
157 "longName": "string"
158 },
159 "taxLineItems": [
160 {
161 "id": 0,
162 "taxRate": 0.1,
163 "taxAmount": 0,
164 "taxType": "string",
165 "invoiceLineItemId": 0
166 }
167 ],
168 "workBreakdownStructure": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "costCenter": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 },
182 "profitCenter": {
183 "id": 0,
184 "displayId": "string",
185 "status": "CREATED",
186 "name": "string",
187 "validTo": "2019-08-24",
188 "erpSystemId": 0,
189 "erpSystemDisplayId": "string"
190 },
191 "functionalArea": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "businessArea": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 },
205 "segment": {
206 "id": 0,
207 "displayId": "string",
208 "status": "CREATED",
209 "name": "string",
210 "erpSystemId": 0
211 },
212 "network": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "internalOrderType": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "internalOrder": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0,
232 "internalOrderTypeId": 0
233 },
234 "additionalCurrencies": [
235 {
236 "id": 0,
237 "amount": 0,
238 "currency": {
239 "id": 0,
240 "displayId": "string",
241 "status": "CREATED",
242 "name": "string",
243 "decimalPoints": 0
244 },
245 "conversionRate": 0,
246 "conversionDate": "2019-08-24",
247 "translationDateType": "DOCUMENT_DATE",
248 "amountType": "NET_AMOUNT",
249 "currencyDefinitionType": "CONTRACT_CURRENCY",
250 "invoiceEntryId": 0,
251 "invoiceEntryDisplayId": "string"
252 }
253 ],
254 "scheduledPaymentMatches": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "amount": 0
260 }
261 ],
262 "goodsReceiptLineItemLinks": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "linkedQuantity": 0
268 }
269 ],
270 "invoiceId": 0,
271 "invoiceDisplayId": "string",
272 "invoiceState": "INV_DRAFT",
273 "vendorPaymentId": 0,
274 "purchaseOrderLineItemId": 0,
275 "netAmount": 0,
276 "allowsSystemGenerateNewId": true,
277 "numberRangeIdentifierValue": "string",
278 "numberRangeIdentifierType": {
279 "name": "string"
280 },
281 "numberRangeType": {
282 "name": "string"
283 }
284 }
285 ],
286 "goodsReceiptLineItems": [
287 {
288 "id": 0,
289 "displayId": "string",
290 "quantity": 0,
291 "invoicedQuantity": 0,
292 "description": "string",
293 "expenseCategory": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string",
298 "expenseCategoryType": "PAYMENT"
299 },
300 "goodsReceiptId": 0,
301 "goodsReceiptDisplayId": "string",
302 "goodsReceiptState": "INV_DRAFT",
303 "purchaseOrderLineItemId": 0,
304 "invoiceLineItemLinks": [
305 {
306 "id": 0,
307 "fromId": 0,
308 "toId": 0,
309 "linkedQuantity": 0
310 }
311 ],
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "vendorPaymentId": 0,
324 "purchaseRequisitionLineItemId": 0,
325 "purchaseRequisitionDisplayId": "string",
326 "purchaseRequisitionLineItemAvailableQuantity": 0,
327 "remainingQuantity": 0,
328 "availableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "purchaseRequisitionIds": [
340 0
341 ],
342 "purchaseRequisitionDisplayIds": [
343 "string"
344 ],
345 "invoices": [
346 {
347 "id": 0,
348 "displayId": "string",
349 "name": "string",
350 "invoiceType": "VENDOR_INV",
351 "state": "INV_DRAFT",
352 "externalDocumentNumber": "string",
353 "purchaseOrderReference": "string",
354 "invoiceDate": "2019-08-24",
355 "dueDate": "2019-08-24",
356 "notes": "string",
357 "billingPeriodFromDate": "2019-08-24",
358 "billingPeriodToDate": "2019-08-24",
359 "currency": {
360 "id": 0,
361 "displayId": "string",
362 "status": "CREATED",
363 "name": "string",
364 "decimalPoints": 0
365 },
366 "vendor": {
367 "id": 0,
368 "displayId": "string",
369 "status": "CREATED",
370 "name": "string",
371 "erpSystemDisplayId": "string"
372 },
373 "company": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "erpSystemId": 0,
378 "erpSystemDisplayId": "string",
379 "countryId": 0,
380 "countryDisplayId": "string",
381 "name": "string",
382 "postingPeriodVariantId": 0,
383 "fiscalVariantId": 0
384 },
385 "netAmount": 0,
386 "taxAmount": 0,
387 "totalAmount": 0,
388 "netAmountBalance": 0,
389 "taxAmountBalance": 0,
390 "paymentTerm": {
391 "id": 0,
392 "displayId": "string",
393 "status": "CREATED",
394 "name": "string"
395 },
396 "paymentMethod": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "type": "string"
402 },
403 "paymentBlock": {
404 "id": 0,
405 "displayId": "string",
406 "status": "CREATED",
407 "name": "string"
408 },
409 "defaultCostCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "defaultProfitCenter": {
417 "id": 0,
418 "displayId": "string",
419 "status": "CREATED",
420 "name": "string",
421 "validTo": "2019-08-24",
422 "erpSystemId": 0,
423 "erpSystemDisplayId": "string"
424 },
425 "invoiceLineItems": [
426 {
427 "id": 0,
428 "displayId": "string",
429 "expenseCategory": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "expenseCategoryType": "PAYMENT"
435 },
436 "description": "string",
437 "unitOfMeasure": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "erpSystemId": 0
443 },
444 "quantity": 0,
445 "unitPrice": 0,
446 "taxJurisdiction": {
447 "id": 0,
448 "displayId": "string",
449 "status": "CREATED",
450 "name": "string",
451 "erpSystemId": 0,
452 "schema": "string",
453 "countryDisplayId": "string"
454 },
455 "taxCode": {
456 "id": 0,
457 "displayId": "string",
458 "status": "CREATED",
459 "name": "string",
460 "erpSystemId": 0
461 },
462 "taxExpenseAccount": {
463 "id": 0,
464 "displayId": "string",
465 "generalLedgerAccountName": "string",
466 "generalLedgerAccountCode": "string",
467 "openItemManagement": true,
468 "accountCategory": "BALANCESHEET",
469 "shortName": "string",
470 "longName": "string"
471 },
472 "taxLineItems": [
473 {
474 "id": 0,
475 "taxRate": 0.1,
476 "taxAmount": 0,
477 "taxType": "string",
478 "invoiceLineItemId": 0
479 }
480 ],
481 "workBreakdownStructure": {
482 "id": 0,
483 "displayId": "string",
484 "status": "CREATED",
485 "name": "string",
486 "erpSystemId": 0
487 },
488 "costCenter": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "profitCenter": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "validTo": "2019-08-24",
501 "erpSystemId": 0,
502 "erpSystemDisplayId": "string"
503 },
504 "functionalArea": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "businessArea": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "segment": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "erpSystemId": 0
524 },
525 "network": {
526 "id": 0,
527 "displayId": "string",
528 "status": "CREATED",
529 "name": "string",
530 "erpSystemId": 0
531 },
532 "internalOrderType": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "internalOrder": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0,
545 "internalOrderTypeId": 0
546 },
547 "additionalCurrencies": [
548 {
549 "id": 0,
550 "amount": 0,
551 "currency": {
552 "id": 0,
553 "displayId": "string",
554 "status": "CREATED",
555 "name": "string",
556 "decimalPoints": 0
557 },
558 "conversionRate": 0,
559 "conversionDate": "2019-08-24",
560 "translationDateType": "DOCUMENT_DATE",
561 "amountType": "NET_AMOUNT",
562 "currencyDefinitionType": "CONTRACT_CURRENCY",
563 "invoiceEntryId": 0,
564 "invoiceEntryDisplayId": "string"
565 }
566 ],
567 "scheduledPaymentMatches": [
568 {
569 "id": 0,
570 "fromId": 0,
571 "toId": 0,
572 "amount": 0
573 }
574 ],
575 "goodsReceiptLineItemLinks": [
576 {
577 "id": 0,
578 "fromId": 0,
579 "toId": 0,
580 "linkedQuantity": 0
581 }
582 ],
583 "invoiceId": 0,
584 "invoiceDisplayId": "string",
585 "invoiceState": "INV_DRAFT",
586 "vendorPaymentId": 0,
587 "purchaseOrderLineItemId": 0,
588 "netAmount": 0,
589 "allowsSystemGenerateNewId": true,
590 "numberRangeIdentifierValue": "string",
591 "numberRangeIdentifierType": {
592 "name": "string"
593 },
594 "numberRangeType": {
595 "name": "string"
596 }
597 }
598 ],
599 "workspaceId": 0,
600 "workspaceDisplayId": "string",
601 "workspaceName": "string",
602 "workspaceState": "INV_DRAFT",
603 "remainingNetAmount": 0,
604 "remainingTaxAmount": 0,
605 "remainingTotalAmount": 0,
606 "pendingPaymentCount": 0,
607 "allPaymentsPosted": true,
608 "approvalInfo": {
609 "approverUsername": "string",
610 "approvedAt": "2019-08-24T14:15:22Z"
611 },
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "rejectionReason": "string",
624 "allowsSystemGenerateNewId": true,
625 "numberRangeIdentifierValue": "string",
626 "numberRangeIdentifierType": {
627 "name": "string"
628 },
629 "numberRangeType": {
630 "name": "string"
631 }
632 }
633}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/purchase-order/{id}
📋 Description: Permanently deletes the resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Partially Update A Resource (Json Patch)¶
HTTP Request
PATCH /api/v1/purchase-order/{id}
📋 Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated purchase order details, including item modifications, quantities, and pricing adjustments. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "state": "INV_DRAFT",
18 "issueDate": "2019-08-24",
19 "expectedDeliveryDate": "2019-08-24",
20 "name": "string",
21 "shippingAddress": "string",
22 "notes": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "externalPurchaseOrderDisplayId": "string",
26 "vendor": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemDisplayId": "string"
32 },
33 "currency": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "decimalPoints": 0
39 },
40 "company": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "erpSystemId": 0,
45 "erpSystemDisplayId": "string",
46 "countryId": 0,
47 "countryDisplayId": "string",
48 "name": "string",
49 "postingPeriodVariantId": 0,
50 "fiscalVariantId": 0
51 },
52 "purchaseOrderLineItems": [
53 {
54 "id": 0,
55 "displayId": "string",
56 "quantity": 0,
57 "allocatedQuantity": 0,
58 "receivedQuantity": 0,
59 "unitPrice": 0,
60 "description": "string",
61 "expenseCategory": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "expenseCategoryType": "PAYMENT"
67 },
68 "costCenter": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemId": 0
74 },
75 "profitCenter": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "validTo": "2019-08-24",
81 "erpSystemId": 0,
82 "erpSystemDisplayId": "string"
83 },
84 "taxJurisdiction": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "erpSystemId": 0,
90 "schema": "string",
91 "countryDisplayId": "string"
92 },
93 "taxCode": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "taxLineItems": [
101 {
102 "id": 0,
103 "taxRate": 0.1,
104 "taxAmount": 0,
105 "taxType": "string",
106 "purchaseOrderLineItemId": 0
107 }
108 ],
109 "purchaseOrderId": 0,
110 "purchaseOrderDisplayId": "string",
111 "purchaseOrderState": "INV_DRAFT",
112 "invoiceLineItems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "expenseCategory": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "expenseCategoryType": "PAYMENT"
122 },
123 "description": "string",
124 "unitOfMeasure": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "quantity": 0,
132 "unitPrice": 0,
133 "taxJurisdiction": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0,
139 "schema": "string",
140 "countryDisplayId": "string"
141 },
142 "taxCode": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0
148 },
149 "taxExpenseAccount": {
150 "id": 0,
151 "displayId": "string",
152 "generalLedgerAccountName": "string",
153 "generalLedgerAccountCode": "string",
154 "openItemManagement": true,
155 "accountCategory": "BALANCESHEET",
156 "shortName": "string",
157 "longName": "string"
158 },
159 "taxLineItems": [
160 {
161 "id": 0,
162 "taxRate": 0.1,
163 "taxAmount": 0,
164 "taxType": "string",
165 "invoiceLineItemId": 0
166 }
167 ],
168 "workBreakdownStructure": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "costCenter": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 },
182 "profitCenter": {
183 "id": 0,
184 "displayId": "string",
185 "status": "CREATED",
186 "name": "string",
187 "validTo": "2019-08-24",
188 "erpSystemId": 0,
189 "erpSystemDisplayId": "string"
190 },
191 "functionalArea": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "businessArea": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 },
205 "segment": {
206 "id": 0,
207 "displayId": "string",
208 "status": "CREATED",
209 "name": "string",
210 "erpSystemId": 0
211 },
212 "network": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "internalOrderType": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "internalOrder": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0,
232 "internalOrderTypeId": 0
233 },
234 "additionalCurrencies": [
235 {
236 "id": 0,
237 "amount": 0,
238 "currency": {
239 "id": 0,
240 "displayId": "string",
241 "status": "CREATED",
242 "name": "string",
243 "decimalPoints": 0
244 },
245 "conversionRate": 0,
246 "conversionDate": "2019-08-24",
247 "translationDateType": "DOCUMENT_DATE",
248 "amountType": "NET_AMOUNT",
249 "currencyDefinitionType": "CONTRACT_CURRENCY",
250 "invoiceEntryId": 0,
251 "invoiceEntryDisplayId": "string"
252 }
253 ],
254 "scheduledPaymentMatches": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "amount": 0
260 }
261 ],
262 "goodsReceiptLineItemLinks": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "linkedQuantity": 0
268 }
269 ],
270 "invoiceId": 0,
271 "invoiceDisplayId": "string",
272 "invoiceState": "INV_DRAFT",
273 "vendorPaymentId": 0,
274 "purchaseOrderLineItemId": 0,
275 "netAmount": 0,
276 "allowsSystemGenerateNewId": true,
277 "numberRangeIdentifierValue": "string",
278 "numberRangeIdentifierType": {
279 "name": "string"
280 },
281 "numberRangeType": {
282 "name": "string"
283 }
284 }
285 ],
286 "goodsReceiptLineItems": [
287 {
288 "id": 0,
289 "displayId": "string",
290 "quantity": 0,
291 "invoicedQuantity": 0,
292 "description": "string",
293 "expenseCategory": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string",
298 "expenseCategoryType": "PAYMENT"
299 },
300 "goodsReceiptId": 0,
301 "goodsReceiptDisplayId": "string",
302 "goodsReceiptState": "INV_DRAFT",
303 "purchaseOrderLineItemId": 0,
304 "invoiceLineItemLinks": [
305 {
306 "id": 0,
307 "fromId": 0,
308 "toId": 0,
309 "linkedQuantity": 0
310 }
311 ],
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "vendorPaymentId": 0,
324 "purchaseRequisitionLineItemId": 0,
325 "purchaseRequisitionDisplayId": "string",
326 "purchaseRequisitionLineItemAvailableQuantity": 0,
327 "remainingQuantity": 0,
328 "availableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "purchaseRequisitionIds": [
340 0
341 ],
342 "purchaseRequisitionDisplayIds": [
343 "string"
344 ],
345 "invoices": [
346 {
347 "id": 0,
348 "displayId": "string",
349 "name": "string",
350 "invoiceType": "VENDOR_INV",
351 "state": "INV_DRAFT",
352 "externalDocumentNumber": "string",
353 "purchaseOrderReference": "string",
354 "invoiceDate": "2019-08-24",
355 "dueDate": "2019-08-24",
356 "notes": "string",
357 "billingPeriodFromDate": "2019-08-24",
358 "billingPeriodToDate": "2019-08-24",
359 "currency": {
360 "id": 0,
361 "displayId": "string",
362 "status": "CREATED",
363 "name": "string",
364 "decimalPoints": 0
365 },
366 "vendor": {
367 "id": 0,
368 "displayId": "string",
369 "status": "CREATED",
370 "name": "string",
371 "erpSystemDisplayId": "string"
372 },
373 "company": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "erpSystemId": 0,
378 "erpSystemDisplayId": "string",
379 "countryId": 0,
380 "countryDisplayId": "string",
381 "name": "string",
382 "postingPeriodVariantId": 0,
383 "fiscalVariantId": 0
384 },
385 "netAmount": 0,
386 "taxAmount": 0,
387 "totalAmount": 0,
388 "netAmountBalance": 0,
389 "taxAmountBalance": 0,
390 "paymentTerm": {
391 "id": 0,
392 "displayId": "string",
393 "status": "CREATED",
394 "name": "string"
395 },
396 "paymentMethod": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "type": "string"
402 },
403 "paymentBlock": {
404 "id": 0,
405 "displayId": "string",
406 "status": "CREATED",
407 "name": "string"
408 },
409 "defaultCostCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "defaultProfitCenter": {
417 "id": 0,
418 "displayId": "string",
419 "status": "CREATED",
420 "name": "string",
421 "validTo": "2019-08-24",
422 "erpSystemId": 0,
423 "erpSystemDisplayId": "string"
424 },
425 "invoiceLineItems": [
426 {
427 "id": 0,
428 "displayId": "string",
429 "expenseCategory": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "expenseCategoryType": "PAYMENT"
435 },
436 "description": "string",
437 "unitOfMeasure": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "erpSystemId": 0
443 },
444 "quantity": 0,
445 "unitPrice": 0,
446 "taxJurisdiction": {
447 "id": 0,
448 "displayId": "string",
449 "status": "CREATED",
450 "name": "string",
451 "erpSystemId": 0,
452 "schema": "string",
453 "countryDisplayId": "string"
454 },
455 "taxCode": {
456 "id": 0,
457 "displayId": "string",
458 "status": "CREATED",
459 "name": "string",
460 "erpSystemId": 0
461 },
462 "taxExpenseAccount": {
463 "id": 0,
464 "displayId": "string",
465 "generalLedgerAccountName": "string",
466 "generalLedgerAccountCode": "string",
467 "openItemManagement": true,
468 "accountCategory": "BALANCESHEET",
469 "shortName": "string",
470 "longName": "string"
471 },
472 "taxLineItems": [
473 {
474 "id": 0,
475 "taxRate": 0.1,
476 "taxAmount": 0,
477 "taxType": "string",
478 "invoiceLineItemId": 0
479 }
480 ],
481 "workBreakdownStructure": {
482 "id": 0,
483 "displayId": "string",
484 "status": "CREATED",
485 "name": "string",
486 "erpSystemId": 0
487 },
488 "costCenter": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "profitCenter": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "validTo": "2019-08-24",
501 "erpSystemId": 0,
502 "erpSystemDisplayId": "string"
503 },
504 "functionalArea": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "businessArea": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "segment": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "erpSystemId": 0
524 },
525 "network": {
526 "id": 0,
527 "displayId": "string",
528 "status": "CREATED",
529 "name": "string",
530 "erpSystemId": 0
531 },
532 "internalOrderType": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "internalOrder": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0,
545 "internalOrderTypeId": 0
546 },
547 "additionalCurrencies": [
548 {
549 "id": 0,
550 "amount": 0,
551 "currency": {
552 "id": 0,
553 "displayId": "string",
554 "status": "CREATED",
555 "name": "string",
556 "decimalPoints": 0
557 },
558 "conversionRate": 0,
559 "conversionDate": "2019-08-24",
560 "translationDateType": "DOCUMENT_DATE",
561 "amountType": "NET_AMOUNT",
562 "currencyDefinitionType": "CONTRACT_CURRENCY",
563 "invoiceEntryId": 0,
564 "invoiceEntryDisplayId": "string"
565 }
566 ],
567 "scheduledPaymentMatches": [
568 {
569 "id": 0,
570 "fromId": 0,
571 "toId": 0,
572 "amount": 0
573 }
574 ],
575 "goodsReceiptLineItemLinks": [
576 {
577 "id": 0,
578 "fromId": 0,
579 "toId": 0,
580 "linkedQuantity": 0
581 }
582 ],
583 "invoiceId": 0,
584 "invoiceDisplayId": "string",
585 "invoiceState": "INV_DRAFT",
586 "vendorPaymentId": 0,
587 "purchaseOrderLineItemId": 0,
588 "netAmount": 0,
589 "allowsSystemGenerateNewId": true,
590 "numberRangeIdentifierValue": "string",
591 "numberRangeIdentifierType": {
592 "name": "string"
593 },
594 "numberRangeType": {
595 "name": "string"
596 }
597 }
598 ],
599 "workspaceId": 0,
600 "workspaceDisplayId": "string",
601 "workspaceName": "string",
602 "workspaceState": "INV_DRAFT",
603 "remainingNetAmount": 0,
604 "remainingTaxAmount": 0,
605 "remainingTotalAmount": 0,
606 "pendingPaymentCount": 0,
607 "allPaymentsPosted": true,
608 "approvalInfo": {
609 "approverUsername": "string",
610 "approvedAt": "2019-08-24T14:15:22Z"
611 },
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "rejectionReason": "string",
624 "allowsSystemGenerateNewId": true,
625 "numberRangeIdentifierValue": "string",
626 "numberRangeIdentifierType": {
627 "name": "string"
628 },
629 "numberRangeType": {
630 "name": "string"
631 }
632 }
633}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/purchase-order/createOrUpdate/bulk
📋 Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully processed items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of purchase order details for bulk creation or updates, including item specifications, quantities, and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "state": "INV_DRAFT",
6 "issueDate": "2019-08-24",
7 "expectedDeliveryDate": "2019-08-24",
8 "name": "string",
9 "shippingAddress": "string",
10 "notes": "string",
11 "netAmount": 0,
12 "taxAmount": 0,
13 "externalPurchaseOrderDisplayId": "string",
14 "vendor": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "erpSystemDisplayId": "string"
20 },
21 "currency": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "decimalPoints": 0
27 },
28 "company": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "countryId": 0,
35 "countryDisplayId": "string",
36 "name": "string",
37 "postingPeriodVariantId": 0,
38 "fiscalVariantId": 0
39 },
40 "purchaseOrderLineItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 0,
46 "receivedQuantity": 0,
47 "unitPrice": 0,
48 "description": "string",
49 "expenseCategory": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "expenseCategoryType": "PAYMENT"
55 },
56 "costCenter": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 },
63 "profitCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "validTo": "2019-08-24",
69 "erpSystemId": 0,
70 "erpSystemDisplayId": "string"
71 },
72 "taxJurisdiction": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0,
78 "schema": "string",
79 "countryDisplayId": "string"
80 },
81 "taxCode": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0
87 },
88 "taxLineItems": [
89 {
90 "id": 0,
91 "taxRate": 0.1,
92 "taxAmount": 0,
93 "taxType": "string",
94 "purchaseOrderLineItemId": 0
95 }
96 ],
97 "purchaseOrderId": 0,
98 "purchaseOrderDisplayId": "string",
99 "purchaseOrderState": "INV_DRAFT",
100 "invoiceLineItems": [
101 {
102 "id": 0,
103 "displayId": "string",
104 "expenseCategory": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "expenseCategoryType": "PAYMENT"
110 },
111 "description": "string",
112 "unitOfMeasure": {
113 "id": 0,
114 "displayId": "string",
115 "status": "CREATED",
116 "name": "string",
117 "erpSystemId": 0
118 },
119 "quantity": 0,
120 "unitPrice": 0,
121 "taxJurisdiction": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "erpSystemId": 0,
127 "schema": "string",
128 "countryDisplayId": "string"
129 },
130 "taxCode": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "taxExpenseAccount": {
138 "id": 0,
139 "displayId": "string",
140 "generalLedgerAccountName": "string",
141 "generalLedgerAccountCode": "string",
142 "openItemManagement": true,
143 "accountCategory": "BALANCESHEET",
144 "shortName": "string",
145 "longName": "string"
146 },
147 "taxLineItems": [
148 {
149 "id": 0,
150 "taxRate": 0.1,
151 "taxAmount": 0,
152 "taxType": "string",
153 "invoiceLineItemId": 0
154 }
155 ],
156 "workBreakdownStructure": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "erpSystemId": 0
162 },
163 "costCenter": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "profitCenter": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string",
175 "validTo": "2019-08-24",
176 "erpSystemId": 0,
177 "erpSystemDisplayId": "string"
178 },
179 "functionalArea": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "businessArea": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "segment": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "network": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "internalOrderType": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "internalOrder": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0,
220 "internalOrderTypeId": 0
221 },
222 "additionalCurrencies": [
223 {
224 "id": 0,
225 "amount": 0,
226 "currency": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "decimalPoints": 0
232 },
233 "conversionRate": 0,
234 "conversionDate": "2019-08-24",
235 "translationDateType": "DOCUMENT_DATE",
236 "amountType": "NET_AMOUNT",
237 "currencyDefinitionType": "CONTRACT_CURRENCY",
238 "invoiceEntryId": 0,
239 "invoiceEntryDisplayId": "string"
240 }
241 ],
242 "scheduledPaymentMatches": [
243 {
244 "id": 0,
245 "fromId": 0,
246 "toId": 0,
247 "amount": 0
248 }
249 ],
250 "goodsReceiptLineItemLinks": [
251 {
252 "id": 0,
253 "fromId": 0,
254 "toId": 0,
255 "linkedQuantity": 0
256 }
257 ],
258 "invoiceId": 0,
259 "invoiceDisplayId": "string",
260 "invoiceState": "INV_DRAFT",
261 "vendorPaymentId": 0,
262 "purchaseOrderLineItemId": 0,
263 "netAmount": 0,
264 "allowsSystemGenerateNewId": true,
265 "numberRangeIdentifierValue": "string",
266 "numberRangeIdentifierType": {
267 "name": "string"
268 },
269 "numberRangeType": {
270 "name": "string"
271 }
272 }
273 ],
274 "goodsReceiptLineItems": [
275 {
276 "id": 0,
277 "displayId": "string",
278 "quantity": 0,
279 "invoicedQuantity": 0,
280 "description": "string",
281 "expenseCategory": {
282 "id": 0,
283 "displayId": "string",
284 "status": "CREATED",
285 "name": "string",
286 "expenseCategoryType": "PAYMENT"
287 },
288 "goodsReceiptId": 0,
289 "goodsReceiptDisplayId": "string",
290 "goodsReceiptState": "INV_DRAFT",
291 "purchaseOrderLineItemId": 0,
292 "invoiceLineItemLinks": [
293 {
294 "id": 0,
295 "fromId": 0,
296 "toId": 0,
297 "linkedQuantity": 0
298 }
299 ],
300 "allowsSystemGenerateNewId": true,
301 "numberRangeIdentifierValue": "string",
302 "numberRangeIdentifierType": {
303 "name": "string"
304 },
305 "numberRangeType": {
306 "name": "string"
307 }
308 }
309 ],
310 "vendorPaymentId": 0,
311 "purchaseRequisitionLineItemId": 0,
312 "purchaseRequisitionDisplayId": "string",
313 "purchaseRequisitionLineItemAvailableQuantity": 0,
314 "allowsSystemGenerateNewId": true,
315 "numberRangeIdentifierValue": "string",
316 "numberRangeIdentifierType": {
317 "name": "string"
318 },
319 "numberRangeType": {
320 "name": "string"
321 }
322 }
323 ],
324 "purchaseRequisitionIds": [
325 0
326 ],
327 "purchaseRequisitionDisplayIds": [
328 "string"
329 ],
330 "invoices": [
331 {
332 "id": 0,
333 "displayId": "string",
334 "name": "string",
335 "invoiceType": "VENDOR_INV",
336 "state": "INV_DRAFT",
337 "externalDocumentNumber": "string",
338 "purchaseOrderReference": "string",
339 "invoiceDate": "2019-08-24",
340 "dueDate": "2019-08-24",
341 "notes": "string",
342 "billingPeriodFromDate": "2019-08-24",
343 "billingPeriodToDate": "2019-08-24",
344 "currency": {
345 "id": 0,
346 "displayId": "string",
347 "status": "CREATED",
348 "name": "string",
349 "decimalPoints": 0
350 },
351 "vendor": {
352 "id": 0,
353 "displayId": "string",
354 "status": "CREATED",
355 "name": "string",
356 "erpSystemDisplayId": "string"
357 },
358 "company": {
359 "id": 0,
360 "displayId": "string",
361 "status": "CREATED",
362 "erpSystemId": 0,
363 "erpSystemDisplayId": "string",
364 "countryId": 0,
365 "countryDisplayId": "string",
366 "name": "string",
367 "postingPeriodVariantId": 0,
368 "fiscalVariantId": 0
369 },
370 "netAmount": 0,
371 "taxAmount": 0,
372 "totalAmount": 0,
373 "netAmountBalance": 0,
374 "taxAmountBalance": 0,
375 "paymentTerm": {
376 "id": 0,
377 "displayId": "string",
378 "status": "CREATED",
379 "name": "string"
380 },
381 "paymentMethod": {
382 "id": 0,
383 "displayId": "string",
384 "status": "CREATED",
385 "name": "string",
386 "type": "string"
387 },
388 "paymentBlock": {
389 "id": 0,
390 "displayId": "string",
391 "status": "CREATED",
392 "name": "string"
393 },
394 "defaultCostCenter": {
395 "id": 0,
396 "displayId": "string",
397 "status": "CREATED",
398 "name": "string",
399 "erpSystemId": 0
400 },
401 "defaultProfitCenter": {
402 "id": 0,
403 "displayId": "string",
404 "status": "CREATED",
405 "name": "string",
406 "validTo": "2019-08-24",
407 "erpSystemId": 0,
408 "erpSystemDisplayId": "string"
409 },
410 "invoiceLineItems": [
411 {
412 "id": 0,
413 "displayId": "string",
414 "expenseCategory": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "expenseCategoryType": "PAYMENT"
420 },
421 "description": "string",
422 "unitOfMeasure": {
423 "id": 0,
424 "displayId": "string",
425 "status": "CREATED",
426 "name": "string",
427 "erpSystemId": 0
428 },
429 "quantity": 0,
430 "unitPrice": 0,
431 "taxJurisdiction": {
432 "id": 0,
433 "displayId": "string",
434 "status": "CREATED",
435 "name": "string",
436 "erpSystemId": 0,
437 "schema": "string",
438 "countryDisplayId": "string"
439 },
440 "taxCode": {
441 "id": 0,
442 "displayId": "string",
443 "status": "CREATED",
444 "name": "string",
445 "erpSystemId": 0
446 },
447 "taxExpenseAccount": {
448 "id": 0,
449 "displayId": "string",
450 "generalLedgerAccountName": "string",
451 "generalLedgerAccountCode": "string",
452 "openItemManagement": true,
453 "accountCategory": "BALANCESHEET",
454 "shortName": "string",
455 "longName": "string"
456 },
457 "taxLineItems": [
458 {
459 "id": 0,
460 "taxRate": 0.1,
461 "taxAmount": 0,
462 "taxType": "string",
463 "invoiceLineItemId": 0
464 }
465 ],
466 "workBreakdownStructure": {
467 "id": 0,
468 "displayId": "string",
469 "status": "CREATED",
470 "name": "string",
471 "erpSystemId": 0
472 },
473 "costCenter": {
474 "id": 0,
475 "displayId": "string",
476 "status": "CREATED",
477 "name": "string",
478 "erpSystemId": 0
479 },
480 "profitCenter": {
481 "id": 0,
482 "displayId": "string",
483 "status": "CREATED",
484 "name": "string",
485 "validTo": "2019-08-24",
486 "erpSystemId": 0,
487 "erpSystemDisplayId": "string"
488 },
489 "functionalArea": {
490 "id": 0,
491 "displayId": "string",
492 "status": "CREATED",
493 "name": "string",
494 "erpSystemId": 0
495 },
496 "businessArea": {
497 "id": 0,
498 "displayId": "string",
499 "status": "CREATED",
500 "name": "string",
501 "erpSystemId": 0
502 },
503 "segment": {
504 "id": 0,
505 "displayId": "string",
506 "status": "CREATED",
507 "name": "string",
508 "erpSystemId": 0
509 },
510 "network": {
511 "id": 0,
512 "displayId": "string",
513 "status": "CREATED",
514 "name": "string",
515 "erpSystemId": 0
516 },
517 "internalOrderType": {
518 "id": 0,
519 "displayId": "string",
520 "status": "CREATED",
521 "name": "string",
522 "erpSystemId": 0
523 },
524 "internalOrder": {
525 "id": 0,
526 "displayId": "string",
527 "status": "CREATED",
528 "name": "string",
529 "erpSystemId": 0,
530 "internalOrderTypeId": 0
531 },
532 "additionalCurrencies": [
533 {
534 "id": 0,
535 "amount": 0,
536 "currency": {
537 "id": 0,
538 "displayId": "string",
539 "status": "CREATED",
540 "name": "string",
541 "decimalPoints": 0
542 },
543 "conversionRate": 0,
544 "conversionDate": "2019-08-24",
545 "translationDateType": "DOCUMENT_DATE",
546 "amountType": "NET_AMOUNT",
547 "currencyDefinitionType": "CONTRACT_CURRENCY",
548 "invoiceEntryId": 0,
549 "invoiceEntryDisplayId": "string"
550 }
551 ],
552 "scheduledPaymentMatches": [
553 {
554 "id": 0,
555 "fromId": 0,
556 "toId": 0,
557 "amount": 0
558 }
559 ],
560 "goodsReceiptLineItemLinks": [
561 {
562 "id": 0,
563 "fromId": 0,
564 "toId": 0,
565 "linkedQuantity": 0
566 }
567 ],
568 "invoiceId": 0,
569 "invoiceDisplayId": "string",
570 "invoiceState": "INV_DRAFT",
571 "vendorPaymentId": 0,
572 "purchaseOrderLineItemId": 0,
573 "netAmount": 0,
574 "allowsSystemGenerateNewId": true,
575 "numberRangeIdentifierValue": "string",
576 "numberRangeIdentifierType": {
577 "name": "string"
578 },
579 "numberRangeType": {
580 "name": "string"
581 }
582 }
583 ],
584 "workspaceId": 0,
585 "workspaceDisplayId": "string",
586 "workspaceName": "string",
587 "workspaceState": "INV_DRAFT",
588 "remainingNetAmount": 0,
589 "remainingTaxAmount": 0,
590 "remainingTotalAmount": 0,
591 "pendingPaymentCount": 0,
592 "allPaymentsPosted": true,
593 "approvalInfo": {
594 "approverUsername": "string",
595 "approvedAt": "2019-08-24T14:15:22Z"
596 },
597 "rejectionReason": "string",
598 "allowsSystemGenerateNewId": true,
599 "numberRangeIdentifierValue": "string",
600 "numberRangeIdentifierType": {
601 "name": "string"
602 },
603 "numberRangeType": {
604 "name": "string"
605 }
606 }
607 ],
608 "rejectionReason": "string",
609 "allowsSystemGenerateNewId": true,
610 "numberRangeIdentifierValue": "string",
611 "numberRangeIdentifierType": {
612 "name": "string"
613 },
614 "numberRangeType": {
615 "name": "string"
616 }
617 }
618]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "state": "INV_DRAFT",
19 "issueDate": "2019-08-24",
20 "expectedDeliveryDate": "2019-08-24",
21 "name": "string",
22 "shippingAddress": "string",
23 "notes": "string",
24 "netAmount": 0,
25 "taxAmount": 0,
26 "externalPurchaseOrderDisplayId": "string",
27 "vendor": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "erpSystemDisplayId": "string"
33 },
34 "currency": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "decimalPoints": 0
40 },
41 "company": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "erpSystemId": 0,
46 "erpSystemDisplayId": "string",
47 "countryId": 0,
48 "countryDisplayId": "string",
49 "name": "string",
50 "postingPeriodVariantId": 0,
51 "fiscalVariantId": 0
52 },
53 "purchaseOrderLineItems": [
54 {
55 "id": 0,
56 "displayId": "string",
57 "quantity": 0,
58 "allocatedQuantity": 0,
59 "receivedQuantity": 0,
60 "unitPrice": 0,
61 "description": "string",
62 "expenseCategory": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "expenseCategoryType": "PAYMENT"
68 },
69 "costCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "profitCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "validTo": "2019-08-24",
82 "erpSystemId": 0,
83 "erpSystemDisplayId": "string"
84 },
85 "taxJurisdiction": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0,
91 "schema": "string",
92 "countryDisplayId": "string"
93 },
94 "taxCode": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "taxLineItems": [
102 {
103 "id": 0,
104 "taxRate": 0.1,
105 "taxAmount": 0,
106 "taxType": "string",
107 "purchaseOrderLineItemId": 0
108 }
109 ],
110 "purchaseOrderId": 0,
111 "purchaseOrderDisplayId": "string",
112 "purchaseOrderState": "INV_DRAFT",
113 "invoiceLineItems": [
114 {
115 "id": 0,
116 "displayId": "string",
117 "expenseCategory": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "expenseCategoryType": "PAYMENT"
123 },
124 "description": "string",
125 "unitOfMeasure": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "quantity": 0,
133 "unitPrice": 0,
134 "taxJurisdiction": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0,
140 "schema": "string",
141 "countryDisplayId": "string"
142 },
143 "taxCode": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "erpSystemId": 0
149 },
150 "taxExpenseAccount": {
151 "id": 0,
152 "displayId": "string",
153 "generalLedgerAccountName": "string",
154 "generalLedgerAccountCode": "string",
155 "openItemManagement": true,
156 "accountCategory": "BALANCESHEET",
157 "shortName": "string",
158 "longName": "string"
159 },
160 "taxLineItems": [
161 {
162 "id": 0,
163 "taxRate": 0.1,
164 "taxAmount": 0,
165 "taxType": "string",
166 "invoiceLineItemId": 0
167 }
168 ],
169 "workBreakdownStructure": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "costCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 },
183 "profitCenter": {
184 "id": 0,
185 "displayId": "string",
186 "status": "CREATED",
187 "name": "string",
188 "validTo": "2019-08-24",
189 "erpSystemId": 0,
190 "erpSystemDisplayId": "string"
191 },
192 "functionalArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "businessArea": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "segment": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "network": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrderType": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0
226 },
227 "internalOrder": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "erpSystemId": 0,
233 "internalOrderTypeId": 0
234 },
235 "additionalCurrencies": [
236 {
237 "id": 0,
238 "amount": 0,
239 "currency": {
240 "id": 0,
241 "displayId": "string",
242 "status": "CREATED",
243 "name": "string",
244 "decimalPoints": 0
245 },
246 "conversionRate": 0,
247 "conversionDate": "2019-08-24",
248 "translationDateType": "DOCUMENT_DATE",
249 "amountType": "NET_AMOUNT",
250 "currencyDefinitionType": "CONTRACT_CURRENCY",
251 "invoiceEntryId": 0,
252 "invoiceEntryDisplayId": "string"
253 }
254 ],
255 "scheduledPaymentMatches": [
256 {
257 "id": 0,
258 "fromId": 0,
259 "toId": 0,
260 "amount": 0
261 }
262 ],
263 "goodsReceiptLineItemLinks": [
264 {
265 "id": 0,
266 "fromId": 0,
267 "toId": 0,
268 "linkedQuantity": 0
269 }
270 ],
271 "invoiceId": 0,
272 "invoiceDisplayId": "string",
273 "invoiceState": "INV_DRAFT",
274 "vendorPaymentId": 0,
275 "purchaseOrderLineItemId": 0,
276 "netAmount": 0,
277 "allowsSystemGenerateNewId": true,
278 "numberRangeIdentifierValue": "string",
279 "numberRangeIdentifierType": {
280 "name": "string"
281 },
282 "numberRangeType": {
283 "name": "string"
284 }
285 }
286 ],
287 "goodsReceiptLineItems": [
288 {
289 "id": 0,
290 "displayId": "string",
291 "quantity": 0,
292 "invoicedQuantity": 0,
293 "description": "string",
294 "expenseCategory": {
295 "id": 0,
296 "displayId": "string",
297 "status": "CREATED",
298 "name": "string",
299 "expenseCategoryType": "PAYMENT"
300 },
301 "goodsReceiptId": 0,
302 "goodsReceiptDisplayId": "string",
303 "goodsReceiptState": "INV_DRAFT",
304 "purchaseOrderLineItemId": 0,
305 "invoiceLineItemLinks": [
306 {
307 "id": 0,
308 "fromId": 0,
309 "toId": 0,
310 "linkedQuantity": 0
311 }
312 ],
313 "availableQuantity": 0,
314 "allowsSystemGenerateNewId": true,
315 "numberRangeIdentifierValue": "string",
316 "numberRangeIdentifierType": {
317 "name": "string"
318 },
319 "numberRangeType": {
320 "name": "string"
321 }
322 }
323 ],
324 "vendorPaymentId": 0,
325 "purchaseRequisitionLineItemId": 0,
326 "purchaseRequisitionDisplayId": "string",
327 "purchaseRequisitionLineItemAvailableQuantity": 0,
328 "remainingQuantity": 0,
329 "availableQuantity": 0,
330 "allowsSystemGenerateNewId": true,
331 "numberRangeIdentifierValue": "string",
332 "numberRangeIdentifierType": {
333 "name": "string"
334 },
335 "numberRangeType": {
336 "name": "string"
337 }
338 }
339 ],
340 "purchaseRequisitionIds": [
341 0
342 ],
343 "purchaseRequisitionDisplayIds": [
344 "string"
345 ],
346 "invoices": [
347 {
348 "id": 0,
349 "displayId": "string",
350 "name": "string",
351 "invoiceType": "VENDOR_INV",
352 "state": "INV_DRAFT",
353 "externalDocumentNumber": "string",
354 "purchaseOrderReference": "string",
355 "invoiceDate": "2019-08-24",
356 "dueDate": "2019-08-24",
357 "notes": "string",
358 "billingPeriodFromDate": "2019-08-24",
359 "billingPeriodToDate": "2019-08-24",
360 "currency": {
361 "id": 0,
362 "displayId": "string",
363 "status": "CREATED",
364 "name": "string",
365 "decimalPoints": 0
366 },
367 "vendor": {
368 "id": 0,
369 "displayId": "string",
370 "status": "CREATED",
371 "name": "string",
372 "erpSystemDisplayId": "string"
373 },
374 "company": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "erpSystemId": 0,
379 "erpSystemDisplayId": "string",
380 "countryId": 0,
381 "countryDisplayId": "string",
382 "name": "string",
383 "postingPeriodVariantId": 0,
384 "fiscalVariantId": 0
385 },
386 "netAmount": 0,
387 "taxAmount": 0,
388 "totalAmount": 0,
389 "netAmountBalance": 0,
390 "taxAmountBalance": 0,
391 "paymentTerm": {
392 "id": 0,
393 "displayId": "string",
394 "status": "CREATED",
395 "name": "string"
396 },
397 "paymentMethod": {
398 "id": 0,
399 "displayId": "string",
400 "status": "CREATED",
401 "name": "string",
402 "type": "string"
403 },
404 "paymentBlock": {
405 "id": 0,
406 "displayId": "string",
407 "status": "CREATED",
408 "name": "string"
409 },
410 "defaultCostCenter": {
411 "id": 0,
412 "displayId": "string",
413 "status": "CREATED",
414 "name": "string",
415 "erpSystemId": 0
416 },
417 "defaultProfitCenter": {
418 "id": 0,
419 "displayId": "string",
420 "status": "CREATED",
421 "name": "string",
422 "validTo": "2019-08-24",
423 "erpSystemId": 0,
424 "erpSystemDisplayId": "string"
425 },
426 "invoiceLineItems": [
427 {
428 "id": 0,
429 "displayId": "string",
430 "expenseCategory": {
431 "id": 0,
432 "displayId": "string",
433 "status": "CREATED",
434 "name": "string",
435 "expenseCategoryType": "PAYMENT"
436 },
437 "description": "string",
438 "unitOfMeasure": {
439 "id": 0,
440 "displayId": "string",
441 "status": "CREATED",
442 "name": "string",
443 "erpSystemId": 0
444 },
445 "quantity": 0,
446 "unitPrice": 0,
447 "taxJurisdiction": {
448 "id": 0,
449 "displayId": "string",
450 "status": "CREATED",
451 "name": "string",
452 "erpSystemId": 0,
453 "schema": "string",
454 "countryDisplayId": "string"
455 },
456 "taxCode": {
457 "id": 0,
458 "displayId": "string",
459 "status": "CREATED",
460 "name": "string",
461 "erpSystemId": 0
462 },
463 "taxExpenseAccount": {
464 "id": 0,
465 "displayId": "string",
466 "generalLedgerAccountName": "string",
467 "generalLedgerAccountCode": "string",
468 "openItemManagement": true,
469 "accountCategory": "BALANCESHEET",
470 "shortName": "string",
471 "longName": "string"
472 },
473 "taxLineItems": [
474 {
475 "id": 0,
476 "taxRate": 0.1,
477 "taxAmount": 0,
478 "taxType": "string",
479 "invoiceLineItemId": 0
480 }
481 ],
482 "workBreakdownStructure": {
483 "id": 0,
484 "displayId": "string",
485 "status": "CREATED",
486 "name": "string",
487 "erpSystemId": 0
488 },
489 "costCenter": {
490 "id": 0,
491 "displayId": "string",
492 "status": "CREATED",
493 "name": "string",
494 "erpSystemId": 0
495 },
496 "profitCenter": {
497 "id": 0,
498 "displayId": "string",
499 "status": "CREATED",
500 "name": "string",
501 "validTo": "2019-08-24",
502 "erpSystemId": 0,
503 "erpSystemDisplayId": "string"
504 },
505 "functionalArea": {
506 "id": 0,
507 "displayId": "string",
508 "status": "CREATED",
509 "name": "string",
510 "erpSystemId": 0
511 },
512 "businessArea": {
513 "id": 0,
514 "displayId": "string",
515 "status": "CREATED",
516 "name": "string",
517 "erpSystemId": 0
518 },
519 "segment": {
520 "id": 0,
521 "displayId": "string",
522 "status": "CREATED",
523 "name": "string",
524 "erpSystemId": 0
525 },
526 "network": {
527 "id": 0,
528 "displayId": "string",
529 "status": "CREATED",
530 "name": "string",
531 "erpSystemId": 0
532 },
533 "internalOrderType": {
534 "id": 0,
535 "displayId": "string",
536 "status": "CREATED",
537 "name": "string",
538 "erpSystemId": 0
539 },
540 "internalOrder": {
541 "id": 0,
542 "displayId": "string",
543 "status": "CREATED",
544 "name": "string",
545 "erpSystemId": 0,
546 "internalOrderTypeId": 0
547 },
548 "additionalCurrencies": [
549 {
550 "id": 0,
551 "amount": 0,
552 "currency": {
553 "id": 0,
554 "displayId": "string",
555 "status": "CREATED",
556 "name": "string",
557 "decimalPoints": 0
558 },
559 "conversionRate": 0,
560 "conversionDate": "2019-08-24",
561 "translationDateType": "DOCUMENT_DATE",
562 "amountType": "NET_AMOUNT",
563 "currencyDefinitionType": "CONTRACT_CURRENCY",
564 "invoiceEntryId": 0,
565 "invoiceEntryDisplayId": "string"
566 }
567 ],
568 "scheduledPaymentMatches": [
569 {
570 "id": 0,
571 "fromId": 0,
572 "toId": 0,
573 "amount": 0
574 }
575 ],
576 "goodsReceiptLineItemLinks": [
577 {
578 "id": 0,
579 "fromId": 0,
580 "toId": 0,
581 "linkedQuantity": 0
582 }
583 ],
584 "invoiceId": 0,
585 "invoiceDisplayId": "string",
586 "invoiceState": "INV_DRAFT",
587 "vendorPaymentId": 0,
588 "purchaseOrderLineItemId": 0,
589 "netAmount": 0,
590 "allowsSystemGenerateNewId": true,
591 "numberRangeIdentifierValue": "string",
592 "numberRangeIdentifierType": {
593 "name": "string"
594 },
595 "numberRangeType": {
596 "name": "string"
597 }
598 }
599 ],
600 "workspaceId": 0,
601 "workspaceDisplayId": "string",
602 "workspaceName": "string",
603 "workspaceState": "INV_DRAFT",
604 "remainingNetAmount": 0,
605 "remainingTaxAmount": 0,
606 "remainingTotalAmount": 0,
607 "pendingPaymentCount": 0,
608 "allPaymentsPosted": true,
609 "approvalInfo": {
610 "approverUsername": "string",
611 "approvedAt": "2019-08-24T14:15:22Z"
612 },
613 "rejectionReason": "string",
614 "allowsSystemGenerateNewId": true,
615 "numberRangeIdentifierValue": "string",
616 "numberRangeIdentifierType": {
617 "name": "string"
618 },
619 "numberRangeType": {
620 "name": "string"
621 }
622 }
623 ],
624 "rejectionReason": "string",
625 "allowsSystemGenerateNewId": true,
626 "numberRangeIdentifierValue": "string",
627 "numberRangeIdentifierType": {
628 "name": "string"
629 },
630 "numberRangeType": {
631 "name": "string"
632 }
633 }
634 ]
635}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/purchase-order/createOrUpdate
📋 Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the purchase order details, including item specifications, quantities, pricing, and supplier information for creating or updating a purchase order. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "issueDate": "2019-08-24",
6 "expectedDeliveryDate": "2019-08-24",
7 "name": "string",
8 "shippingAddress": "string",
9 "notes": "string",
10 "netAmount": 0,
11 "taxAmount": 0,
12 "externalPurchaseOrderDisplayId": "string",
13 "vendor": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemDisplayId": "string"
19 },
20 "currency": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string",
25 "decimalPoints": 0
26 },
27 "company": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "erpSystemId": 0,
32 "erpSystemDisplayId": "string",
33 "countryId": 0,
34 "countryDisplayId": "string",
35 "name": "string",
36 "postingPeriodVariantId": 0,
37 "fiscalVariantId": 0
38 },
39 "purchaseOrderLineItems": [
40 {
41 "id": 0,
42 "displayId": "string",
43 "quantity": 0,
44 "allocatedQuantity": 0,
45 "receivedQuantity": 0,
46 "unitPrice": 0,
47 "description": "string",
48 "expenseCategory": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "expenseCategoryType": "PAYMENT"
54 },
55 "costCenter": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "erpSystemId": 0
61 },
62 "profitCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "validTo": "2019-08-24",
68 "erpSystemId": 0,
69 "erpSystemDisplayId": "string"
70 },
71 "taxJurisdiction": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "erpSystemId": 0,
77 "schema": "string",
78 "countryDisplayId": "string"
79 },
80 "taxCode": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "taxLineItems": [
88 {
89 "id": 0,
90 "taxRate": 0.1,
91 "taxAmount": 0,
92 "taxType": "string",
93 "purchaseOrderLineItemId": 0
94 }
95 ],
96 "purchaseOrderId": 0,
97 "purchaseOrderDisplayId": "string",
98 "purchaseOrderState": "INV_DRAFT",
99 "invoiceLineItems": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "expenseCategory": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "expenseCategoryType": "PAYMENT"
109 },
110 "description": "string",
111 "unitOfMeasure": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "erpSystemId": 0
117 },
118 "quantity": 0,
119 "unitPrice": 0,
120 "taxJurisdiction": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0,
126 "schema": "string",
127 "countryDisplayId": "string"
128 },
129 "taxCode": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "taxExpenseAccount": {
137 "id": 0,
138 "displayId": "string",
139 "generalLedgerAccountName": "string",
140 "generalLedgerAccountCode": "string",
141 "openItemManagement": true,
142 "accountCategory": "BALANCESHEET",
143 "shortName": "string",
144 "longName": "string"
145 },
146 "taxLineItems": [
147 {
148 "id": 0,
149 "taxRate": 0.1,
150 "taxAmount": 0,
151 "taxType": "string",
152 "invoiceLineItemId": 0
153 }
154 ],
155 "workBreakdownStructure": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0
161 },
162 "costCenter": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "profitCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "validTo": "2019-08-24",
175 "erpSystemId": 0,
176 "erpSystemDisplayId": "string"
177 },
178 "functionalArea": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "businessArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "segment": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "network": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "internalOrderType": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrder": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0,
219 "internalOrderTypeId": 0
220 },
221 "additionalCurrencies": [
222 {
223 "id": 0,
224 "amount": 0,
225 "currency": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "decimalPoints": 0
231 },
232 "conversionRate": 0,
233 "conversionDate": "2019-08-24",
234 "translationDateType": "DOCUMENT_DATE",
235 "amountType": "NET_AMOUNT",
236 "currencyDefinitionType": "CONTRACT_CURRENCY",
237 "invoiceEntryId": 0,
238 "invoiceEntryDisplayId": "string"
239 }
240 ],
241 "scheduledPaymentMatches": [
242 {
243 "id": 0,
244 "fromId": 0,
245 "toId": 0,
246 "amount": 0
247 }
248 ],
249 "goodsReceiptLineItemLinks": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "linkedQuantity": 0
255 }
256 ],
257 "invoiceId": 0,
258 "invoiceDisplayId": "string",
259 "invoiceState": "INV_DRAFT",
260 "vendorPaymentId": 0,
261 "purchaseOrderLineItemId": 0,
262 "netAmount": 0,
263 "allowsSystemGenerateNewId": true,
264 "numberRangeIdentifierValue": "string",
265 "numberRangeIdentifierType": {
266 "name": "string"
267 },
268 "numberRangeType": {
269 "name": "string"
270 }
271 }
272 ],
273 "goodsReceiptLineItems": [
274 {
275 "id": 0,
276 "displayId": "string",
277 "quantity": 0,
278 "invoicedQuantity": 0,
279 "description": "string",
280 "expenseCategory": {
281 "id": 0,
282 "displayId": "string",
283 "status": "CREATED",
284 "name": "string",
285 "expenseCategoryType": "PAYMENT"
286 },
287 "goodsReceiptId": 0,
288 "goodsReceiptDisplayId": "string",
289 "goodsReceiptState": "INV_DRAFT",
290 "purchaseOrderLineItemId": 0,
291 "invoiceLineItemLinks": [
292 {
293 "id": 0,
294 "fromId": 0,
295 "toId": 0,
296 "linkedQuantity": 0
297 }
298 ],
299 "allowsSystemGenerateNewId": true,
300 "numberRangeIdentifierValue": "string",
301 "numberRangeIdentifierType": {
302 "name": "string"
303 },
304 "numberRangeType": {
305 "name": "string"
306 }
307 }
308 ],
309 "vendorPaymentId": 0,
310 "purchaseRequisitionLineItemId": 0,
311 "purchaseRequisitionDisplayId": "string",
312 "purchaseRequisitionLineItemAvailableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "purchaseRequisitionIds": [
324 0
325 ],
326 "purchaseRequisitionDisplayIds": [
327 "string"
328 ],
329 "invoices": [
330 {
331 "id": 0,
332 "displayId": "string",
333 "name": "string",
334 "invoiceType": "VENDOR_INV",
335 "state": "INV_DRAFT",
336 "externalDocumentNumber": "string",
337 "purchaseOrderReference": "string",
338 "invoiceDate": "2019-08-24",
339 "dueDate": "2019-08-24",
340 "notes": "string",
341 "billingPeriodFromDate": "2019-08-24",
342 "billingPeriodToDate": "2019-08-24",
343 "currency": {
344 "id": 0,
345 "displayId": "string",
346 "status": "CREATED",
347 "name": "string",
348 "decimalPoints": 0
349 },
350 "vendor": {
351 "id": 0,
352 "displayId": "string",
353 "status": "CREATED",
354 "name": "string",
355 "erpSystemDisplayId": "string"
356 },
357 "company": {
358 "id": 0,
359 "displayId": "string",
360 "status": "CREATED",
361 "erpSystemId": 0,
362 "erpSystemDisplayId": "string",
363 "countryId": 0,
364 "countryDisplayId": "string",
365 "name": "string",
366 "postingPeriodVariantId": 0,
367 "fiscalVariantId": 0
368 },
369 "netAmount": 0,
370 "taxAmount": 0,
371 "totalAmount": 0,
372 "netAmountBalance": 0,
373 "taxAmountBalance": 0,
374 "paymentTerm": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "name": "string"
379 },
380 "paymentMethod": {
381 "id": 0,
382 "displayId": "string",
383 "status": "CREATED",
384 "name": "string",
385 "type": "string"
386 },
387 "paymentBlock": {
388 "id": 0,
389 "displayId": "string",
390 "status": "CREATED",
391 "name": "string"
392 },
393 "defaultCostCenter": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string",
398 "erpSystemId": 0
399 },
400 "defaultProfitCenter": {
401 "id": 0,
402 "displayId": "string",
403 "status": "CREATED",
404 "name": "string",
405 "validTo": "2019-08-24",
406 "erpSystemId": 0,
407 "erpSystemDisplayId": "string"
408 },
409 "invoiceLineItems": [
410 {
411 "id": 0,
412 "displayId": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "description": "string",
421 "unitOfMeasure": {
422 "id": 0,
423 "displayId": "string",
424 "status": "CREATED",
425 "name": "string",
426 "erpSystemId": 0
427 },
428 "quantity": 0,
429 "unitPrice": 0,
430 "taxJurisdiction": {
431 "id": 0,
432 "displayId": "string",
433 "status": "CREATED",
434 "name": "string",
435 "erpSystemId": 0,
436 "schema": "string",
437 "countryDisplayId": "string"
438 },
439 "taxCode": {
440 "id": 0,
441 "displayId": "string",
442 "status": "CREATED",
443 "name": "string",
444 "erpSystemId": 0
445 },
446 "taxExpenseAccount": {
447 "id": 0,
448 "displayId": "string",
449 "generalLedgerAccountName": "string",
450 "generalLedgerAccountCode": "string",
451 "openItemManagement": true,
452 "accountCategory": "BALANCESHEET",
453 "shortName": "string",
454 "longName": "string"
455 },
456 "taxLineItems": [
457 {
458 "id": 0,
459 "taxRate": 0.1,
460 "taxAmount": 0,
461 "taxType": "string",
462 "invoiceLineItemId": 0
463 }
464 ],
465 "workBreakdownStructure": {
466 "id": 0,
467 "displayId": "string",
468 "status": "CREATED",
469 "name": "string",
470 "erpSystemId": 0
471 },
472 "costCenter": {
473 "id": 0,
474 "displayId": "string",
475 "status": "CREATED",
476 "name": "string",
477 "erpSystemId": 0
478 },
479 "profitCenter": {
480 "id": 0,
481 "displayId": "string",
482 "status": "CREATED",
483 "name": "string",
484 "validTo": "2019-08-24",
485 "erpSystemId": 0,
486 "erpSystemDisplayId": "string"
487 },
488 "functionalArea": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "businessArea": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "erpSystemId": 0
501 },
502 "segment": {
503 "id": 0,
504 "displayId": "string",
505 "status": "CREATED",
506 "name": "string",
507 "erpSystemId": 0
508 },
509 "network": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "internalOrderType": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "internalOrder": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "erpSystemId": 0,
529 "internalOrderTypeId": 0
530 },
531 "additionalCurrencies": [
532 {
533 "id": 0,
534 "amount": 0,
535 "currency": {
536 "id": 0,
537 "displayId": "string",
538 "status": "CREATED",
539 "name": "string",
540 "decimalPoints": 0
541 },
542 "conversionRate": 0,
543 "conversionDate": "2019-08-24",
544 "translationDateType": "DOCUMENT_DATE",
545 "amountType": "NET_AMOUNT",
546 "currencyDefinitionType": "CONTRACT_CURRENCY",
547 "invoiceEntryId": 0,
548 "invoiceEntryDisplayId": "string"
549 }
550 ],
551 "scheduledPaymentMatches": [
552 {
553 "id": 0,
554 "fromId": 0,
555 "toId": 0,
556 "amount": 0
557 }
558 ],
559 "goodsReceiptLineItemLinks": [
560 {
561 "id": 0,
562 "fromId": 0,
563 "toId": 0,
564 "linkedQuantity": 0
565 }
566 ],
567 "invoiceId": 0,
568 "invoiceDisplayId": "string",
569 "invoiceState": "INV_DRAFT",
570 "vendorPaymentId": 0,
571 "purchaseOrderLineItemId": 0,
572 "netAmount": 0,
573 "allowsSystemGenerateNewId": true,
574 "numberRangeIdentifierValue": "string",
575 "numberRangeIdentifierType": {
576 "name": "string"
577 },
578 "numberRangeType": {
579 "name": "string"
580 }
581 }
582 ],
583 "workspaceId": 0,
584 "workspaceDisplayId": "string",
585 "workspaceName": "string",
586 "workspaceState": "INV_DRAFT",
587 "remainingNetAmount": 0,
588 "remainingTaxAmount": 0,
589 "remainingTotalAmount": 0,
590 "pendingPaymentCount": 0,
591 "allPaymentsPosted": true,
592 "approvalInfo": {
593 "approverUsername": "string",
594 "approvedAt": "2019-08-24T14:15:22Z"
595 },
596 "rejectionReason": "string",
597 "allowsSystemGenerateNewId": true,
598 "numberRangeIdentifierValue": "string",
599 "numberRangeIdentifierType": {
600 "name": "string"
601 },
602 "numberRangeType": {
603 "name": "string"
604 }
605 }
606 ],
607 "rejectionReason": "string",
608 "allowsSystemGenerateNewId": true,
609 "numberRangeIdentifierValue": "string",
610 "numberRangeIdentifierType": {
611 "name": "string"
612 },
613 "numberRangeType": {
614 "name": "string"
615 }
616}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "state": "INV_DRAFT",
18 "issueDate": "2019-08-24",
19 "expectedDeliveryDate": "2019-08-24",
20 "name": "string",
21 "shippingAddress": "string",
22 "notes": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "externalPurchaseOrderDisplayId": "string",
26 "vendor": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemDisplayId": "string"
32 },
33 "currency": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "decimalPoints": 0
39 },
40 "company": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "erpSystemId": 0,
45 "erpSystemDisplayId": "string",
46 "countryId": 0,
47 "countryDisplayId": "string",
48 "name": "string",
49 "postingPeriodVariantId": 0,
50 "fiscalVariantId": 0
51 },
52 "purchaseOrderLineItems": [
53 {
54 "id": 0,
55 "displayId": "string",
56 "quantity": 0,
57 "allocatedQuantity": 0,
58 "receivedQuantity": 0,
59 "unitPrice": 0,
60 "description": "string",
61 "expenseCategory": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "expenseCategoryType": "PAYMENT"
67 },
68 "costCenter": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemId": 0
74 },
75 "profitCenter": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "validTo": "2019-08-24",
81 "erpSystemId": 0,
82 "erpSystemDisplayId": "string"
83 },
84 "taxJurisdiction": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "erpSystemId": 0,
90 "schema": "string",
91 "countryDisplayId": "string"
92 },
93 "taxCode": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "taxLineItems": [
101 {
102 "id": 0,
103 "taxRate": 0.1,
104 "taxAmount": 0,
105 "taxType": "string",
106 "purchaseOrderLineItemId": 0
107 }
108 ],
109 "purchaseOrderId": 0,
110 "purchaseOrderDisplayId": "string",
111 "purchaseOrderState": "INV_DRAFT",
112 "invoiceLineItems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "expenseCategory": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "expenseCategoryType": "PAYMENT"
122 },
123 "description": "string",
124 "unitOfMeasure": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "quantity": 0,
132 "unitPrice": 0,
133 "taxJurisdiction": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0,
139 "schema": "string",
140 "countryDisplayId": "string"
141 },
142 "taxCode": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0
148 },
149 "taxExpenseAccount": {
150 "id": 0,
151 "displayId": "string",
152 "generalLedgerAccountName": "string",
153 "generalLedgerAccountCode": "string",
154 "openItemManagement": true,
155 "accountCategory": "BALANCESHEET",
156 "shortName": "string",
157 "longName": "string"
158 },
159 "taxLineItems": [
160 {
161 "id": 0,
162 "taxRate": 0.1,
163 "taxAmount": 0,
164 "taxType": "string",
165 "invoiceLineItemId": 0
166 }
167 ],
168 "workBreakdownStructure": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "costCenter": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 },
182 "profitCenter": {
183 "id": 0,
184 "displayId": "string",
185 "status": "CREATED",
186 "name": "string",
187 "validTo": "2019-08-24",
188 "erpSystemId": 0,
189 "erpSystemDisplayId": "string"
190 },
191 "functionalArea": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "businessArea": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 },
205 "segment": {
206 "id": 0,
207 "displayId": "string",
208 "status": "CREATED",
209 "name": "string",
210 "erpSystemId": 0
211 },
212 "network": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "internalOrderType": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "internalOrder": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0,
232 "internalOrderTypeId": 0
233 },
234 "additionalCurrencies": [
235 {
236 "id": 0,
237 "amount": 0,
238 "currency": {
239 "id": 0,
240 "displayId": "string",
241 "status": "CREATED",
242 "name": "string",
243 "decimalPoints": 0
244 },
245 "conversionRate": 0,
246 "conversionDate": "2019-08-24",
247 "translationDateType": "DOCUMENT_DATE",
248 "amountType": "NET_AMOUNT",
249 "currencyDefinitionType": "CONTRACT_CURRENCY",
250 "invoiceEntryId": 0,
251 "invoiceEntryDisplayId": "string"
252 }
253 ],
254 "scheduledPaymentMatches": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "amount": 0
260 }
261 ],
262 "goodsReceiptLineItemLinks": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "linkedQuantity": 0
268 }
269 ],
270 "invoiceId": 0,
271 "invoiceDisplayId": "string",
272 "invoiceState": "INV_DRAFT",
273 "vendorPaymentId": 0,
274 "purchaseOrderLineItemId": 0,
275 "netAmount": 0,
276 "allowsSystemGenerateNewId": true,
277 "numberRangeIdentifierValue": "string",
278 "numberRangeIdentifierType": {
279 "name": "string"
280 },
281 "numberRangeType": {
282 "name": "string"
283 }
284 }
285 ],
286 "goodsReceiptLineItems": [
287 {
288 "id": 0,
289 "displayId": "string",
290 "quantity": 0,
291 "invoicedQuantity": 0,
292 "description": "string",
293 "expenseCategory": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string",
298 "expenseCategoryType": "PAYMENT"
299 },
300 "goodsReceiptId": 0,
301 "goodsReceiptDisplayId": "string",
302 "goodsReceiptState": "INV_DRAFT",
303 "purchaseOrderLineItemId": 0,
304 "invoiceLineItemLinks": [
305 {
306 "id": 0,
307 "fromId": 0,
308 "toId": 0,
309 "linkedQuantity": 0
310 }
311 ],
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "vendorPaymentId": 0,
324 "purchaseRequisitionLineItemId": 0,
325 "purchaseRequisitionDisplayId": "string",
326 "purchaseRequisitionLineItemAvailableQuantity": 0,
327 "remainingQuantity": 0,
328 "availableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "purchaseRequisitionIds": [
340 0
341 ],
342 "purchaseRequisitionDisplayIds": [
343 "string"
344 ],
345 "invoices": [
346 {
347 "id": 0,
348 "displayId": "string",
349 "name": "string",
350 "invoiceType": "VENDOR_INV",
351 "state": "INV_DRAFT",
352 "externalDocumentNumber": "string",
353 "purchaseOrderReference": "string",
354 "invoiceDate": "2019-08-24",
355 "dueDate": "2019-08-24",
356 "notes": "string",
357 "billingPeriodFromDate": "2019-08-24",
358 "billingPeriodToDate": "2019-08-24",
359 "currency": {
360 "id": 0,
361 "displayId": "string",
362 "status": "CREATED",
363 "name": "string",
364 "decimalPoints": 0
365 },
366 "vendor": {
367 "id": 0,
368 "displayId": "string",
369 "status": "CREATED",
370 "name": "string",
371 "erpSystemDisplayId": "string"
372 },
373 "company": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "erpSystemId": 0,
378 "erpSystemDisplayId": "string",
379 "countryId": 0,
380 "countryDisplayId": "string",
381 "name": "string",
382 "postingPeriodVariantId": 0,
383 "fiscalVariantId": 0
384 },
385 "netAmount": 0,
386 "taxAmount": 0,
387 "totalAmount": 0,
388 "netAmountBalance": 0,
389 "taxAmountBalance": 0,
390 "paymentTerm": {
391 "id": 0,
392 "displayId": "string",
393 "status": "CREATED",
394 "name": "string"
395 },
396 "paymentMethod": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "type": "string"
402 },
403 "paymentBlock": {
404 "id": 0,
405 "displayId": "string",
406 "status": "CREATED",
407 "name": "string"
408 },
409 "defaultCostCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "defaultProfitCenter": {
417 "id": 0,
418 "displayId": "string",
419 "status": "CREATED",
420 "name": "string",
421 "validTo": "2019-08-24",
422 "erpSystemId": 0,
423 "erpSystemDisplayId": "string"
424 },
425 "invoiceLineItems": [
426 {
427 "id": 0,
428 "displayId": "string",
429 "expenseCategory": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "expenseCategoryType": "PAYMENT"
435 },
436 "description": "string",
437 "unitOfMeasure": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "erpSystemId": 0
443 },
444 "quantity": 0,
445 "unitPrice": 0,
446 "taxJurisdiction": {
447 "id": 0,
448 "displayId": "string",
449 "status": "CREATED",
450 "name": "string",
451 "erpSystemId": 0,
452 "schema": "string",
453 "countryDisplayId": "string"
454 },
455 "taxCode": {
456 "id": 0,
457 "displayId": "string",
458 "status": "CREATED",
459 "name": "string",
460 "erpSystemId": 0
461 },
462 "taxExpenseAccount": {
463 "id": 0,
464 "displayId": "string",
465 "generalLedgerAccountName": "string",
466 "generalLedgerAccountCode": "string",
467 "openItemManagement": true,
468 "accountCategory": "BALANCESHEET",
469 "shortName": "string",
470 "longName": "string"
471 },
472 "taxLineItems": [
473 {
474 "id": 0,
475 "taxRate": 0.1,
476 "taxAmount": 0,
477 "taxType": "string",
478 "invoiceLineItemId": 0
479 }
480 ],
481 "workBreakdownStructure": {
482 "id": 0,
483 "displayId": "string",
484 "status": "CREATED",
485 "name": "string",
486 "erpSystemId": 0
487 },
488 "costCenter": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "profitCenter": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "validTo": "2019-08-24",
501 "erpSystemId": 0,
502 "erpSystemDisplayId": "string"
503 },
504 "functionalArea": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "businessArea": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "segment": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "erpSystemId": 0
524 },
525 "network": {
526 "id": 0,
527 "displayId": "string",
528 "status": "CREATED",
529 "name": "string",
530 "erpSystemId": 0
531 },
532 "internalOrderType": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "internalOrder": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0,
545 "internalOrderTypeId": 0
546 },
547 "additionalCurrencies": [
548 {
549 "id": 0,
550 "amount": 0,
551 "currency": {
552 "id": 0,
553 "displayId": "string",
554 "status": "CREATED",
555 "name": "string",
556 "decimalPoints": 0
557 },
558 "conversionRate": 0,
559 "conversionDate": "2019-08-24",
560 "translationDateType": "DOCUMENT_DATE",
561 "amountType": "NET_AMOUNT",
562 "currencyDefinitionType": "CONTRACT_CURRENCY",
563 "invoiceEntryId": 0,
564 "invoiceEntryDisplayId": "string"
565 }
566 ],
567 "scheduledPaymentMatches": [
568 {
569 "id": 0,
570 "fromId": 0,
571 "toId": 0,
572 "amount": 0
573 }
574 ],
575 "goodsReceiptLineItemLinks": [
576 {
577 "id": 0,
578 "fromId": 0,
579 "toId": 0,
580 "linkedQuantity": 0
581 }
582 ],
583 "invoiceId": 0,
584 "invoiceDisplayId": "string",
585 "invoiceState": "INV_DRAFT",
586 "vendorPaymentId": 0,
587 "purchaseOrderLineItemId": 0,
588 "netAmount": 0,
589 "allowsSystemGenerateNewId": true,
590 "numberRangeIdentifierValue": "string",
591 "numberRangeIdentifierType": {
592 "name": "string"
593 },
594 "numberRangeType": {
595 "name": "string"
596 }
597 }
598 ],
599 "workspaceId": 0,
600 "workspaceDisplayId": "string",
601 "workspaceName": "string",
602 "workspaceState": "INV_DRAFT",
603 "remainingNetAmount": 0,
604 "remainingTaxAmount": 0,
605 "remainingTotalAmount": 0,
606 "pendingPaymentCount": 0,
607 "allPaymentsPosted": true,
608 "approvalInfo": {
609 "approverUsername": "string",
610 "approvedAt": "2019-08-24T14:15:22Z"
611 },
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "rejectionReason": "string",
624 "allowsSystemGenerateNewId": true,
625 "numberRangeIdentifierValue": "string",
626 "numberRangeIdentifierType": {
627 "name": "string"
628 },
629 "numberRangeType": {
630 "name": "string"
631 }
632 }
633}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/purchase-order/bulk
📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response
errorslist. The response body always contains the successfully updated items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of purchase order details, including item specifications, quantities, and supplier information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "state": "INV_DRAFT",
6 "issueDate": "2019-08-24",
7 "expectedDeliveryDate": "2019-08-24",
8 "name": "string",
9 "shippingAddress": "string",
10 "notes": "string",
11 "netAmount": 0,
12 "taxAmount": 0,
13 "externalPurchaseOrderDisplayId": "string",
14 "vendor": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "erpSystemDisplayId": "string"
20 },
21 "currency": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "decimalPoints": 0
27 },
28 "company": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "countryId": 0,
35 "countryDisplayId": "string",
36 "name": "string",
37 "postingPeriodVariantId": 0,
38 "fiscalVariantId": 0
39 },
40 "purchaseOrderLineItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 0,
46 "receivedQuantity": 0,
47 "unitPrice": 0,
48 "description": "string",
49 "expenseCategory": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "expenseCategoryType": "PAYMENT"
55 },
56 "costCenter": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 },
63 "profitCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "validTo": "2019-08-24",
69 "erpSystemId": 0,
70 "erpSystemDisplayId": "string"
71 },
72 "taxJurisdiction": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0,
78 "schema": "string",
79 "countryDisplayId": "string"
80 },
81 "taxCode": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0
87 },
88 "taxLineItems": [
89 {
90 "id": 0,
91 "taxRate": 0.1,
92 "taxAmount": 0,
93 "taxType": "string",
94 "purchaseOrderLineItemId": 0
95 }
96 ],
97 "purchaseOrderId": 0,
98 "purchaseOrderDisplayId": "string",
99 "purchaseOrderState": "INV_DRAFT",
100 "invoiceLineItems": [
101 {
102 "id": 0,
103 "displayId": "string",
104 "expenseCategory": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "expenseCategoryType": "PAYMENT"
110 },
111 "description": "string",
112 "unitOfMeasure": {
113 "id": 0,
114 "displayId": "string",
115 "status": "CREATED",
116 "name": "string",
117 "erpSystemId": 0
118 },
119 "quantity": 0,
120 "unitPrice": 0,
121 "taxJurisdiction": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "erpSystemId": 0,
127 "schema": "string",
128 "countryDisplayId": "string"
129 },
130 "taxCode": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "taxExpenseAccount": {
138 "id": 0,
139 "displayId": "string",
140 "generalLedgerAccountName": "string",
141 "generalLedgerAccountCode": "string",
142 "openItemManagement": true,
143 "accountCategory": "BALANCESHEET",
144 "shortName": "string",
145 "longName": "string"
146 },
147 "taxLineItems": [
148 {
149 "id": 0,
150 "taxRate": 0.1,
151 "taxAmount": 0,
152 "taxType": "string",
153 "invoiceLineItemId": 0
154 }
155 ],
156 "workBreakdownStructure": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "erpSystemId": 0
162 },
163 "costCenter": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "profitCenter": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string",
175 "validTo": "2019-08-24",
176 "erpSystemId": 0,
177 "erpSystemDisplayId": "string"
178 },
179 "functionalArea": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "businessArea": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "segment": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "network": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "internalOrderType": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "internalOrder": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0,
220 "internalOrderTypeId": 0
221 },
222 "additionalCurrencies": [
223 {
224 "id": 0,
225 "amount": 0,
226 "currency": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "decimalPoints": 0
232 },
233 "conversionRate": 0,
234 "conversionDate": "2019-08-24",
235 "translationDateType": "DOCUMENT_DATE",
236 "amountType": "NET_AMOUNT",
237 "currencyDefinitionType": "CONTRACT_CURRENCY",
238 "invoiceEntryId": 0,
239 "invoiceEntryDisplayId": "string"
240 }
241 ],
242 "scheduledPaymentMatches": [
243 {
244 "id": 0,
245 "fromId": 0,
246 "toId": 0,
247 "amount": 0
248 }
249 ],
250 "goodsReceiptLineItemLinks": [
251 {
252 "id": 0,
253 "fromId": 0,
254 "toId": 0,
255 "linkedQuantity": 0
256 }
257 ],
258 "invoiceId": 0,
259 "invoiceDisplayId": "string",
260 "invoiceState": "INV_DRAFT",
261 "vendorPaymentId": 0,
262 "purchaseOrderLineItemId": 0,
263 "netAmount": 0,
264 "allowsSystemGenerateNewId": true,
265 "numberRangeIdentifierValue": "string",
266 "numberRangeIdentifierType": {
267 "name": "string"
268 },
269 "numberRangeType": {
270 "name": "string"
271 }
272 }
273 ],
274 "goodsReceiptLineItems": [
275 {
276 "id": 0,
277 "displayId": "string",
278 "quantity": 0,
279 "invoicedQuantity": 0,
280 "description": "string",
281 "expenseCategory": {
282 "id": 0,
283 "displayId": "string",
284 "status": "CREATED",
285 "name": "string",
286 "expenseCategoryType": "PAYMENT"
287 },
288 "goodsReceiptId": 0,
289 "goodsReceiptDisplayId": "string",
290 "goodsReceiptState": "INV_DRAFT",
291 "purchaseOrderLineItemId": 0,
292 "invoiceLineItemLinks": [
293 {
294 "id": 0,
295 "fromId": 0,
296 "toId": 0,
297 "linkedQuantity": 0
298 }
299 ],
300 "allowsSystemGenerateNewId": true,
301 "numberRangeIdentifierValue": "string",
302 "numberRangeIdentifierType": {
303 "name": "string"
304 },
305 "numberRangeType": {
306 "name": "string"
307 }
308 }
309 ],
310 "vendorPaymentId": 0,
311 "purchaseRequisitionLineItemId": 0,
312 "purchaseRequisitionDisplayId": "string",
313 "purchaseRequisitionLineItemAvailableQuantity": 0,
314 "allowsSystemGenerateNewId": true,
315 "numberRangeIdentifierValue": "string",
316 "numberRangeIdentifierType": {
317 "name": "string"
318 },
319 "numberRangeType": {
320 "name": "string"
321 }
322 }
323 ],
324 "purchaseRequisitionIds": [
325 0
326 ],
327 "purchaseRequisitionDisplayIds": [
328 "string"
329 ],
330 "invoices": [
331 {
332 "id": 0,
333 "displayId": "string",
334 "name": "string",
335 "invoiceType": "VENDOR_INV",
336 "state": "INV_DRAFT",
337 "externalDocumentNumber": "string",
338 "purchaseOrderReference": "string",
339 "invoiceDate": "2019-08-24",
340 "dueDate": "2019-08-24",
341 "notes": "string",
342 "billingPeriodFromDate": "2019-08-24",
343 "billingPeriodToDate": "2019-08-24",
344 "currency": {
345 "id": 0,
346 "displayId": "string",
347 "status": "CREATED",
348 "name": "string",
349 "decimalPoints": 0
350 },
351 "vendor": {
352 "id": 0,
353 "displayId": "string",
354 "status": "CREATED",
355 "name": "string",
356 "erpSystemDisplayId": "string"
357 },
358 "company": {
359 "id": 0,
360 "displayId": "string",
361 "status": "CREATED",
362 "erpSystemId": 0,
363 "erpSystemDisplayId": "string",
364 "countryId": 0,
365 "countryDisplayId": "string",
366 "name": "string",
367 "postingPeriodVariantId": 0,
368 "fiscalVariantId": 0
369 },
370 "netAmount": 0,
371 "taxAmount": 0,
372 "totalAmount": 0,
373 "netAmountBalance": 0,
374 "taxAmountBalance": 0,
375 "paymentTerm": {
376 "id": 0,
377 "displayId": "string",
378 "status": "CREATED",
379 "name": "string"
380 },
381 "paymentMethod": {
382 "id": 0,
383 "displayId": "string",
384 "status": "CREATED",
385 "name": "string",
386 "type": "string"
387 },
388 "paymentBlock": {
389 "id": 0,
390 "displayId": "string",
391 "status": "CREATED",
392 "name": "string"
393 },
394 "defaultCostCenter": {
395 "id": 0,
396 "displayId": "string",
397 "status": "CREATED",
398 "name": "string",
399 "erpSystemId": 0
400 },
401 "defaultProfitCenter": {
402 "id": 0,
403 "displayId": "string",
404 "status": "CREATED",
405 "name": "string",
406 "validTo": "2019-08-24",
407 "erpSystemId": 0,
408 "erpSystemDisplayId": "string"
409 },
410 "invoiceLineItems": [
411 {
412 "id": 0,
413 "displayId": "string",
414 "expenseCategory": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "expenseCategoryType": "PAYMENT"
420 },
421 "description": "string",
422 "unitOfMeasure": {
423 "id": 0,
424 "displayId": "string",
425 "status": "CREATED",
426 "name": "string",
427 "erpSystemId": 0
428 },
429 "quantity": 0,
430 "unitPrice": 0,
431 "taxJurisdiction": {
432 "id": 0,
433 "displayId": "string",
434 "status": "CREATED",
435 "name": "string",
436 "erpSystemId": 0,
437 "schema": "string",
438 "countryDisplayId": "string"
439 },
440 "taxCode": {
441 "id": 0,
442 "displayId": "string",
443 "status": "CREATED",
444 "name": "string",
445 "erpSystemId": 0
446 },
447 "taxExpenseAccount": {
448 "id": 0,
449 "displayId": "string",
450 "generalLedgerAccountName": "string",
451 "generalLedgerAccountCode": "string",
452 "openItemManagement": true,
453 "accountCategory": "BALANCESHEET",
454 "shortName": "string",
455 "longName": "string"
456 },
457 "taxLineItems": [
458 {
459 "id": 0,
460 "taxRate": 0.1,
461 "taxAmount": 0,
462 "taxType": "string",
463 "invoiceLineItemId": 0
464 }
465 ],
466 "workBreakdownStructure": {
467 "id": 0,
468 "displayId": "string",
469 "status": "CREATED",
470 "name": "string",
471 "erpSystemId": 0
472 },
473 "costCenter": {
474 "id": 0,
475 "displayId": "string",
476 "status": "CREATED",
477 "name": "string",
478 "erpSystemId": 0
479 },
480 "profitCenter": {
481 "id": 0,
482 "displayId": "string",
483 "status": "CREATED",
484 "name": "string",
485 "validTo": "2019-08-24",
486 "erpSystemId": 0,
487 "erpSystemDisplayId": "string"
488 },
489 "functionalArea": {
490 "id": 0,
491 "displayId": "string",
492 "status": "CREATED",
493 "name": "string",
494 "erpSystemId": 0
495 },
496 "businessArea": {
497 "id": 0,
498 "displayId": "string",
499 "status": "CREATED",
500 "name": "string",
501 "erpSystemId": 0
502 },
503 "segment": {
504 "id": 0,
505 "displayId": "string",
506 "status": "CREATED",
507 "name": "string",
508 "erpSystemId": 0
509 },
510 "network": {
511 "id": 0,
512 "displayId": "string",
513 "status": "CREATED",
514 "name": "string",
515 "erpSystemId": 0
516 },
517 "internalOrderType": {
518 "id": 0,
519 "displayId": "string",
520 "status": "CREATED",
521 "name": "string",
522 "erpSystemId": 0
523 },
524 "internalOrder": {
525 "id": 0,
526 "displayId": "string",
527 "status": "CREATED",
528 "name": "string",
529 "erpSystemId": 0,
530 "internalOrderTypeId": 0
531 },
532 "additionalCurrencies": [
533 {
534 "id": 0,
535 "amount": 0,
536 "currency": {
537 "id": 0,
538 "displayId": "string",
539 "status": "CREATED",
540 "name": "string",
541 "decimalPoints": 0
542 },
543 "conversionRate": 0,
544 "conversionDate": "2019-08-24",
545 "translationDateType": "DOCUMENT_DATE",
546 "amountType": "NET_AMOUNT",
547 "currencyDefinitionType": "CONTRACT_CURRENCY",
548 "invoiceEntryId": 0,
549 "invoiceEntryDisplayId": "string"
550 }
551 ],
552 "scheduledPaymentMatches": [
553 {
554 "id": 0,
555 "fromId": 0,
556 "toId": 0,
557 "amount": 0
558 }
559 ],
560 "goodsReceiptLineItemLinks": [
561 {
562 "id": 0,
563 "fromId": 0,
564 "toId": 0,
565 "linkedQuantity": 0
566 }
567 ],
568 "invoiceId": 0,
569 "invoiceDisplayId": "string",
570 "invoiceState": "INV_DRAFT",
571 "vendorPaymentId": 0,
572 "purchaseOrderLineItemId": 0,
573 "netAmount": 0,
574 "allowsSystemGenerateNewId": true,
575 "numberRangeIdentifierValue": "string",
576 "numberRangeIdentifierType": {
577 "name": "string"
578 },
579 "numberRangeType": {
580 "name": "string"
581 }
582 }
583 ],
584 "workspaceId": 0,
585 "workspaceDisplayId": "string",
586 "workspaceName": "string",
587 "workspaceState": "INV_DRAFT",
588 "remainingNetAmount": 0,
589 "remainingTaxAmount": 0,
590 "remainingTotalAmount": 0,
591 "pendingPaymentCount": 0,
592 "allPaymentsPosted": true,
593 "approvalInfo": {
594 "approverUsername": "string",
595 "approvedAt": "2019-08-24T14:15:22Z"
596 },
597 "rejectionReason": "string",
598 "allowsSystemGenerateNewId": true,
599 "numberRangeIdentifierValue": "string",
600 "numberRangeIdentifierType": {
601 "name": "string"
602 },
603 "numberRangeType": {
604 "name": "string"
605 }
606 }
607 ],
608 "rejectionReason": "string",
609 "allowsSystemGenerateNewId": true,
610 "numberRangeIdentifierValue": "string",
611 "numberRangeIdentifierType": {
612 "name": "string"
613 },
614 "numberRangeType": {
615 "name": "string"
616 }
617 }
618]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "state": "INV_DRAFT",
19 "issueDate": "2019-08-24",
20 "expectedDeliveryDate": "2019-08-24",
21 "name": "string",
22 "shippingAddress": "string",
23 "notes": "string",
24 "netAmount": 0,
25 "taxAmount": 0,
26 "externalPurchaseOrderDisplayId": "string",
27 "vendor": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "erpSystemDisplayId": "string"
33 },
34 "currency": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "decimalPoints": 0
40 },
41 "company": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "erpSystemId": 0,
46 "erpSystemDisplayId": "string",
47 "countryId": 0,
48 "countryDisplayId": "string",
49 "name": "string",
50 "postingPeriodVariantId": 0,
51 "fiscalVariantId": 0
52 },
53 "purchaseOrderLineItems": [
54 {
55 "id": 0,
56 "displayId": "string",
57 "quantity": 0,
58 "allocatedQuantity": 0,
59 "receivedQuantity": 0,
60 "unitPrice": 0,
61 "description": "string",
62 "expenseCategory": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "expenseCategoryType": "PAYMENT"
68 },
69 "costCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "profitCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "validTo": "2019-08-24",
82 "erpSystemId": 0,
83 "erpSystemDisplayId": "string"
84 },
85 "taxJurisdiction": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0,
91 "schema": "string",
92 "countryDisplayId": "string"
93 },
94 "taxCode": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "taxLineItems": [
102 {
103 "id": 0,
104 "taxRate": 0.1,
105 "taxAmount": 0,
106 "taxType": "string",
107 "purchaseOrderLineItemId": 0
108 }
109 ],
110 "purchaseOrderId": 0,
111 "purchaseOrderDisplayId": "string",
112 "purchaseOrderState": "INV_DRAFT",
113 "invoiceLineItems": [
114 {
115 "id": 0,
116 "displayId": "string",
117 "expenseCategory": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "expenseCategoryType": "PAYMENT"
123 },
124 "description": "string",
125 "unitOfMeasure": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "quantity": 0,
133 "unitPrice": 0,
134 "taxJurisdiction": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0,
140 "schema": "string",
141 "countryDisplayId": "string"
142 },
143 "taxCode": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "erpSystemId": 0
149 },
150 "taxExpenseAccount": {
151 "id": 0,
152 "displayId": "string",
153 "generalLedgerAccountName": "string",
154 "generalLedgerAccountCode": "string",
155 "openItemManagement": true,
156 "accountCategory": "BALANCESHEET",
157 "shortName": "string",
158 "longName": "string"
159 },
160 "taxLineItems": [
161 {
162 "id": 0,
163 "taxRate": 0.1,
164 "taxAmount": 0,
165 "taxType": "string",
166 "invoiceLineItemId": 0
167 }
168 ],
169 "workBreakdownStructure": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "costCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 },
183 "profitCenter": {
184 "id": 0,
185 "displayId": "string",
186 "status": "CREATED",
187 "name": "string",
188 "validTo": "2019-08-24",
189 "erpSystemId": 0,
190 "erpSystemDisplayId": "string"
191 },
192 "functionalArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "businessArea": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "segment": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "network": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrderType": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0
226 },
227 "internalOrder": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "erpSystemId": 0,
233 "internalOrderTypeId": 0
234 },
235 "additionalCurrencies": [
236 {
237 "id": 0,
238 "amount": 0,
239 "currency": {
240 "id": 0,
241 "displayId": "string",
242 "status": "CREATED",
243 "name": "string",
244 "decimalPoints": 0
245 },
246 "conversionRate": 0,
247 "conversionDate": "2019-08-24",
248 "translationDateType": "DOCUMENT_DATE",
249 "amountType": "NET_AMOUNT",
250 "currencyDefinitionType": "CONTRACT_CURRENCY",
251 "invoiceEntryId": 0,
252 "invoiceEntryDisplayId": "string"
253 }
254 ],
255 "scheduledPaymentMatches": [
256 {
257 "id": 0,
258 "fromId": 0,
259 "toId": 0,
260 "amount": 0
261 }
262 ],
263 "goodsReceiptLineItemLinks": [
264 {
265 "id": 0,
266 "fromId": 0,
267 "toId": 0,
268 "linkedQuantity": 0
269 }
270 ],
271 "invoiceId": 0,
272 "invoiceDisplayId": "string",
273 "invoiceState": "INV_DRAFT",
274 "vendorPaymentId": 0,
275 "purchaseOrderLineItemId": 0,
276 "netAmount": 0,
277 "allowsSystemGenerateNewId": true,
278 "numberRangeIdentifierValue": "string",
279 "numberRangeIdentifierType": {
280 "name": "string"
281 },
282 "numberRangeType": {
283 "name": "string"
284 }
285 }
286 ],
287 "goodsReceiptLineItems": [
288 {
289 "id": 0,
290 "displayId": "string",
291 "quantity": 0,
292 "invoicedQuantity": 0,
293 "description": "string",
294 "expenseCategory": {
295 "id": 0,
296 "displayId": "string",
297 "status": "CREATED",
298 "name": "string",
299 "expenseCategoryType": "PAYMENT"
300 },
301 "goodsReceiptId": 0,
302 "goodsReceiptDisplayId": "string",
303 "goodsReceiptState": "INV_DRAFT",
304 "purchaseOrderLineItemId": 0,
305 "invoiceLineItemLinks": [
306 {
307 "id": 0,
308 "fromId": 0,
309 "toId": 0,
310 "linkedQuantity": 0
311 }
312 ],
313 "availableQuantity": 0,
314 "allowsSystemGenerateNewId": true,
315 "numberRangeIdentifierValue": "string",
316 "numberRangeIdentifierType": {
317 "name": "string"
318 },
319 "numberRangeType": {
320 "name": "string"
321 }
322 }
323 ],
324 "vendorPaymentId": 0,
325 "purchaseRequisitionLineItemId": 0,
326 "purchaseRequisitionDisplayId": "string",
327 "purchaseRequisitionLineItemAvailableQuantity": 0,
328 "remainingQuantity": 0,
329 "availableQuantity": 0,
330 "allowsSystemGenerateNewId": true,
331 "numberRangeIdentifierValue": "string",
332 "numberRangeIdentifierType": {
333 "name": "string"
334 },
335 "numberRangeType": {
336 "name": "string"
337 }
338 }
339 ],
340 "purchaseRequisitionIds": [
341 0
342 ],
343 "purchaseRequisitionDisplayIds": [
344 "string"
345 ],
346 "invoices": [
347 {
348 "id": 0,
349 "displayId": "string",
350 "name": "string",
351 "invoiceType": "VENDOR_INV",
352 "state": "INV_DRAFT",
353 "externalDocumentNumber": "string",
354 "purchaseOrderReference": "string",
355 "invoiceDate": "2019-08-24",
356 "dueDate": "2019-08-24",
357 "notes": "string",
358 "billingPeriodFromDate": "2019-08-24",
359 "billingPeriodToDate": "2019-08-24",
360 "currency": {
361 "id": 0,
362 "displayId": "string",
363 "status": "CREATED",
364 "name": "string",
365 "decimalPoints": 0
366 },
367 "vendor": {
368 "id": 0,
369 "displayId": "string",
370 "status": "CREATED",
371 "name": "string",
372 "erpSystemDisplayId": "string"
373 },
374 "company": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "erpSystemId": 0,
379 "erpSystemDisplayId": "string",
380 "countryId": 0,
381 "countryDisplayId": "string",
382 "name": "string",
383 "postingPeriodVariantId": 0,
384 "fiscalVariantId": 0
385 },
386 "netAmount": 0,
387 "taxAmount": 0,
388 "totalAmount": 0,
389 "netAmountBalance": 0,
390 "taxAmountBalance": 0,
391 "paymentTerm": {
392 "id": 0,
393 "displayId": "string",
394 "status": "CREATED",
395 "name": "string"
396 },
397 "paymentMethod": {
398 "id": 0,
399 "displayId": "string",
400 "status": "CREATED",
401 "name": "string",
402 "type": "string"
403 },
404 "paymentBlock": {
405 "id": 0,
406 "displayId": "string",
407 "status": "CREATED",
408 "name": "string"
409 },
410 "defaultCostCenter": {
411 "id": 0,
412 "displayId": "string",
413 "status": "CREATED",
414 "name": "string",
415 "erpSystemId": 0
416 },
417 "defaultProfitCenter": {
418 "id": 0,
419 "displayId": "string",
420 "status": "CREATED",
421 "name": "string",
422 "validTo": "2019-08-24",
423 "erpSystemId": 0,
424 "erpSystemDisplayId": "string"
425 },
426 "invoiceLineItems": [
427 {
428 "id": 0,
429 "displayId": "string",
430 "expenseCategory": {
431 "id": 0,
432 "displayId": "string",
433 "status": "CREATED",
434 "name": "string",
435 "expenseCategoryType": "PAYMENT"
436 },
437 "description": "string",
438 "unitOfMeasure": {
439 "id": 0,
440 "displayId": "string",
441 "status": "CREATED",
442 "name": "string",
443 "erpSystemId": 0
444 },
445 "quantity": 0,
446 "unitPrice": 0,
447 "taxJurisdiction": {
448 "id": 0,
449 "displayId": "string",
450 "status": "CREATED",
451 "name": "string",
452 "erpSystemId": 0,
453 "schema": "string",
454 "countryDisplayId": "string"
455 },
456 "taxCode": {
457 "id": 0,
458 "displayId": "string",
459 "status": "CREATED",
460 "name": "string",
461 "erpSystemId": 0
462 },
463 "taxExpenseAccount": {
464 "id": 0,
465 "displayId": "string",
466 "generalLedgerAccountName": "string",
467 "generalLedgerAccountCode": "string",
468 "openItemManagement": true,
469 "accountCategory": "BALANCESHEET",
470 "shortName": "string",
471 "longName": "string"
472 },
473 "taxLineItems": [
474 {
475 "id": 0,
476 "taxRate": 0.1,
477 "taxAmount": 0,
478 "taxType": "string",
479 "invoiceLineItemId": 0
480 }
481 ],
482 "workBreakdownStructure": {
483 "id": 0,
484 "displayId": "string",
485 "status": "CREATED",
486 "name": "string",
487 "erpSystemId": 0
488 },
489 "costCenter": {
490 "id": 0,
491 "displayId": "string",
492 "status": "CREATED",
493 "name": "string",
494 "erpSystemId": 0
495 },
496 "profitCenter": {
497 "id": 0,
498 "displayId": "string",
499 "status": "CREATED",
500 "name": "string",
501 "validTo": "2019-08-24",
502 "erpSystemId": 0,
503 "erpSystemDisplayId": "string"
504 },
505 "functionalArea": {
506 "id": 0,
507 "displayId": "string",
508 "status": "CREATED",
509 "name": "string",
510 "erpSystemId": 0
511 },
512 "businessArea": {
513 "id": 0,
514 "displayId": "string",
515 "status": "CREATED",
516 "name": "string",
517 "erpSystemId": 0
518 },
519 "segment": {
520 "id": 0,
521 "displayId": "string",
522 "status": "CREATED",
523 "name": "string",
524 "erpSystemId": 0
525 },
526 "network": {
527 "id": 0,
528 "displayId": "string",
529 "status": "CREATED",
530 "name": "string",
531 "erpSystemId": 0
532 },
533 "internalOrderType": {
534 "id": 0,
535 "displayId": "string",
536 "status": "CREATED",
537 "name": "string",
538 "erpSystemId": 0
539 },
540 "internalOrder": {
541 "id": 0,
542 "displayId": "string",
543 "status": "CREATED",
544 "name": "string",
545 "erpSystemId": 0,
546 "internalOrderTypeId": 0
547 },
548 "additionalCurrencies": [
549 {
550 "id": 0,
551 "amount": 0,
552 "currency": {
553 "id": 0,
554 "displayId": "string",
555 "status": "CREATED",
556 "name": "string",
557 "decimalPoints": 0
558 },
559 "conversionRate": 0,
560 "conversionDate": "2019-08-24",
561 "translationDateType": "DOCUMENT_DATE",
562 "amountType": "NET_AMOUNT",
563 "currencyDefinitionType": "CONTRACT_CURRENCY",
564 "invoiceEntryId": 0,
565 "invoiceEntryDisplayId": "string"
566 }
567 ],
568 "scheduledPaymentMatches": [
569 {
570 "id": 0,
571 "fromId": 0,
572 "toId": 0,
573 "amount": 0
574 }
575 ],
576 "goodsReceiptLineItemLinks": [
577 {
578 "id": 0,
579 "fromId": 0,
580 "toId": 0,
581 "linkedQuantity": 0
582 }
583 ],
584 "invoiceId": 0,
585 "invoiceDisplayId": "string",
586 "invoiceState": "INV_DRAFT",
587 "vendorPaymentId": 0,
588 "purchaseOrderLineItemId": 0,
589 "netAmount": 0,
590 "allowsSystemGenerateNewId": true,
591 "numberRangeIdentifierValue": "string",
592 "numberRangeIdentifierType": {
593 "name": "string"
594 },
595 "numberRangeType": {
596 "name": "string"
597 }
598 }
599 ],
600 "workspaceId": 0,
601 "workspaceDisplayId": "string",
602 "workspaceName": "string",
603 "workspaceState": "INV_DRAFT",
604 "remainingNetAmount": 0,
605 "remainingTaxAmount": 0,
606 "remainingTotalAmount": 0,
607 "pendingPaymentCount": 0,
608 "allPaymentsPosted": true,
609 "approvalInfo": {
610 "approverUsername": "string",
611 "approvedAt": "2019-08-24T14:15:22Z"
612 },
613 "rejectionReason": "string",
614 "allowsSystemGenerateNewId": true,
615 "numberRangeIdentifierValue": "string",
616 "numberRangeIdentifierType": {
617 "name": "string"
618 },
619 "numberRangeType": {
620 "name": "string"
621 }
622 }
623 ],
624 "rejectionReason": "string",
625 "allowsSystemGenerateNewId": true,
626 "numberRangeIdentifierValue": "string",
627 "numberRangeIdentifierType": {
628 "name": "string"
629 },
630 "numberRangeType": {
631 "name": "string"
632 }
633 }
634 ]
635}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/purchase-order/bulk
📋 Description: Creates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully created items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of purchase order details, including item specifications, quantities, and supplier information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "state": "INV_DRAFT",
6 "issueDate": "2019-08-24",
7 "expectedDeliveryDate": "2019-08-24",
8 "name": "string",
9 "shippingAddress": "string",
10 "notes": "string",
11 "netAmount": 0,
12 "taxAmount": 0,
13 "externalPurchaseOrderDisplayId": "string",
14 "vendor": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "name": "string",
19 "erpSystemDisplayId": "string"
20 },
21 "currency": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string",
26 "decimalPoints": 0
27 },
28 "company": {
29 "id": 0,
30 "displayId": "string",
31 "status": "CREATED",
32 "erpSystemId": 0,
33 "erpSystemDisplayId": "string",
34 "countryId": 0,
35 "countryDisplayId": "string",
36 "name": "string",
37 "postingPeriodVariantId": 0,
38 "fiscalVariantId": 0
39 },
40 "purchaseOrderLineItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 0,
46 "receivedQuantity": 0,
47 "unitPrice": 0,
48 "description": "string",
49 "expenseCategory": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "expenseCategoryType": "PAYMENT"
55 },
56 "costCenter": {
57 "id": 0,
58 "displayId": "string",
59 "status": "CREATED",
60 "name": "string",
61 "erpSystemId": 0
62 },
63 "profitCenter": {
64 "id": 0,
65 "displayId": "string",
66 "status": "CREATED",
67 "name": "string",
68 "validTo": "2019-08-24",
69 "erpSystemId": 0,
70 "erpSystemDisplayId": "string"
71 },
72 "taxJurisdiction": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0,
78 "schema": "string",
79 "countryDisplayId": "string"
80 },
81 "taxCode": {
82 "id": 0,
83 "displayId": "string",
84 "status": "CREATED",
85 "name": "string",
86 "erpSystemId": 0
87 },
88 "taxLineItems": [
89 {
90 "id": 0,
91 "taxRate": 0.1,
92 "taxAmount": 0,
93 "taxType": "string",
94 "purchaseOrderLineItemId": 0
95 }
96 ],
97 "purchaseOrderId": 0,
98 "purchaseOrderDisplayId": "string",
99 "purchaseOrderState": "INV_DRAFT",
100 "invoiceLineItems": [
101 {
102 "id": 0,
103 "displayId": "string",
104 "expenseCategory": {
105 "id": 0,
106 "displayId": "string",
107 "status": "CREATED",
108 "name": "string",
109 "expenseCategoryType": "PAYMENT"
110 },
111 "description": "string",
112 "unitOfMeasure": {
113 "id": 0,
114 "displayId": "string",
115 "status": "CREATED",
116 "name": "string",
117 "erpSystemId": 0
118 },
119 "quantity": 0,
120 "unitPrice": 0,
121 "taxJurisdiction": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "erpSystemId": 0,
127 "schema": "string",
128 "countryDisplayId": "string"
129 },
130 "taxCode": {
131 "id": 0,
132 "displayId": "string",
133 "status": "CREATED",
134 "name": "string",
135 "erpSystemId": 0
136 },
137 "taxExpenseAccount": {
138 "id": 0,
139 "displayId": "string",
140 "generalLedgerAccountName": "string",
141 "generalLedgerAccountCode": "string",
142 "openItemManagement": true,
143 "accountCategory": "BALANCESHEET",
144 "shortName": "string",
145 "longName": "string"
146 },
147 "taxLineItems": [
148 {
149 "id": 0,
150 "taxRate": 0.1,
151 "taxAmount": 0,
152 "taxType": "string",
153 "invoiceLineItemId": 0
154 }
155 ],
156 "workBreakdownStructure": {
157 "id": 0,
158 "displayId": "string",
159 "status": "CREATED",
160 "name": "string",
161 "erpSystemId": 0
162 },
163 "costCenter": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "profitCenter": {
171 "id": 0,
172 "displayId": "string",
173 "status": "CREATED",
174 "name": "string",
175 "validTo": "2019-08-24",
176 "erpSystemId": 0,
177 "erpSystemDisplayId": "string"
178 },
179 "functionalArea": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "businessArea": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "erpSystemId": 0
192 },
193 "segment": {
194 "id": 0,
195 "displayId": "string",
196 "status": "CREATED",
197 "name": "string",
198 "erpSystemId": 0
199 },
200 "network": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "internalOrderType": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "internalOrder": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0,
220 "internalOrderTypeId": 0
221 },
222 "additionalCurrencies": [
223 {
224 "id": 0,
225 "amount": 0,
226 "currency": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "decimalPoints": 0
232 },
233 "conversionRate": 0,
234 "conversionDate": "2019-08-24",
235 "translationDateType": "DOCUMENT_DATE",
236 "amountType": "NET_AMOUNT",
237 "currencyDefinitionType": "CONTRACT_CURRENCY",
238 "invoiceEntryId": 0,
239 "invoiceEntryDisplayId": "string"
240 }
241 ],
242 "scheduledPaymentMatches": [
243 {
244 "id": 0,
245 "fromId": 0,
246 "toId": 0,
247 "amount": 0
248 }
249 ],
250 "goodsReceiptLineItemLinks": [
251 {
252 "id": 0,
253 "fromId": 0,
254 "toId": 0,
255 "linkedQuantity": 0
256 }
257 ],
258 "invoiceId": 0,
259 "invoiceDisplayId": "string",
260 "invoiceState": "INV_DRAFT",
261 "vendorPaymentId": 0,
262 "purchaseOrderLineItemId": 0,
263 "netAmount": 0,
264 "allowsSystemGenerateNewId": true,
265 "numberRangeIdentifierValue": "string",
266 "numberRangeIdentifierType": {
267 "name": "string"
268 },
269 "numberRangeType": {
270 "name": "string"
271 }
272 }
273 ],
274 "goodsReceiptLineItems": [
275 {
276 "id": 0,
277 "displayId": "string",
278 "quantity": 0,
279 "invoicedQuantity": 0,
280 "description": "string",
281 "expenseCategory": {
282 "id": 0,
283 "displayId": "string",
284 "status": "CREATED",
285 "name": "string",
286 "expenseCategoryType": "PAYMENT"
287 },
288 "goodsReceiptId": 0,
289 "goodsReceiptDisplayId": "string",
290 "goodsReceiptState": "INV_DRAFT",
291 "purchaseOrderLineItemId": 0,
292 "invoiceLineItemLinks": [
293 {
294 "id": 0,
295 "fromId": 0,
296 "toId": 0,
297 "linkedQuantity": 0
298 }
299 ],
300 "allowsSystemGenerateNewId": true,
301 "numberRangeIdentifierValue": "string",
302 "numberRangeIdentifierType": {
303 "name": "string"
304 },
305 "numberRangeType": {
306 "name": "string"
307 }
308 }
309 ],
310 "vendorPaymentId": 0,
311 "purchaseRequisitionLineItemId": 0,
312 "purchaseRequisitionDisplayId": "string",
313 "purchaseRequisitionLineItemAvailableQuantity": 0,
314 "allowsSystemGenerateNewId": true,
315 "numberRangeIdentifierValue": "string",
316 "numberRangeIdentifierType": {
317 "name": "string"
318 },
319 "numberRangeType": {
320 "name": "string"
321 }
322 }
323 ],
324 "purchaseRequisitionIds": [
325 0
326 ],
327 "purchaseRequisitionDisplayIds": [
328 "string"
329 ],
330 "invoices": [
331 {
332 "id": 0,
333 "displayId": "string",
334 "name": "string",
335 "invoiceType": "VENDOR_INV",
336 "state": "INV_DRAFT",
337 "externalDocumentNumber": "string",
338 "purchaseOrderReference": "string",
339 "invoiceDate": "2019-08-24",
340 "dueDate": "2019-08-24",
341 "notes": "string",
342 "billingPeriodFromDate": "2019-08-24",
343 "billingPeriodToDate": "2019-08-24",
344 "currency": {
345 "id": 0,
346 "displayId": "string",
347 "status": "CREATED",
348 "name": "string",
349 "decimalPoints": 0
350 },
351 "vendor": {
352 "id": 0,
353 "displayId": "string",
354 "status": "CREATED",
355 "name": "string",
356 "erpSystemDisplayId": "string"
357 },
358 "company": {
359 "id": 0,
360 "displayId": "string",
361 "status": "CREATED",
362 "erpSystemId": 0,
363 "erpSystemDisplayId": "string",
364 "countryId": 0,
365 "countryDisplayId": "string",
366 "name": "string",
367 "postingPeriodVariantId": 0,
368 "fiscalVariantId": 0
369 },
370 "netAmount": 0,
371 "taxAmount": 0,
372 "totalAmount": 0,
373 "netAmountBalance": 0,
374 "taxAmountBalance": 0,
375 "paymentTerm": {
376 "id": 0,
377 "displayId": "string",
378 "status": "CREATED",
379 "name": "string"
380 },
381 "paymentMethod": {
382 "id": 0,
383 "displayId": "string",
384 "status": "CREATED",
385 "name": "string",
386 "type": "string"
387 },
388 "paymentBlock": {
389 "id": 0,
390 "displayId": "string",
391 "status": "CREATED",
392 "name": "string"
393 },
394 "defaultCostCenter": {
395 "id": 0,
396 "displayId": "string",
397 "status": "CREATED",
398 "name": "string",
399 "erpSystemId": 0
400 },
401 "defaultProfitCenter": {
402 "id": 0,
403 "displayId": "string",
404 "status": "CREATED",
405 "name": "string",
406 "validTo": "2019-08-24",
407 "erpSystemId": 0,
408 "erpSystemDisplayId": "string"
409 },
410 "invoiceLineItems": [
411 {
412 "id": 0,
413 "displayId": "string",
414 "expenseCategory": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "expenseCategoryType": "PAYMENT"
420 },
421 "description": "string",
422 "unitOfMeasure": {
423 "id": 0,
424 "displayId": "string",
425 "status": "CREATED",
426 "name": "string",
427 "erpSystemId": 0
428 },
429 "quantity": 0,
430 "unitPrice": 0,
431 "taxJurisdiction": {
432 "id": 0,
433 "displayId": "string",
434 "status": "CREATED",
435 "name": "string",
436 "erpSystemId": 0,
437 "schema": "string",
438 "countryDisplayId": "string"
439 },
440 "taxCode": {
441 "id": 0,
442 "displayId": "string",
443 "status": "CREATED",
444 "name": "string",
445 "erpSystemId": 0
446 },
447 "taxExpenseAccount": {
448 "id": 0,
449 "displayId": "string",
450 "generalLedgerAccountName": "string",
451 "generalLedgerAccountCode": "string",
452 "openItemManagement": true,
453 "accountCategory": "BALANCESHEET",
454 "shortName": "string",
455 "longName": "string"
456 },
457 "taxLineItems": [
458 {
459 "id": 0,
460 "taxRate": 0.1,
461 "taxAmount": 0,
462 "taxType": "string",
463 "invoiceLineItemId": 0
464 }
465 ],
466 "workBreakdownStructure": {
467 "id": 0,
468 "displayId": "string",
469 "status": "CREATED",
470 "name": "string",
471 "erpSystemId": 0
472 },
473 "costCenter": {
474 "id": 0,
475 "displayId": "string",
476 "status": "CREATED",
477 "name": "string",
478 "erpSystemId": 0
479 },
480 "profitCenter": {
481 "id": 0,
482 "displayId": "string",
483 "status": "CREATED",
484 "name": "string",
485 "validTo": "2019-08-24",
486 "erpSystemId": 0,
487 "erpSystemDisplayId": "string"
488 },
489 "functionalArea": {
490 "id": 0,
491 "displayId": "string",
492 "status": "CREATED",
493 "name": "string",
494 "erpSystemId": 0
495 },
496 "businessArea": {
497 "id": 0,
498 "displayId": "string",
499 "status": "CREATED",
500 "name": "string",
501 "erpSystemId": 0
502 },
503 "segment": {
504 "id": 0,
505 "displayId": "string",
506 "status": "CREATED",
507 "name": "string",
508 "erpSystemId": 0
509 },
510 "network": {
511 "id": 0,
512 "displayId": "string",
513 "status": "CREATED",
514 "name": "string",
515 "erpSystemId": 0
516 },
517 "internalOrderType": {
518 "id": 0,
519 "displayId": "string",
520 "status": "CREATED",
521 "name": "string",
522 "erpSystemId": 0
523 },
524 "internalOrder": {
525 "id": 0,
526 "displayId": "string",
527 "status": "CREATED",
528 "name": "string",
529 "erpSystemId": 0,
530 "internalOrderTypeId": 0
531 },
532 "additionalCurrencies": [
533 {
534 "id": 0,
535 "amount": 0,
536 "currency": {
537 "id": 0,
538 "displayId": "string",
539 "status": "CREATED",
540 "name": "string",
541 "decimalPoints": 0
542 },
543 "conversionRate": 0,
544 "conversionDate": "2019-08-24",
545 "translationDateType": "DOCUMENT_DATE",
546 "amountType": "NET_AMOUNT",
547 "currencyDefinitionType": "CONTRACT_CURRENCY",
548 "invoiceEntryId": 0,
549 "invoiceEntryDisplayId": "string"
550 }
551 ],
552 "scheduledPaymentMatches": [
553 {
554 "id": 0,
555 "fromId": 0,
556 "toId": 0,
557 "amount": 0
558 }
559 ],
560 "goodsReceiptLineItemLinks": [
561 {
562 "id": 0,
563 "fromId": 0,
564 "toId": 0,
565 "linkedQuantity": 0
566 }
567 ],
568 "invoiceId": 0,
569 "invoiceDisplayId": "string",
570 "invoiceState": "INV_DRAFT",
571 "vendorPaymentId": 0,
572 "purchaseOrderLineItemId": 0,
573 "netAmount": 0,
574 "allowsSystemGenerateNewId": true,
575 "numberRangeIdentifierValue": "string",
576 "numberRangeIdentifierType": {
577 "name": "string"
578 },
579 "numberRangeType": {
580 "name": "string"
581 }
582 }
583 ],
584 "workspaceId": 0,
585 "workspaceDisplayId": "string",
586 "workspaceName": "string",
587 "workspaceState": "INV_DRAFT",
588 "remainingNetAmount": 0,
589 "remainingTaxAmount": 0,
590 "remainingTotalAmount": 0,
591 "pendingPaymentCount": 0,
592 "allPaymentsPosted": true,
593 "approvalInfo": {
594 "approverUsername": "string",
595 "approvedAt": "2019-08-24T14:15:22Z"
596 },
597 "rejectionReason": "string",
598 "allowsSystemGenerateNewId": true,
599 "numberRangeIdentifierValue": "string",
600 "numberRangeIdentifierType": {
601 "name": "string"
602 },
603 "numberRangeType": {
604 "name": "string"
605 }
606 }
607 ],
608 "rejectionReason": "string",
609 "allowsSystemGenerateNewId": true,
610 "numberRangeIdentifierValue": "string",
611 "numberRangeIdentifierType": {
612 "name": "string"
613 },
614 "numberRangeType": {
615 "name": "string"
616 }
617 }
618]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "state": "INV_DRAFT",
19 "issueDate": "2019-08-24",
20 "expectedDeliveryDate": "2019-08-24",
21 "name": "string",
22 "shippingAddress": "string",
23 "notes": "string",
24 "netAmount": 0,
25 "taxAmount": 0,
26 "externalPurchaseOrderDisplayId": "string",
27 "vendor": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "name": "string",
32 "erpSystemDisplayId": "string"
33 },
34 "currency": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "decimalPoints": 0
40 },
41 "company": {
42 "id": 0,
43 "displayId": "string",
44 "status": "CREATED",
45 "erpSystemId": 0,
46 "erpSystemDisplayId": "string",
47 "countryId": 0,
48 "countryDisplayId": "string",
49 "name": "string",
50 "postingPeriodVariantId": 0,
51 "fiscalVariantId": 0
52 },
53 "purchaseOrderLineItems": [
54 {
55 "id": 0,
56 "displayId": "string",
57 "quantity": 0,
58 "allocatedQuantity": 0,
59 "receivedQuantity": 0,
60 "unitPrice": 0,
61 "description": "string",
62 "expenseCategory": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "expenseCategoryType": "PAYMENT"
68 },
69 "costCenter": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "erpSystemId": 0
75 },
76 "profitCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "validTo": "2019-08-24",
82 "erpSystemId": 0,
83 "erpSystemDisplayId": "string"
84 },
85 "taxJurisdiction": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "erpSystemId": 0,
91 "schema": "string",
92 "countryDisplayId": "string"
93 },
94 "taxCode": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "taxLineItems": [
102 {
103 "id": 0,
104 "taxRate": 0.1,
105 "taxAmount": 0,
106 "taxType": "string",
107 "purchaseOrderLineItemId": 0
108 }
109 ],
110 "purchaseOrderId": 0,
111 "purchaseOrderDisplayId": "string",
112 "purchaseOrderState": "INV_DRAFT",
113 "invoiceLineItems": [
114 {
115 "id": 0,
116 "displayId": "string",
117 "expenseCategory": {
118 "id": 0,
119 "displayId": "string",
120 "status": "CREATED",
121 "name": "string",
122 "expenseCategoryType": "PAYMENT"
123 },
124 "description": "string",
125 "unitOfMeasure": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "erpSystemId": 0
131 },
132 "quantity": 0,
133 "unitPrice": 0,
134 "taxJurisdiction": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0,
140 "schema": "string",
141 "countryDisplayId": "string"
142 },
143 "taxCode": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "erpSystemId": 0
149 },
150 "taxExpenseAccount": {
151 "id": 0,
152 "displayId": "string",
153 "generalLedgerAccountName": "string",
154 "generalLedgerAccountCode": "string",
155 "openItemManagement": true,
156 "accountCategory": "BALANCESHEET",
157 "shortName": "string",
158 "longName": "string"
159 },
160 "taxLineItems": [
161 {
162 "id": 0,
163 "taxRate": 0.1,
164 "taxAmount": 0,
165 "taxType": "string",
166 "invoiceLineItemId": 0
167 }
168 ],
169 "workBreakdownStructure": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "erpSystemId": 0
175 },
176 "costCenter": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 },
183 "profitCenter": {
184 "id": 0,
185 "displayId": "string",
186 "status": "CREATED",
187 "name": "string",
188 "validTo": "2019-08-24",
189 "erpSystemId": 0,
190 "erpSystemDisplayId": "string"
191 },
192 "functionalArea": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "businessArea": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "segment": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "network": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "internalOrderType": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0
226 },
227 "internalOrder": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "erpSystemId": 0,
233 "internalOrderTypeId": 0
234 },
235 "additionalCurrencies": [
236 {
237 "id": 0,
238 "amount": 0,
239 "currency": {
240 "id": 0,
241 "displayId": "string",
242 "status": "CREATED",
243 "name": "string",
244 "decimalPoints": 0
245 },
246 "conversionRate": 0,
247 "conversionDate": "2019-08-24",
248 "translationDateType": "DOCUMENT_DATE",
249 "amountType": "NET_AMOUNT",
250 "currencyDefinitionType": "CONTRACT_CURRENCY",
251 "invoiceEntryId": 0,
252 "invoiceEntryDisplayId": "string"
253 }
254 ],
255 "scheduledPaymentMatches": [
256 {
257 "id": 0,
258 "fromId": 0,
259 "toId": 0,
260 "amount": 0
261 }
262 ],
263 "goodsReceiptLineItemLinks": [
264 {
265 "id": 0,
266 "fromId": 0,
267 "toId": 0,
268 "linkedQuantity": 0
269 }
270 ],
271 "invoiceId": 0,
272 "invoiceDisplayId": "string",
273 "invoiceState": "INV_DRAFT",
274 "vendorPaymentId": 0,
275 "purchaseOrderLineItemId": 0,
276 "netAmount": 0,
277 "allowsSystemGenerateNewId": true,
278 "numberRangeIdentifierValue": "string",
279 "numberRangeIdentifierType": {
280 "name": "string"
281 },
282 "numberRangeType": {
283 "name": "string"
284 }
285 }
286 ],
287 "goodsReceiptLineItems": [
288 {
289 "id": 0,
290 "displayId": "string",
291 "quantity": 0,
292 "invoicedQuantity": 0,
293 "description": "string",
294 "expenseCategory": {
295 "id": 0,
296 "displayId": "string",
297 "status": "CREATED",
298 "name": "string",
299 "expenseCategoryType": "PAYMENT"
300 },
301 "goodsReceiptId": 0,
302 "goodsReceiptDisplayId": "string",
303 "goodsReceiptState": "INV_DRAFT",
304 "purchaseOrderLineItemId": 0,
305 "invoiceLineItemLinks": [
306 {
307 "id": 0,
308 "fromId": 0,
309 "toId": 0,
310 "linkedQuantity": 0
311 }
312 ],
313 "availableQuantity": 0,
314 "allowsSystemGenerateNewId": true,
315 "numberRangeIdentifierValue": "string",
316 "numberRangeIdentifierType": {
317 "name": "string"
318 },
319 "numberRangeType": {
320 "name": "string"
321 }
322 }
323 ],
324 "vendorPaymentId": 0,
325 "purchaseRequisitionLineItemId": 0,
326 "purchaseRequisitionDisplayId": "string",
327 "purchaseRequisitionLineItemAvailableQuantity": 0,
328 "remainingQuantity": 0,
329 "availableQuantity": 0,
330 "allowsSystemGenerateNewId": true,
331 "numberRangeIdentifierValue": "string",
332 "numberRangeIdentifierType": {
333 "name": "string"
334 },
335 "numberRangeType": {
336 "name": "string"
337 }
338 }
339 ],
340 "purchaseRequisitionIds": [
341 0
342 ],
343 "purchaseRequisitionDisplayIds": [
344 "string"
345 ],
346 "invoices": [
347 {
348 "id": 0,
349 "displayId": "string",
350 "name": "string",
351 "invoiceType": "VENDOR_INV",
352 "state": "INV_DRAFT",
353 "externalDocumentNumber": "string",
354 "purchaseOrderReference": "string",
355 "invoiceDate": "2019-08-24",
356 "dueDate": "2019-08-24",
357 "notes": "string",
358 "billingPeriodFromDate": "2019-08-24",
359 "billingPeriodToDate": "2019-08-24",
360 "currency": {
361 "id": 0,
362 "displayId": "string",
363 "status": "CREATED",
364 "name": "string",
365 "decimalPoints": 0
366 },
367 "vendor": {
368 "id": 0,
369 "displayId": "string",
370 "status": "CREATED",
371 "name": "string",
372 "erpSystemDisplayId": "string"
373 },
374 "company": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "erpSystemId": 0,
379 "erpSystemDisplayId": "string",
380 "countryId": 0,
381 "countryDisplayId": "string",
382 "name": "string",
383 "postingPeriodVariantId": 0,
384 "fiscalVariantId": 0
385 },
386 "netAmount": 0,
387 "taxAmount": 0,
388 "totalAmount": 0,
389 "netAmountBalance": 0,
390 "taxAmountBalance": 0,
391 "paymentTerm": {
392 "id": 0,
393 "displayId": "string",
394 "status": "CREATED",
395 "name": "string"
396 },
397 "paymentMethod": {
398 "id": 0,
399 "displayId": "string",
400 "status": "CREATED",
401 "name": "string",
402 "type": "string"
403 },
404 "paymentBlock": {
405 "id": 0,
406 "displayId": "string",
407 "status": "CREATED",
408 "name": "string"
409 },
410 "defaultCostCenter": {
411 "id": 0,
412 "displayId": "string",
413 "status": "CREATED",
414 "name": "string",
415 "erpSystemId": 0
416 },
417 "defaultProfitCenter": {
418 "id": 0,
419 "displayId": "string",
420 "status": "CREATED",
421 "name": "string",
422 "validTo": "2019-08-24",
423 "erpSystemId": 0,
424 "erpSystemDisplayId": "string"
425 },
426 "invoiceLineItems": [
427 {
428 "id": 0,
429 "displayId": "string",
430 "expenseCategory": {
431 "id": 0,
432 "displayId": "string",
433 "status": "CREATED",
434 "name": "string",
435 "expenseCategoryType": "PAYMENT"
436 },
437 "description": "string",
438 "unitOfMeasure": {
439 "id": 0,
440 "displayId": "string",
441 "status": "CREATED",
442 "name": "string",
443 "erpSystemId": 0
444 },
445 "quantity": 0,
446 "unitPrice": 0,
447 "taxJurisdiction": {
448 "id": 0,
449 "displayId": "string",
450 "status": "CREATED",
451 "name": "string",
452 "erpSystemId": 0,
453 "schema": "string",
454 "countryDisplayId": "string"
455 },
456 "taxCode": {
457 "id": 0,
458 "displayId": "string",
459 "status": "CREATED",
460 "name": "string",
461 "erpSystemId": 0
462 },
463 "taxExpenseAccount": {
464 "id": 0,
465 "displayId": "string",
466 "generalLedgerAccountName": "string",
467 "generalLedgerAccountCode": "string",
468 "openItemManagement": true,
469 "accountCategory": "BALANCESHEET",
470 "shortName": "string",
471 "longName": "string"
472 },
473 "taxLineItems": [
474 {
475 "id": 0,
476 "taxRate": 0.1,
477 "taxAmount": 0,
478 "taxType": "string",
479 "invoiceLineItemId": 0
480 }
481 ],
482 "workBreakdownStructure": {
483 "id": 0,
484 "displayId": "string",
485 "status": "CREATED",
486 "name": "string",
487 "erpSystemId": 0
488 },
489 "costCenter": {
490 "id": 0,
491 "displayId": "string",
492 "status": "CREATED",
493 "name": "string",
494 "erpSystemId": 0
495 },
496 "profitCenter": {
497 "id": 0,
498 "displayId": "string",
499 "status": "CREATED",
500 "name": "string",
501 "validTo": "2019-08-24",
502 "erpSystemId": 0,
503 "erpSystemDisplayId": "string"
504 },
505 "functionalArea": {
506 "id": 0,
507 "displayId": "string",
508 "status": "CREATED",
509 "name": "string",
510 "erpSystemId": 0
511 },
512 "businessArea": {
513 "id": 0,
514 "displayId": "string",
515 "status": "CREATED",
516 "name": "string",
517 "erpSystemId": 0
518 },
519 "segment": {
520 "id": 0,
521 "displayId": "string",
522 "status": "CREATED",
523 "name": "string",
524 "erpSystemId": 0
525 },
526 "network": {
527 "id": 0,
528 "displayId": "string",
529 "status": "CREATED",
530 "name": "string",
531 "erpSystemId": 0
532 },
533 "internalOrderType": {
534 "id": 0,
535 "displayId": "string",
536 "status": "CREATED",
537 "name": "string",
538 "erpSystemId": 0
539 },
540 "internalOrder": {
541 "id": 0,
542 "displayId": "string",
543 "status": "CREATED",
544 "name": "string",
545 "erpSystemId": 0,
546 "internalOrderTypeId": 0
547 },
548 "additionalCurrencies": [
549 {
550 "id": 0,
551 "amount": 0,
552 "currency": {
553 "id": 0,
554 "displayId": "string",
555 "status": "CREATED",
556 "name": "string",
557 "decimalPoints": 0
558 },
559 "conversionRate": 0,
560 "conversionDate": "2019-08-24",
561 "translationDateType": "DOCUMENT_DATE",
562 "amountType": "NET_AMOUNT",
563 "currencyDefinitionType": "CONTRACT_CURRENCY",
564 "invoiceEntryId": 0,
565 "invoiceEntryDisplayId": "string"
566 }
567 ],
568 "scheduledPaymentMatches": [
569 {
570 "id": 0,
571 "fromId": 0,
572 "toId": 0,
573 "amount": 0
574 }
575 ],
576 "goodsReceiptLineItemLinks": [
577 {
578 "id": 0,
579 "fromId": 0,
580 "toId": 0,
581 "linkedQuantity": 0
582 }
583 ],
584 "invoiceId": 0,
585 "invoiceDisplayId": "string",
586 "invoiceState": "INV_DRAFT",
587 "vendorPaymentId": 0,
588 "purchaseOrderLineItemId": 0,
589 "netAmount": 0,
590 "allowsSystemGenerateNewId": true,
591 "numberRangeIdentifierValue": "string",
592 "numberRangeIdentifierType": {
593 "name": "string"
594 },
595 "numberRangeType": {
596 "name": "string"
597 }
598 }
599 ],
600 "workspaceId": 0,
601 "workspaceDisplayId": "string",
602 "workspaceName": "string",
603 "workspaceState": "INV_DRAFT",
604 "remainingNetAmount": 0,
605 "remainingTaxAmount": 0,
606 "remainingTotalAmount": 0,
607 "pendingPaymentCount": 0,
608 "allPaymentsPosted": true,
609 "approvalInfo": {
610 "approverUsername": "string",
611 "approvedAt": "2019-08-24T14:15:22Z"
612 },
613 "rejectionReason": "string",
614 "allowsSystemGenerateNewId": true,
615 "numberRangeIdentifierValue": "string",
616 "numberRangeIdentifierType": {
617 "name": "string"
618 },
619 "numberRangeType": {
620 "name": "string"
621 }
622 }
623 ],
624 "rejectionReason": "string",
625 "allowsSystemGenerateNewId": true,
626 "numberRangeIdentifierValue": "string",
627 "numberRangeIdentifierType": {
628 "name": "string"
629 },
630 "numberRangeType": {
631 "name": "string"
632 }
633 }
634 ]
635}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/purchase-order/bulk
📋 Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A
ValidationExceptioncontaining per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of purchase order identifiers to be deleted in bulk, facilitating streamlined inventory management. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Unmark A Purchase Order As Favourite¶
HTTP Request
POST /api/v1/purchase-order/{purchaseOrderId}/remove-from-favorite
📋 Description: Unmark a purchase order as favourite
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseOrderId |
path |
integer(int64) |
true |
Unique identifier for the purchase order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "internalId": "string",
3 "foreignId": "string",
4 "objectType": "string",
5 "username": "string",
6 "sequenceNumber": 0,
7 "createdAt": "2019-08-24T14:15:22Z"
8}
Mark A Purchase Order As Favourite¶
HTTP Request
POST /api/v1/purchase-order/{purchaseOrderId}/add-to-favorite
📋 Description: Mark a purchase order as favourite
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseOrderId |
path |
integer(int64) |
true |
Unique identifier for the purchase order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "internalId": "string",
3 "foreignId": "string",
4 "objectType": "string",
5 "username": "string",
6 "sequenceNumber": 0,
7 "createdAt": "2019-08-24T14:15:22Z"
8}
Search Resources¶
HTTP Request
POST /api/v1/purchase-order/search
📋 Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the search criteria for purchase orders, including filters such as order status, date range, and supplier information. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "displayIdIn": [
16 "string"
17 ],
18 "displayIdLike": "string",
19 "stateEqual": "INV_DRAFT",
20 "stateIn": [
21 "INV_DRAFT"
22 ],
23 "issueDateEqual": "2019-08-24",
24 "expectedDeliveryDateEqual": "2019-08-24",
25 "nameLike": "string",
26 "shippingAddressLike": "string",
27 "notesLike": "string",
28 "externalPurchaseOrderDisplayIdLike": "string",
29 "vendorIdEqual": 0,
30 "vendorIdIn": [
31 0
32 ],
33 "vendorDisplayIdLike": "string",
34 "currencyIdEqual": 0,
35 "companyIdEqual": 0,
36 "companyIdIn": [
37 0
38 ],
39 "workspaceFilterMode": "ALL",
40 "workspaceId": 0,
41 "matchFilterMode": "ALL"
42}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "state": "INV_DRAFT",
23 "issueDate": "2019-08-24",
24 "expectedDeliveryDate": "2019-08-24",
25 "name": "string",
26 "shippingAddress": "string",
27 "notes": "string",
28 "netAmount": 0,
29 "taxAmount": 0,
30 "externalPurchaseOrderDisplayId": "string",
31 "vendor": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "currency": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "name": "string",
43 "decimalPoints": 0
44 },
45 "company": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "erpSystemId": 0,
50 "erpSystemDisplayId": "string",
51 "countryId": 0,
52 "countryDisplayId": "string",
53 "name": "string",
54 "postingPeriodVariantId": 0,
55 "fiscalVariantId": 0
56 },
57 "purchaseOrderLineItems": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "quantity": 0,
62 "allocatedQuantity": 0,
63 "receivedQuantity": 0,
64 "unitPrice": 0,
65 "description": "string",
66 "expenseCategory": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "expenseCategoryType": "PAYMENT"
72 },
73 "costCenter": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "profitCenter": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "validTo": "2019-08-24",
86 "erpSystemId": 0,
87 "erpSystemDisplayId": "string"
88 },
89 "taxJurisdiction": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0,
95 "schema": "string",
96 "countryDisplayId": "string"
97 },
98 "taxCode": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "erpSystemId": 0
104 },
105 "taxLineItems": [
106 {
107 "id": 0,
108 "taxRate": 0.1,
109 "taxAmount": 0,
110 "taxType": "string",
111 "purchaseOrderLineItemId": 0
112 }
113 ],
114 "purchaseOrderId": 0,
115 "purchaseOrderDisplayId": "string",
116 "purchaseOrderState": "INV_DRAFT",
117 "invoiceLineItems": [
118 {
119 "id": 0,
120 "displayId": "string",
121 "expenseCategory": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "expenseCategoryType": "PAYMENT"
127 },
128 "description": "string",
129 "unitOfMeasure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "quantity": 0,
137 "unitPrice": 0,
138 "taxJurisdiction": {
139 "id": 0,
140 "displayId": "string",
141 "status": "CREATED",
142 "name": "string",
143 "erpSystemId": 0,
144 "schema": "string",
145 "countryDisplayId": "string"
146 },
147 "taxCode": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "taxExpenseAccount": {
155 "id": 0,
156 "displayId": "string",
157 "generalLedgerAccountName": "string",
158 "generalLedgerAccountCode": "string",
159 "openItemManagement": true,
160 "accountCategory": "BALANCESHEET",
161 "shortName": "string",
162 "longName": "string"
163 },
164 "taxLineItems": [
165 {
166 "id": 0,
167 "taxRate": 0.1,
168 "taxAmount": 0,
169 "taxType": "string",
170 "invoiceLineItemId": 0
171 }
172 ],
173 "workBreakdownStructure": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "costCenter": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "profitCenter": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "validTo": "2019-08-24",
193 "erpSystemId": 0,
194 "erpSystemDisplayId": "string"
195 },
196 "functionalArea": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "businessArea": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "erpSystemId": 0
209 },
210 "segment": {
211 "id": 0,
212 "displayId": "string",
213 "status": "CREATED",
214 "name": "string",
215 "erpSystemId": 0
216 },
217 "network": {
218 "id": 0,
219 "displayId": "string",
220 "status": "CREATED",
221 "name": "string",
222 "erpSystemId": 0
223 },
224 "internalOrderType": {
225 "id": 0,
226 "displayId": "string",
227 "status": "CREATED",
228 "name": "string",
229 "erpSystemId": 0
230 },
231 "internalOrder": {
232 "id": 0,
233 "displayId": "string",
234 "status": "CREATED",
235 "name": "string",
236 "erpSystemId": 0,
237 "internalOrderTypeId": 0
238 },
239 "additionalCurrencies": [
240 {
241 "id": 0,
242 "amount": 0,
243 "currency": {
244 "id": 0,
245 "displayId": "string",
246 "status": "CREATED",
247 "name": "string",
248 "decimalPoints": 0
249 },
250 "conversionRate": 0,
251 "conversionDate": "2019-08-24",
252 "translationDateType": "DOCUMENT_DATE",
253 "amountType": "NET_AMOUNT",
254 "currencyDefinitionType": "CONTRACT_CURRENCY",
255 "invoiceEntryId": 0,
256 "invoiceEntryDisplayId": "string"
257 }
258 ],
259 "scheduledPaymentMatches": [
260 {
261 "id": 0,
262 "fromId": 0,
263 "toId": 0,
264 "amount": 0
265 }
266 ],
267 "goodsReceiptLineItemLinks": [
268 {
269 "id": 0,
270 "fromId": 0,
271 "toId": 0,
272 "linkedQuantity": 0
273 }
274 ],
275 "invoiceId": 0,
276 "invoiceDisplayId": "string",
277 "invoiceState": "INV_DRAFT",
278 "vendorPaymentId": 0,
279 "purchaseOrderLineItemId": 0,
280 "netAmount": 0,
281 "allowsSystemGenerateNewId": true,
282 "numberRangeIdentifierValue": "string",
283 "numberRangeIdentifierType": {
284 "name": "string"
285 },
286 "numberRangeType": {
287 "name": "string"
288 }
289 }
290 ],
291 "goodsReceiptLineItems": [
292 {
293 "id": 0,
294 "displayId": "string",
295 "quantity": 0,
296 "invoicedQuantity": 0,
297 "description": "string",
298 "expenseCategory": {
299 "id": 0,
300 "displayId": "string",
301 "status": "CREATED",
302 "name": "string",
303 "expenseCategoryType": "PAYMENT"
304 },
305 "goodsReceiptId": 0,
306 "goodsReceiptDisplayId": "string",
307 "goodsReceiptState": "INV_DRAFT",
308 "purchaseOrderLineItemId": 0,
309 "invoiceLineItemLinks": [
310 {
311 "id": 0,
312 "fromId": 0,
313 "toId": 0,
314 "linkedQuantity": 0
315 }
316 ],
317 "availableQuantity": 0,
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327 ],
328 "vendorPaymentId": 0,
329 "purchaseRequisitionLineItemId": 0,
330 "purchaseRequisitionDisplayId": "string",
331 "purchaseRequisitionLineItemAvailableQuantity": 0,
332 "remainingQuantity": 0,
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343 ],
344 "purchaseRequisitionIds": [
345 0
346 ],
347 "purchaseRequisitionDisplayIds": [
348 "string"
349 ],
350 "invoices": [
351 {
352 "id": 0,
353 "displayId": "string",
354 "name": "string",
355 "invoiceType": "VENDOR_INV",
356 "state": "INV_DRAFT",
357 "externalDocumentNumber": "string",
358 "purchaseOrderReference": "string",
359 "invoiceDate": "2019-08-24",
360 "dueDate": "2019-08-24",
361 "notes": "string",
362 "billingPeriodFromDate": "2019-08-24",
363 "billingPeriodToDate": "2019-08-24",
364 "currency": {
365 "id": 0,
366 "displayId": "string",
367 "status": "CREATED",
368 "name": "string",
369 "decimalPoints": 0
370 },
371 "vendor": {
372 "id": 0,
373 "displayId": "string",
374 "status": "CREATED",
375 "name": "string",
376 "erpSystemDisplayId": "string"
377 },
378 "company": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "erpSystemId": 0,
383 "erpSystemDisplayId": "string",
384 "countryId": 0,
385 "countryDisplayId": "string",
386 "name": "string",
387 "postingPeriodVariantId": 0,
388 "fiscalVariantId": 0
389 },
390 "netAmount": 0,
391 "taxAmount": 0,
392 "totalAmount": 0,
393 "netAmountBalance": 0,
394 "taxAmountBalance": 0,
395 "paymentTerm": {
396 "id": 0,
397 "displayId": "string",
398 "status": "CREATED",
399 "name": "string"
400 },
401 "paymentMethod": {
402 "id": 0,
403 "displayId": "string",
404 "status": "CREATED",
405 "name": "string",
406 "type": "string"
407 },
408 "paymentBlock": {
409 "id": 0,
410 "displayId": "string",
411 "status": "CREATED",
412 "name": "string"
413 },
414 "defaultCostCenter": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "erpSystemId": 0
420 },
421 "defaultProfitCenter": {
422 "id": 0,
423 "displayId": "string",
424 "status": "CREATED",
425 "name": "string",
426 "validTo": "2019-08-24",
427 "erpSystemId": 0,
428 "erpSystemDisplayId": "string"
429 },
430 "invoiceLineItems": [
431 {
432 "id": 0,
433 "displayId": "string",
434 "expenseCategory": {
435 "id": 0,
436 "displayId": "string",
437 "status": "CREATED",
438 "name": "string",
439 "expenseCategoryType": "PAYMENT"
440 },
441 "description": "string",
442 "unitOfMeasure": {
443 "id": 0,
444 "displayId": "string",
445 "status": "CREATED",
446 "name": "string",
447 "erpSystemId": 0
448 },
449 "quantity": 0,
450 "unitPrice": 0,
451 "taxJurisdiction": {
452 "id": 0,
453 "displayId": "string",
454 "status": "CREATED",
455 "name": "string",
456 "erpSystemId": 0,
457 "schema": "string",
458 "countryDisplayId": "string"
459 },
460 "taxCode": {
461 "id": 0,
462 "displayId": "string",
463 "status": "CREATED",
464 "name": "string",
465 "erpSystemId": 0
466 },
467 "taxExpenseAccount": {
468 "id": 0,
469 "displayId": "string",
470 "generalLedgerAccountName": "string",
471 "generalLedgerAccountCode": "string",
472 "openItemManagement": true,
473 "accountCategory": "BALANCESHEET",
474 "shortName": "string",
475 "longName": "string"
476 },
477 "taxLineItems": [
478 {
479 "id": 0,
480 "taxRate": 0.1,
481 "taxAmount": 0,
482 "taxType": "string",
483 "invoiceLineItemId": 0
484 }
485 ],
486 "workBreakdownStructure": {
487 "id": 0,
488 "displayId": "string",
489 "status": "CREATED",
490 "name": "string",
491 "erpSystemId": 0
492 },
493 "costCenter": {
494 "id": 0,
495 "displayId": "string",
496 "status": "CREATED",
497 "name": "string",
498 "erpSystemId": 0
499 },
500 "profitCenter": {
501 "id": 0,
502 "displayId": "string",
503 "status": "CREATED",
504 "name": "string",
505 "validTo": "2019-08-24",
506 "erpSystemId": 0,
507 "erpSystemDisplayId": "string"
508 },
509 "functionalArea": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "businessArea": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "segment": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "erpSystemId": 0
529 },
530 "network": {
531 "id": 0,
532 "displayId": "string",
533 "status": "CREATED",
534 "name": "string",
535 "erpSystemId": 0
536 },
537 "internalOrderType": {
538 "id": 0,
539 "displayId": "string",
540 "status": "CREATED",
541 "name": "string",
542 "erpSystemId": 0
543 },
544 "internalOrder": {
545 "id": 0,
546 "displayId": "string",
547 "status": "CREATED",
548 "name": "string",
549 "erpSystemId": 0,
550 "internalOrderTypeId": 0
551 },
552 "additionalCurrencies": [
553 {
554 "id": 0,
555 "amount": 0,
556 "currency": {
557 "id": 0,
558 "displayId": "string",
559 "status": "CREATED",
560 "name": "string",
561 "decimalPoints": 0
562 },
563 "conversionRate": 0,
564 "conversionDate": "2019-08-24",
565 "translationDateType": "DOCUMENT_DATE",
566 "amountType": "NET_AMOUNT",
567 "currencyDefinitionType": "CONTRACT_CURRENCY",
568 "invoiceEntryId": 0,
569 "invoiceEntryDisplayId": "string"
570 }
571 ],
572 "scheduledPaymentMatches": [
573 {
574 "id": 0,
575 "fromId": 0,
576 "toId": 0,
577 "amount": 0
578 }
579 ],
580 "goodsReceiptLineItemLinks": [
581 {
582 "id": 0,
583 "fromId": 0,
584 "toId": 0,
585 "linkedQuantity": 0
586 }
587 ],
588 "invoiceId": 0,
589 "invoiceDisplayId": "string",
590 "invoiceState": "INV_DRAFT",
591 "vendorPaymentId": 0,
592 "purchaseOrderLineItemId": 0,
593 "netAmount": 0,
594 "allowsSystemGenerateNewId": true,
595 "numberRangeIdentifierValue": "string",
596 "numberRangeIdentifierType": {
597 "name": "string"
598 },
599 "numberRangeType": {
600 "name": "string"
601 }
602 }
603 ],
604 "workspaceId": 0,
605 "workspaceDisplayId": "string",
606 "workspaceName": "string",
607 "workspaceState": "INV_DRAFT",
608 "remainingNetAmount": 0,
609 "remainingTaxAmount": 0,
610 "remainingTotalAmount": 0,
611 "pendingPaymentCount": 0,
612 "allPaymentsPosted": true,
613 "approvalInfo": {
614 "approverUsername": "string",
615 "approvedAt": "2019-08-24T14:15:22Z"
616 },
617 "rejectionReason": "string",
618 "allowsSystemGenerateNewId": true,
619 "numberRangeIdentifierValue": "string",
620 "numberRangeIdentifierType": {
621 "name": "string"
622 },
623 "numberRangeType": {
624 "name": "string"
625 }
626 }
627 ],
628 "rejectionReason": "string",
629 "allowsSystemGenerateNewId": true,
630 "numberRangeIdentifierValue": "string",
631 "numberRangeIdentifierType": {
632 "name": "string"
633 },
634 "numberRangeType": {
635 "name": "string"
636 }
637 }
638 ],
639 "number": 0,
640 "sort": {
641 "unsorted": true,
642 "sorted": true,
643 "empty": true
644 },
645 "first": true,
646 "last": true,
647 "empty": true
648}
Search User Links On Purchase Orders¶
HTTP Request
POST /api/v1/purchase-order/link/search
📋 Description: Search user links on purchase orders
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the search criteria for linking purchase orders, including relevant identifiers and filters to facilitate efficient order management. |
» filter |
body |
false |
Data transfer object representing the criteria for filtering user link records, enabling efficient retrieval and management of user associations within the system. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» displayIdIn |
body |
[string] |
false |
Filter by multiple values of display id |
»» displayIdLike |
body |
string |
false |
Filter by partial match of display id |
»» displayNameLike |
body |
string |
false |
Filter by partial match of display name |
»» descriptionLike |
body |
string |
false |
Filter by partial match of description |
»» urlLike |
body |
string |
false |
Filter by partial match of url |
»» entityIdIn |
body |
[integer] |
false |
Filter by multiple values of entity id |
»» entityIdEqual |
body |
integer(int64) |
false |
Filter by exact match of entity id |
»» entityTypeIn |
body |
[string] |
false |
Filter by multiple values of entity type |
»» entityTypeEqual |
body |
string |
false |
Filter by exact match of entity type |
» pageable |
body |
false |
Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityTypeEqual |
GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION |
»» entityTypeIn |
GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "displayIdIn": [
17 "string"
18 ],
19 "displayIdLike": "string",
20 "displayNameLike": "string",
21 "descriptionLike": "string",
22 "urlLike": "string",
23 "entityIdIn": [
24 0
25 ],
26 "entityIdEqual": 0,
27 "entityTypeIn": [
28 "INVOICE"
29 ],
30 "entityTypeEqual": "INVOICE"
31 },
32 "pageable": {
33 "page": 0,
34 "size": 1,
35 "sort": [
36 "string"
37 ]
38 }
39}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "displayName": "string",
23 "description": "string",
24 "url": "string",
25 "entityId": 0,
26 "entityType": "INVOICE",
27 "allowsSystemGenerateNewId": true,
28 "numberRangeIdentifierValue": "string",
29 "numberRangeIdentifierType": {
30 "name": "string"
31 },
32 "numberRangeType": {
33 "name": "string"
34 }
35 }
36 ],
37 "number": 0,
38 "sort": {
39 "unsorted": true,
40 "sorted": true,
41 "empty": true
42 },
43 "first": true,
44 "last": true,
45 "empty": true
46}
Create Or Update A User Link On A Purchase Order¶
HTTP Request
POST /api/v1/purchase-order/link/create-or-update
📋 Description: Attaches a user-defined hyperlink to a purchase order. If a link with the same ID already exists it is updated; otherwise a new link is created.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the purchase order details, including item specifications, quantities, and vendor information for creating or updating a purchase order. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "displayName": "string",
5 "description": "string",
6 "url": "string",
7 "entityId": 0,
8 "entityType": "INVOICE",
9 "allowsSystemGenerateNewId": true,
10 "numberRangeIdentifierValue": "string",
11 "numberRangeIdentifierType": {
12 "name": "string"
13 },
14 "numberRangeType": {
15 "name": "string"
16 }
17}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "displayName": "string",
18 "description": "string",
19 "url": "string",
20 "entityId": 0,
21 "entityType": "INVOICE",
22 "allowsSystemGenerateNewId": true,
23 "numberRangeIdentifierValue": "string",
24 "numberRangeIdentifierType": {
25 "name": "string"
26 },
27 "numberRangeType": {
28 "name": "string"
29 }
30 }
31}
Upload Documents To A Purchase Order¶
HTTP Request
POST /api/v1/purchase-order/document/upload
📋 Description: Attaches one or more files to the specified purchase order.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entityId |
query |
integer(int64) |
true |
Purchase order ID |
files |
query |
array[string] |
false |
An array of files to be uploaded as supporting documents for a purchase order. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "uploadResults": [
3 {
4 "success": true,
5 "originalFilename": "string",
6 "resolvedFilename": "string",
7 "failureReason": "string",
8 "documentId": 0
9 }
10 ]
11}
Search Documents Attached To Purchase Orders¶
HTTP Request
POST /api/v1/purchase-order/document/search
📋 Description: Search documents attached to purchase orders
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the search criteria and filters for retrieving purchase order documents, enabling efficient document management and retrieval. |
» filter |
body |
false |
Data transfer object representing the criteria for filtering document references, enabling users to efficiently retrieve and manage relevant documents within the system. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» documentIdIn |
body |
[integer] |
false |
Filter by multiple values of document id |
»» documentIdEqual |
body |
integer(int64) |
false |
Filter by exact match of document id |
»» entityIdIn |
body |
[integer] |
false |
Filter by multiple values of entity id |
»» entityIdEqual |
body |
integer(int64) |
false |
Filter by exact match of entity id |
»» entityTypeIn |
body |
[string] |
false |
Filter by multiple values of entity type |
»» entityTypeEqual |
body |
string |
false |
Filter by exact match of entity type |
»» filenameLike |
body |
string |
false |
Filter by partial match of filename |
» pageable |
body |
false |
Data transfer object representing a paginated collection of results, enabling efficient navigation and retrieval of large datasets within the API. This schema supports enhanced user experience by facilitating organized data presentation and management. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityTypeEqual |
GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION, WORKSPACE |
»» entityTypeIn |
GOODS_RECEIPT, INVOICE, PURCHASE_ORDER, PURCHASE_REQUISITION, WORKSPACE |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "documentIdIn": [
17 0
18 ],
19 "documentIdEqual": 0,
20 "entityIdIn": [
21 0
22 ],
23 "entityIdEqual": 0,
24 "entityTypeIn": [
25 "INVOICE"
26 ],
27 "entityTypeEqual": "INVOICE",
28 "filenameLike": "string"
29 },
30 "pageable": {
31 "page": 0,
32 "size": 1,
33 "sort": [
34 "string"
35 ]
36 }
37}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "filename": "string",
22 "mimeType": "string",
23 "fileSize": 0,
24 "hash": "string"
25 }
26 ],
27 "number": 0,
28 "sort": {
29 "unsorted": true,
30 "sorted": true,
31 "empty": true
32 },
33 "first": true,
34 "last": true,
35 "empty": true
36}
Advanced Purchase Order Search¶
HTTP Request
POST /api/v1/purchase-order/advanced-search
📋 Description: Full-text / multi-field search with faceting. Applies company-access and vendor-access filtering.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
true |
Request body containing advanced search criteria for purchase orders, including filters such as date range, supplier details, and order status. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "facets": [
3 "ID"
4 ],
5 "facetSelections": {
6 "property1": [
7 "string"
8 ],
9 "property2": [
10 "string"
11 ]
12 },
13 "aggregations": {
14 "property1": {
15 "type": "TERMS",
16 "field": "ID",
17 "size": 0,
18 "missing": "string"
19 },
20 "property2": {
21 "type": "TERMS",
22 "field": "ID",
23 "size": 0,
24 "missing": "string"
25 }
26 },
27 "filter": {
28 "operator": "AND",
29 "children": [
30 {}
31 ],
32 "field": "ID",
33 "comparison": "EQUAL",
34 "value": "string",
35 "values": [
36 "string"
37 ],
38 "from": "string",
39 "to": "string"
40 }
41}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "results": [
3 {
4 "id": 0,
5 "displayId": "string",
6 "state": "INV_DRAFT",
7 "issueDate": "2019-08-24",
8 "expectedDeliveryDate": "2019-08-24",
9 "name": "string",
10 "shippingAddress": "string",
11 "notes": "string",
12 "netAmount": 0,
13 "taxAmount": 0,
14 "externalPurchaseOrderDisplayId": "string",
15 "vendor": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "name": "string",
20 "erpSystemDisplayId": "string"
21 },
22 "currency": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "decimalPoints": 0
28 },
29 "company": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "erpSystemId": 0,
34 "erpSystemDisplayId": "string",
35 "countryId": 0,
36 "countryDisplayId": "string",
37 "name": "string",
38 "postingPeriodVariantId": 0,
39 "fiscalVariantId": 0
40 },
41 "purchaseOrderLineItems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "quantity": 0,
46 "allocatedQuantity": 0,
47 "receivedQuantity": 0,
48 "unitPrice": 0,
49 "description": "string",
50 "expenseCategory": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "expenseCategoryType": "PAYMENT"
56 },
57 "costCenter": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "profitCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "validTo": "2019-08-24",
70 "erpSystemId": 0,
71 "erpSystemDisplayId": "string"
72 },
73 "taxJurisdiction": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0,
79 "schema": "string",
80 "countryDisplayId": "string"
81 },
82 "taxCode": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0
88 },
89 "taxLineItems": [
90 {
91 "id": 0,
92 "taxRate": 0.1,
93 "taxAmount": 0,
94 "taxType": "string",
95 "purchaseOrderLineItemId": 0
96 }
97 ],
98 "purchaseOrderId": 0,
99 "purchaseOrderDisplayId": "string",
100 "purchaseOrderState": "INV_DRAFT",
101 "invoiceLineItems": [
102 {
103 "id": 0,
104 "displayId": "string",
105 "expenseCategory": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "expenseCategoryType": "PAYMENT"
111 },
112 "description": "string",
113 "unitOfMeasure": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "quantity": 0,
121 "unitPrice": 0,
122 "taxJurisdiction": {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string",
127 "erpSystemId": 0,
128 "schema": "string",
129 "countryDisplayId": "string"
130 },
131 "taxCode": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "erpSystemId": 0
137 },
138 "taxExpenseAccount": {
139 "id": 0,
140 "displayId": "string",
141 "generalLedgerAccountName": "string",
142 "generalLedgerAccountCode": "string",
143 "openItemManagement": true,
144 "accountCategory": "BALANCESHEET",
145 "shortName": "string",
146 "longName": "string"
147 },
148 "taxLineItems": [
149 {
150 "id": 0,
151 "taxRate": 0.1,
152 "taxAmount": 0,
153 "taxType": "string",
154 "invoiceLineItemId": 0
155 }
156 ],
157 "workBreakdownStructure": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "costCenter": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "profitCenter": {
172 "id": 0,
173 "displayId": "string",
174 "status": "CREATED",
175 "name": "string",
176 "validTo": "2019-08-24",
177 "erpSystemId": 0,
178 "erpSystemDisplayId": "string"
179 },
180 "functionalArea": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "businessArea": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0
193 },
194 "segment": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0
200 },
201 "network": {
202 "id": 0,
203 "displayId": "string",
204 "status": "CREATED",
205 "name": "string",
206 "erpSystemId": 0
207 },
208 "internalOrderType": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "erpSystemId": 0
214 },
215 "internalOrder": {
216 "id": 0,
217 "displayId": "string",
218 "status": "CREATED",
219 "name": "string",
220 "erpSystemId": 0,
221 "internalOrderTypeId": 0
222 },
223 "additionalCurrencies": [
224 {
225 "id": 0,
226 "amount": 0,
227 "currency": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "decimalPoints": 0
233 },
234 "conversionRate": 0,
235 "conversionDate": "2019-08-24",
236 "translationDateType": "DOCUMENT_DATE",
237 "amountType": "NET_AMOUNT",
238 "currencyDefinitionType": "CONTRACT_CURRENCY",
239 "invoiceEntryId": 0,
240 "invoiceEntryDisplayId": "string"
241 }
242 ],
243 "scheduledPaymentMatches": [
244 {
245 "id": 0,
246 "fromId": 0,
247 "toId": 0,
248 "amount": 0
249 }
250 ],
251 "goodsReceiptLineItemLinks": [
252 {
253 "id": 0,
254 "fromId": 0,
255 "toId": 0,
256 "linkedQuantity": 0
257 }
258 ],
259 "invoiceId": 0,
260 "invoiceDisplayId": "string",
261 "invoiceState": "INV_DRAFT",
262 "vendorPaymentId": 0,
263 "purchaseOrderLineItemId": 0,
264 "netAmount": 0,
265 "allowsSystemGenerateNewId": true,
266 "numberRangeIdentifierValue": "string",
267 "numberRangeIdentifierType": {
268 "name": "string"
269 },
270 "numberRangeType": {
271 "name": "string"
272 }
273 }
274 ],
275 "goodsReceiptLineItems": [
276 {
277 "id": 0,
278 "displayId": "string",
279 "quantity": 0,
280 "invoicedQuantity": 0,
281 "description": "string",
282 "expenseCategory": {
283 "id": 0,
284 "displayId": "string",
285 "status": "CREATED",
286 "name": "string",
287 "expenseCategoryType": "PAYMENT"
288 },
289 "goodsReceiptId": 0,
290 "goodsReceiptDisplayId": "string",
291 "goodsReceiptState": "INV_DRAFT",
292 "purchaseOrderLineItemId": 0,
293 "invoiceLineItemLinks": [
294 {
295 "id": 0,
296 "fromId": 0,
297 "toId": 0,
298 "linkedQuantity": 0
299 }
300 ],
301 "availableQuantity": 0,
302 "allowsSystemGenerateNewId": true,
303 "numberRangeIdentifierValue": "string",
304 "numberRangeIdentifierType": {
305 "name": "string"
306 },
307 "numberRangeType": {
308 "name": "string"
309 }
310 }
311 ],
312 "vendorPaymentId": 0,
313 "purchaseRequisitionLineItemId": 0,
314 "purchaseRequisitionDisplayId": "string",
315 "purchaseRequisitionLineItemAvailableQuantity": 0,
316 "remainingQuantity": 0,
317 "availableQuantity": 0,
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327 ],
328 "purchaseRequisitionIds": [
329 0
330 ],
331 "purchaseRequisitionDisplayIds": [
332 "string"
333 ],
334 "invoices": [
335 {
336 "id": 0,
337 "displayId": "string",
338 "name": "string",
339 "invoiceType": "VENDOR_INV",
340 "state": "INV_DRAFT",
341 "externalDocumentNumber": "string",
342 "purchaseOrderReference": "string",
343 "invoiceDate": "2019-08-24",
344 "dueDate": "2019-08-24",
345 "notes": "string",
346 "billingPeriodFromDate": "2019-08-24",
347 "billingPeriodToDate": "2019-08-24",
348 "currency": {
349 "id": 0,
350 "displayId": "string",
351 "status": "CREATED",
352 "name": "string",
353 "decimalPoints": 0
354 },
355 "vendor": {
356 "id": 0,
357 "displayId": "string",
358 "status": "CREATED",
359 "name": "string",
360 "erpSystemDisplayId": "string"
361 },
362 "company": {
363 "id": 0,
364 "displayId": "string",
365 "status": "CREATED",
366 "erpSystemId": 0,
367 "erpSystemDisplayId": "string",
368 "countryId": 0,
369 "countryDisplayId": "string",
370 "name": "string",
371 "postingPeriodVariantId": 0,
372 "fiscalVariantId": 0
373 },
374 "netAmount": 0,
375 "taxAmount": 0,
376 "totalAmount": 0,
377 "netAmountBalance": 0,
378 "taxAmountBalance": 0,
379 "paymentTerm": {
380 "id": 0,
381 "displayId": "string",
382 "status": "CREATED",
383 "name": "string"
384 },
385 "paymentMethod": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "type": "string"
391 },
392 "paymentBlock": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "name": "string"
397 },
398 "defaultCostCenter": {
399 "id": 0,
400 "displayId": "string",
401 "status": "CREATED",
402 "name": "string",
403 "erpSystemId": 0
404 },
405 "defaultProfitCenter": {
406 "id": 0,
407 "displayId": "string",
408 "status": "CREATED",
409 "name": "string",
410 "validTo": "2019-08-24",
411 "erpSystemId": 0,
412 "erpSystemDisplayId": "string"
413 },
414 "invoiceLineItems": [
415 {
416 "id": 0,
417 "displayId": "string",
418 "expenseCategory": {
419 "id": 0,
420 "displayId": "string",
421 "status": "CREATED",
422 "name": "string",
423 "expenseCategoryType": "PAYMENT"
424 },
425 "description": "string",
426 "unitOfMeasure": {
427 "id": 0,
428 "displayId": "string",
429 "status": "CREATED",
430 "name": "string",
431 "erpSystemId": 0
432 },
433 "quantity": 0,
434 "unitPrice": 0,
435 "taxJurisdiction": {
436 "id": 0,
437 "displayId": "string",
438 "status": "CREATED",
439 "name": "string",
440 "erpSystemId": 0,
441 "schema": "string",
442 "countryDisplayId": "string"
443 },
444 "taxCode": {
445 "id": 0,
446 "displayId": "string",
447 "status": "CREATED",
448 "name": "string",
449 "erpSystemId": 0
450 },
451 "taxExpenseAccount": {
452 "id": 0,
453 "displayId": "string",
454 "generalLedgerAccountName": "string",
455 "generalLedgerAccountCode": "string",
456 "openItemManagement": true,
457 "accountCategory": "BALANCESHEET",
458 "shortName": "string",
459 "longName": "string"
460 },
461 "taxLineItems": [
462 {
463 "id": 0,
464 "taxRate": 0.1,
465 "taxAmount": 0,
466 "taxType": "string",
467 "invoiceLineItemId": 0
468 }
469 ],
470 "workBreakdownStructure": {
471 "id": 0,
472 "displayId": "string",
473 "status": "CREATED",
474 "name": "string",
475 "erpSystemId": 0
476 },
477 "costCenter": {
478 "id": 0,
479 "displayId": "string",
480 "status": "CREATED",
481 "name": "string",
482 "erpSystemId": 0
483 },
484 "profitCenter": {
485 "id": 0,
486 "displayId": "string",
487 "status": "CREATED",
488 "name": "string",
489 "validTo": "2019-08-24",
490 "erpSystemId": 0,
491 "erpSystemDisplayId": "string"
492 },
493 "functionalArea": {
494 "id": 0,
495 "displayId": "string",
496 "status": "CREATED",
497 "name": "string",
498 "erpSystemId": 0
499 },
500 "businessArea": {
501 "id": 0,
502 "displayId": "string",
503 "status": "CREATED",
504 "name": "string",
505 "erpSystemId": 0
506 },
507 "segment": {
508 "id": 0,
509 "displayId": "string",
510 "status": "CREATED",
511 "name": "string",
512 "erpSystemId": 0
513 },
514 "network": {
515 "id": 0,
516 "displayId": "string",
517 "status": "CREATED",
518 "name": "string",
519 "erpSystemId": 0
520 },
521 "internalOrderType": {
522 "id": 0,
523 "displayId": "string",
524 "status": "CREATED",
525 "name": "string",
526 "erpSystemId": 0
527 },
528 "internalOrder": {
529 "id": 0,
530 "displayId": "string",
531 "status": "CREATED",
532 "name": "string",
533 "erpSystemId": 0,
534 "internalOrderTypeId": 0
535 },
536 "additionalCurrencies": [
537 {
538 "id": 0,
539 "amount": 0,
540 "currency": {
541 "id": 0,
542 "displayId": "string",
543 "status": "CREATED",
544 "name": "string",
545 "decimalPoints": 0
546 },
547 "conversionRate": 0,
548 "conversionDate": "2019-08-24",
549 "translationDateType": "DOCUMENT_DATE",
550 "amountType": "NET_AMOUNT",
551 "currencyDefinitionType": "CONTRACT_CURRENCY",
552 "invoiceEntryId": 0,
553 "invoiceEntryDisplayId": "string"
554 }
555 ],
556 "scheduledPaymentMatches": [
557 {
558 "id": 0,
559 "fromId": 0,
560 "toId": 0,
561 "amount": 0
562 }
563 ],
564 "goodsReceiptLineItemLinks": [
565 {
566 "id": 0,
567 "fromId": 0,
568 "toId": 0,
569 "linkedQuantity": 0
570 }
571 ],
572 "invoiceId": 0,
573 "invoiceDisplayId": "string",
574 "invoiceState": "INV_DRAFT",
575 "vendorPaymentId": 0,
576 "purchaseOrderLineItemId": 0,
577 "netAmount": 0,
578 "allowsSystemGenerateNewId": true,
579 "numberRangeIdentifierValue": "string",
580 "numberRangeIdentifierType": {
581 "name": "string"
582 },
583 "numberRangeType": {
584 "name": "string"
585 }
586 }
587 ],
588 "workspaceId": 0,
589 "workspaceDisplayId": "string",
590 "workspaceName": "string",
591 "workspaceState": "INV_DRAFT",
592 "remainingNetAmount": 0,
593 "remainingTaxAmount": 0,
594 "remainingTotalAmount": 0,
595 "pendingPaymentCount": 0,
596 "allPaymentsPosted": true,
597 "approvalInfo": {
598 "approverUsername": "string",
599 "approvedAt": "2019-08-24T14:15:22Z"
600 },
601 "rejectionReason": "string",
602 "allowsSystemGenerateNewId": true,
603 "numberRangeIdentifierValue": "string",
604 "numberRangeIdentifierType": {
605 "name": "string"
606 },
607 "numberRangeType": {
608 "name": "string"
609 }
610 }
611 ],
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "facets": {
624 "property1": {},
625 "property2": {}
626 },
627 "aggregations": {
628 "property1": {},
629 "property2": {}
630 },
631 "pagination": {
632 "number": 0,
633 "size": 0,
634 "totalElements": 0,
635 "totalPages": 0,
636 "first": true,
637 "last": true,
638 "empty": true,
639 "numberOfElements": 0
640 }
641}
List All Resources¶
HTTP Request
GET /api/v1/purchase-order
📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the purchase order query should be returned in a paginated format, facilitating efficient data retrieval and management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "state": "INV_DRAFT",
23 "issueDate": "2019-08-24",
24 "expectedDeliveryDate": "2019-08-24",
25 "name": "string",
26 "shippingAddress": "string",
27 "notes": "string",
28 "netAmount": 0,
29 "taxAmount": 0,
30 "externalPurchaseOrderDisplayId": "string",
31 "vendor": {
32 "id": 0,
33 "displayId": "string",
34 "status": "CREATED",
35 "name": "string",
36 "erpSystemDisplayId": "string"
37 },
38 "currency": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "name": "string",
43 "decimalPoints": 0
44 },
45 "company": {
46 "id": 0,
47 "displayId": "string",
48 "status": "CREATED",
49 "erpSystemId": 0,
50 "erpSystemDisplayId": "string",
51 "countryId": 0,
52 "countryDisplayId": "string",
53 "name": "string",
54 "postingPeriodVariantId": 0,
55 "fiscalVariantId": 0
56 },
57 "purchaseOrderLineItems": [
58 {
59 "id": 0,
60 "displayId": "string",
61 "quantity": 0,
62 "allocatedQuantity": 0,
63 "receivedQuantity": 0,
64 "unitPrice": 0,
65 "description": "string",
66 "expenseCategory": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "expenseCategoryType": "PAYMENT"
72 },
73 "costCenter": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0
79 },
80 "profitCenter": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "validTo": "2019-08-24",
86 "erpSystemId": 0,
87 "erpSystemDisplayId": "string"
88 },
89 "taxJurisdiction": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0,
95 "schema": "string",
96 "countryDisplayId": "string"
97 },
98 "taxCode": {
99 "id": 0,
100 "displayId": "string",
101 "status": "CREATED",
102 "name": "string",
103 "erpSystemId": 0
104 },
105 "taxLineItems": [
106 {
107 "id": 0,
108 "taxRate": 0.1,
109 "taxAmount": 0,
110 "taxType": "string",
111 "purchaseOrderLineItemId": 0
112 }
113 ],
114 "purchaseOrderId": 0,
115 "purchaseOrderDisplayId": "string",
116 "purchaseOrderState": "INV_DRAFT",
117 "invoiceLineItems": [
118 {
119 "id": 0,
120 "displayId": "string",
121 "expenseCategory": {
122 "id": 0,
123 "displayId": "string",
124 "status": "CREATED",
125 "name": "string",
126 "expenseCategoryType": "PAYMENT"
127 },
128 "description": "string",
129 "unitOfMeasure": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "quantity": 0,
137 "unitPrice": 0,
138 "taxJurisdiction": {
139 "id": 0,
140 "displayId": "string",
141 "status": "CREATED",
142 "name": "string",
143 "erpSystemId": 0,
144 "schema": "string",
145 "countryDisplayId": "string"
146 },
147 "taxCode": {
148 "id": 0,
149 "displayId": "string",
150 "status": "CREATED",
151 "name": "string",
152 "erpSystemId": 0
153 },
154 "taxExpenseAccount": {
155 "id": 0,
156 "displayId": "string",
157 "generalLedgerAccountName": "string",
158 "generalLedgerAccountCode": "string",
159 "openItemManagement": true,
160 "accountCategory": "BALANCESHEET",
161 "shortName": "string",
162 "longName": "string"
163 },
164 "taxLineItems": [
165 {
166 "id": 0,
167 "taxRate": 0.1,
168 "taxAmount": 0,
169 "taxType": "string",
170 "invoiceLineItemId": 0
171 }
172 ],
173 "workBreakdownStructure": {
174 "id": 0,
175 "displayId": "string",
176 "status": "CREATED",
177 "name": "string",
178 "erpSystemId": 0
179 },
180 "costCenter": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "profitCenter": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "validTo": "2019-08-24",
193 "erpSystemId": 0,
194 "erpSystemDisplayId": "string"
195 },
196 "functionalArea": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "businessArea": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "erpSystemId": 0
209 },
210 "segment": {
211 "id": 0,
212 "displayId": "string",
213 "status": "CREATED",
214 "name": "string",
215 "erpSystemId": 0
216 },
217 "network": {
218 "id": 0,
219 "displayId": "string",
220 "status": "CREATED",
221 "name": "string",
222 "erpSystemId": 0
223 },
224 "internalOrderType": {
225 "id": 0,
226 "displayId": "string",
227 "status": "CREATED",
228 "name": "string",
229 "erpSystemId": 0
230 },
231 "internalOrder": {
232 "id": 0,
233 "displayId": "string",
234 "status": "CREATED",
235 "name": "string",
236 "erpSystemId": 0,
237 "internalOrderTypeId": 0
238 },
239 "additionalCurrencies": [
240 {
241 "id": 0,
242 "amount": 0,
243 "currency": {
244 "id": 0,
245 "displayId": "string",
246 "status": "CREATED",
247 "name": "string",
248 "decimalPoints": 0
249 },
250 "conversionRate": 0,
251 "conversionDate": "2019-08-24",
252 "translationDateType": "DOCUMENT_DATE",
253 "amountType": "NET_AMOUNT",
254 "currencyDefinitionType": "CONTRACT_CURRENCY",
255 "invoiceEntryId": 0,
256 "invoiceEntryDisplayId": "string"
257 }
258 ],
259 "scheduledPaymentMatches": [
260 {
261 "id": 0,
262 "fromId": 0,
263 "toId": 0,
264 "amount": 0
265 }
266 ],
267 "goodsReceiptLineItemLinks": [
268 {
269 "id": 0,
270 "fromId": 0,
271 "toId": 0,
272 "linkedQuantity": 0
273 }
274 ],
275 "invoiceId": 0,
276 "invoiceDisplayId": "string",
277 "invoiceState": "INV_DRAFT",
278 "vendorPaymentId": 0,
279 "purchaseOrderLineItemId": 0,
280 "netAmount": 0,
281 "allowsSystemGenerateNewId": true,
282 "numberRangeIdentifierValue": "string",
283 "numberRangeIdentifierType": {
284 "name": "string"
285 },
286 "numberRangeType": {
287 "name": "string"
288 }
289 }
290 ],
291 "goodsReceiptLineItems": [
292 {
293 "id": 0,
294 "displayId": "string",
295 "quantity": 0,
296 "invoicedQuantity": 0,
297 "description": "string",
298 "expenseCategory": {
299 "id": 0,
300 "displayId": "string",
301 "status": "CREATED",
302 "name": "string",
303 "expenseCategoryType": "PAYMENT"
304 },
305 "goodsReceiptId": 0,
306 "goodsReceiptDisplayId": "string",
307 "goodsReceiptState": "INV_DRAFT",
308 "purchaseOrderLineItemId": 0,
309 "invoiceLineItemLinks": [
310 {
311 "id": 0,
312 "fromId": 0,
313 "toId": 0,
314 "linkedQuantity": 0
315 }
316 ],
317 "availableQuantity": 0,
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327 ],
328 "vendorPaymentId": 0,
329 "purchaseRequisitionLineItemId": 0,
330 "purchaseRequisitionDisplayId": "string",
331 "purchaseRequisitionLineItemAvailableQuantity": 0,
332 "remainingQuantity": 0,
333 "availableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343 ],
344 "purchaseRequisitionIds": [
345 0
346 ],
347 "purchaseRequisitionDisplayIds": [
348 "string"
349 ],
350 "invoices": [
351 {
352 "id": 0,
353 "displayId": "string",
354 "name": "string",
355 "invoiceType": "VENDOR_INV",
356 "state": "INV_DRAFT",
357 "externalDocumentNumber": "string",
358 "purchaseOrderReference": "string",
359 "invoiceDate": "2019-08-24",
360 "dueDate": "2019-08-24",
361 "notes": "string",
362 "billingPeriodFromDate": "2019-08-24",
363 "billingPeriodToDate": "2019-08-24",
364 "currency": {
365 "id": 0,
366 "displayId": "string",
367 "status": "CREATED",
368 "name": "string",
369 "decimalPoints": 0
370 },
371 "vendor": {
372 "id": 0,
373 "displayId": "string",
374 "status": "CREATED",
375 "name": "string",
376 "erpSystemDisplayId": "string"
377 },
378 "company": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "erpSystemId": 0,
383 "erpSystemDisplayId": "string",
384 "countryId": 0,
385 "countryDisplayId": "string",
386 "name": "string",
387 "postingPeriodVariantId": 0,
388 "fiscalVariantId": 0
389 },
390 "netAmount": 0,
391 "taxAmount": 0,
392 "totalAmount": 0,
393 "netAmountBalance": 0,
394 "taxAmountBalance": 0,
395 "paymentTerm": {
396 "id": 0,
397 "displayId": "string",
398 "status": "CREATED",
399 "name": "string"
400 },
401 "paymentMethod": {
402 "id": 0,
403 "displayId": "string",
404 "status": "CREATED",
405 "name": "string",
406 "type": "string"
407 },
408 "paymentBlock": {
409 "id": 0,
410 "displayId": "string",
411 "status": "CREATED",
412 "name": "string"
413 },
414 "defaultCostCenter": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "erpSystemId": 0
420 },
421 "defaultProfitCenter": {
422 "id": 0,
423 "displayId": "string",
424 "status": "CREATED",
425 "name": "string",
426 "validTo": "2019-08-24",
427 "erpSystemId": 0,
428 "erpSystemDisplayId": "string"
429 },
430 "invoiceLineItems": [
431 {
432 "id": 0,
433 "displayId": "string",
434 "expenseCategory": {
435 "id": 0,
436 "displayId": "string",
437 "status": "CREATED",
438 "name": "string",
439 "expenseCategoryType": "PAYMENT"
440 },
441 "description": "string",
442 "unitOfMeasure": {
443 "id": 0,
444 "displayId": "string",
445 "status": "CREATED",
446 "name": "string",
447 "erpSystemId": 0
448 },
449 "quantity": 0,
450 "unitPrice": 0,
451 "taxJurisdiction": {
452 "id": 0,
453 "displayId": "string",
454 "status": "CREATED",
455 "name": "string",
456 "erpSystemId": 0,
457 "schema": "string",
458 "countryDisplayId": "string"
459 },
460 "taxCode": {
461 "id": 0,
462 "displayId": "string",
463 "status": "CREATED",
464 "name": "string",
465 "erpSystemId": 0
466 },
467 "taxExpenseAccount": {
468 "id": 0,
469 "displayId": "string",
470 "generalLedgerAccountName": "string",
471 "generalLedgerAccountCode": "string",
472 "openItemManagement": true,
473 "accountCategory": "BALANCESHEET",
474 "shortName": "string",
475 "longName": "string"
476 },
477 "taxLineItems": [
478 {
479 "id": 0,
480 "taxRate": 0.1,
481 "taxAmount": 0,
482 "taxType": "string",
483 "invoiceLineItemId": 0
484 }
485 ],
486 "workBreakdownStructure": {
487 "id": 0,
488 "displayId": "string",
489 "status": "CREATED",
490 "name": "string",
491 "erpSystemId": 0
492 },
493 "costCenter": {
494 "id": 0,
495 "displayId": "string",
496 "status": "CREATED",
497 "name": "string",
498 "erpSystemId": 0
499 },
500 "profitCenter": {
501 "id": 0,
502 "displayId": "string",
503 "status": "CREATED",
504 "name": "string",
505 "validTo": "2019-08-24",
506 "erpSystemId": 0,
507 "erpSystemDisplayId": "string"
508 },
509 "functionalArea": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "businessArea": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "segment": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "erpSystemId": 0
529 },
530 "network": {
531 "id": 0,
532 "displayId": "string",
533 "status": "CREATED",
534 "name": "string",
535 "erpSystemId": 0
536 },
537 "internalOrderType": {
538 "id": 0,
539 "displayId": "string",
540 "status": "CREATED",
541 "name": "string",
542 "erpSystemId": 0
543 },
544 "internalOrder": {
545 "id": 0,
546 "displayId": "string",
547 "status": "CREATED",
548 "name": "string",
549 "erpSystemId": 0,
550 "internalOrderTypeId": 0
551 },
552 "additionalCurrencies": [
553 {
554 "id": 0,
555 "amount": 0,
556 "currency": {
557 "id": 0,
558 "displayId": "string",
559 "status": "CREATED",
560 "name": "string",
561 "decimalPoints": 0
562 },
563 "conversionRate": 0,
564 "conversionDate": "2019-08-24",
565 "translationDateType": "DOCUMENT_DATE",
566 "amountType": "NET_AMOUNT",
567 "currencyDefinitionType": "CONTRACT_CURRENCY",
568 "invoiceEntryId": 0,
569 "invoiceEntryDisplayId": "string"
570 }
571 ],
572 "scheduledPaymentMatches": [
573 {
574 "id": 0,
575 "fromId": 0,
576 "toId": 0,
577 "amount": 0
578 }
579 ],
580 "goodsReceiptLineItemLinks": [
581 {
582 "id": 0,
583 "fromId": 0,
584 "toId": 0,
585 "linkedQuantity": 0
586 }
587 ],
588 "invoiceId": 0,
589 "invoiceDisplayId": "string",
590 "invoiceState": "INV_DRAFT",
591 "vendorPaymentId": 0,
592 "purchaseOrderLineItemId": 0,
593 "netAmount": 0,
594 "allowsSystemGenerateNewId": true,
595 "numberRangeIdentifierValue": "string",
596 "numberRangeIdentifierType": {
597 "name": "string"
598 },
599 "numberRangeType": {
600 "name": "string"
601 }
602 }
603 ],
604 "workspaceId": 0,
605 "workspaceDisplayId": "string",
606 "workspaceName": "string",
607 "workspaceState": "INV_DRAFT",
608 "remainingNetAmount": 0,
609 "remainingTaxAmount": 0,
610 "remainingTotalAmount": 0,
611 "pendingPaymentCount": 0,
612 "allPaymentsPosted": true,
613 "approvalInfo": {
614 "approverUsername": "string",
615 "approvedAt": "2019-08-24T14:15:22Z"
616 },
617 "rejectionReason": "string",
618 "allowsSystemGenerateNewId": true,
619 "numberRangeIdentifierValue": "string",
620 "numberRangeIdentifierType": {
621 "name": "string"
622 },
623 "numberRangeType": {
624 "name": "string"
625 }
626 }
627 ],
628 "rejectionReason": "string",
629 "allowsSystemGenerateNewId": true,
630 "numberRangeIdentifierValue": "string",
631 "numberRangeIdentifierType": {
632 "name": "string"
633 },
634 "numberRangeType": {
635 "name": "string"
636 }
637 }
638 ],
639 "number": 0,
640 "sort": {
641 "unsorted": true,
642 "sorted": true,
643 "empty": true
644 },
645 "first": true,
646 "last": true,
647 "empty": true
648}
Create A Resource¶
HTTP Request
POST /api/v1/purchase-order
📋 Description: Creates a single resource. Returns the created resource with its generated ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the purchase order details, including item specifications, quantities, pricing, and vendor information necessary for processing the order. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "state": "INV_DRAFT",
5 "issueDate": "2019-08-24",
6 "expectedDeliveryDate": "2019-08-24",
7 "name": "string",
8 "shippingAddress": "string",
9 "notes": "string",
10 "netAmount": 0,
11 "taxAmount": 0,
12 "externalPurchaseOrderDisplayId": "string",
13 "vendor": {
14 "id": 0,
15 "displayId": "string",
16 "status": "CREATED",
17 "name": "string",
18 "erpSystemDisplayId": "string"
19 },
20 "currency": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string",
25 "decimalPoints": 0
26 },
27 "company": {
28 "id": 0,
29 "displayId": "string",
30 "status": "CREATED",
31 "erpSystemId": 0,
32 "erpSystemDisplayId": "string",
33 "countryId": 0,
34 "countryDisplayId": "string",
35 "name": "string",
36 "postingPeriodVariantId": 0,
37 "fiscalVariantId": 0
38 },
39 "purchaseOrderLineItems": [
40 {
41 "id": 0,
42 "displayId": "string",
43 "quantity": 0,
44 "allocatedQuantity": 0,
45 "receivedQuantity": 0,
46 "unitPrice": 0,
47 "description": "string",
48 "expenseCategory": {
49 "id": 0,
50 "displayId": "string",
51 "status": "CREATED",
52 "name": "string",
53 "expenseCategoryType": "PAYMENT"
54 },
55 "costCenter": {
56 "id": 0,
57 "displayId": "string",
58 "status": "CREATED",
59 "name": "string",
60 "erpSystemId": 0
61 },
62 "profitCenter": {
63 "id": 0,
64 "displayId": "string",
65 "status": "CREATED",
66 "name": "string",
67 "validTo": "2019-08-24",
68 "erpSystemId": 0,
69 "erpSystemDisplayId": "string"
70 },
71 "taxJurisdiction": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "erpSystemId": 0,
77 "schema": "string",
78 "countryDisplayId": "string"
79 },
80 "taxCode": {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "erpSystemId": 0
86 },
87 "taxLineItems": [
88 {
89 "id": 0,
90 "taxRate": 0.1,
91 "taxAmount": 0,
92 "taxType": "string",
93 "purchaseOrderLineItemId": 0
94 }
95 ],
96 "purchaseOrderId": 0,
97 "purchaseOrderDisplayId": "string",
98 "purchaseOrderState": "INV_DRAFT",
99 "invoiceLineItems": [
100 {
101 "id": 0,
102 "displayId": "string",
103 "expenseCategory": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "expenseCategoryType": "PAYMENT"
109 },
110 "description": "string",
111 "unitOfMeasure": {
112 "id": 0,
113 "displayId": "string",
114 "status": "CREATED",
115 "name": "string",
116 "erpSystemId": 0
117 },
118 "quantity": 0,
119 "unitPrice": 0,
120 "taxJurisdiction": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "erpSystemId": 0,
126 "schema": "string",
127 "countryDisplayId": "string"
128 },
129 "taxCode": {
130 "id": 0,
131 "displayId": "string",
132 "status": "CREATED",
133 "name": "string",
134 "erpSystemId": 0
135 },
136 "taxExpenseAccount": {
137 "id": 0,
138 "displayId": "string",
139 "generalLedgerAccountName": "string",
140 "generalLedgerAccountCode": "string",
141 "openItemManagement": true,
142 "accountCategory": "BALANCESHEET",
143 "shortName": "string",
144 "longName": "string"
145 },
146 "taxLineItems": [
147 {
148 "id": 0,
149 "taxRate": 0.1,
150 "taxAmount": 0,
151 "taxType": "string",
152 "invoiceLineItemId": 0
153 }
154 ],
155 "workBreakdownStructure": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0
161 },
162 "costCenter": {
163 "id": 0,
164 "displayId": "string",
165 "status": "CREATED",
166 "name": "string",
167 "erpSystemId": 0
168 },
169 "profitCenter": {
170 "id": 0,
171 "displayId": "string",
172 "status": "CREATED",
173 "name": "string",
174 "validTo": "2019-08-24",
175 "erpSystemId": 0,
176 "erpSystemDisplayId": "string"
177 },
178 "functionalArea": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "businessArea": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "erpSystemId": 0
191 },
192 "segment": {
193 "id": 0,
194 "displayId": "string",
195 "status": "CREATED",
196 "name": "string",
197 "erpSystemId": 0
198 },
199 "network": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "internalOrderType": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "internalOrder": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0,
219 "internalOrderTypeId": 0
220 },
221 "additionalCurrencies": [
222 {
223 "id": 0,
224 "amount": 0,
225 "currency": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "decimalPoints": 0
231 },
232 "conversionRate": 0,
233 "conversionDate": "2019-08-24",
234 "translationDateType": "DOCUMENT_DATE",
235 "amountType": "NET_AMOUNT",
236 "currencyDefinitionType": "CONTRACT_CURRENCY",
237 "invoiceEntryId": 0,
238 "invoiceEntryDisplayId": "string"
239 }
240 ],
241 "scheduledPaymentMatches": [
242 {
243 "id": 0,
244 "fromId": 0,
245 "toId": 0,
246 "amount": 0
247 }
248 ],
249 "goodsReceiptLineItemLinks": [
250 {
251 "id": 0,
252 "fromId": 0,
253 "toId": 0,
254 "linkedQuantity": 0
255 }
256 ],
257 "invoiceId": 0,
258 "invoiceDisplayId": "string",
259 "invoiceState": "INV_DRAFT",
260 "vendorPaymentId": 0,
261 "purchaseOrderLineItemId": 0,
262 "netAmount": 0,
263 "allowsSystemGenerateNewId": true,
264 "numberRangeIdentifierValue": "string",
265 "numberRangeIdentifierType": {
266 "name": "string"
267 },
268 "numberRangeType": {
269 "name": "string"
270 }
271 }
272 ],
273 "goodsReceiptLineItems": [
274 {
275 "id": 0,
276 "displayId": "string",
277 "quantity": 0,
278 "invoicedQuantity": 0,
279 "description": "string",
280 "expenseCategory": {
281 "id": 0,
282 "displayId": "string",
283 "status": "CREATED",
284 "name": "string",
285 "expenseCategoryType": "PAYMENT"
286 },
287 "goodsReceiptId": 0,
288 "goodsReceiptDisplayId": "string",
289 "goodsReceiptState": "INV_DRAFT",
290 "purchaseOrderLineItemId": 0,
291 "invoiceLineItemLinks": [
292 {
293 "id": 0,
294 "fromId": 0,
295 "toId": 0,
296 "linkedQuantity": 0
297 }
298 ],
299 "allowsSystemGenerateNewId": true,
300 "numberRangeIdentifierValue": "string",
301 "numberRangeIdentifierType": {
302 "name": "string"
303 },
304 "numberRangeType": {
305 "name": "string"
306 }
307 }
308 ],
309 "vendorPaymentId": 0,
310 "purchaseRequisitionLineItemId": 0,
311 "purchaseRequisitionDisplayId": "string",
312 "purchaseRequisitionLineItemAvailableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "purchaseRequisitionIds": [
324 0
325 ],
326 "purchaseRequisitionDisplayIds": [
327 "string"
328 ],
329 "invoices": [
330 {
331 "id": 0,
332 "displayId": "string",
333 "name": "string",
334 "invoiceType": "VENDOR_INV",
335 "state": "INV_DRAFT",
336 "externalDocumentNumber": "string",
337 "purchaseOrderReference": "string",
338 "invoiceDate": "2019-08-24",
339 "dueDate": "2019-08-24",
340 "notes": "string",
341 "billingPeriodFromDate": "2019-08-24",
342 "billingPeriodToDate": "2019-08-24",
343 "currency": {
344 "id": 0,
345 "displayId": "string",
346 "status": "CREATED",
347 "name": "string",
348 "decimalPoints": 0
349 },
350 "vendor": {
351 "id": 0,
352 "displayId": "string",
353 "status": "CREATED",
354 "name": "string",
355 "erpSystemDisplayId": "string"
356 },
357 "company": {
358 "id": 0,
359 "displayId": "string",
360 "status": "CREATED",
361 "erpSystemId": 0,
362 "erpSystemDisplayId": "string",
363 "countryId": 0,
364 "countryDisplayId": "string",
365 "name": "string",
366 "postingPeriodVariantId": 0,
367 "fiscalVariantId": 0
368 },
369 "netAmount": 0,
370 "taxAmount": 0,
371 "totalAmount": 0,
372 "netAmountBalance": 0,
373 "taxAmountBalance": 0,
374 "paymentTerm": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "name": "string"
379 },
380 "paymentMethod": {
381 "id": 0,
382 "displayId": "string",
383 "status": "CREATED",
384 "name": "string",
385 "type": "string"
386 },
387 "paymentBlock": {
388 "id": 0,
389 "displayId": "string",
390 "status": "CREATED",
391 "name": "string"
392 },
393 "defaultCostCenter": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string",
398 "erpSystemId": 0
399 },
400 "defaultProfitCenter": {
401 "id": 0,
402 "displayId": "string",
403 "status": "CREATED",
404 "name": "string",
405 "validTo": "2019-08-24",
406 "erpSystemId": 0,
407 "erpSystemDisplayId": "string"
408 },
409 "invoiceLineItems": [
410 {
411 "id": 0,
412 "displayId": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "description": "string",
421 "unitOfMeasure": {
422 "id": 0,
423 "displayId": "string",
424 "status": "CREATED",
425 "name": "string",
426 "erpSystemId": 0
427 },
428 "quantity": 0,
429 "unitPrice": 0,
430 "taxJurisdiction": {
431 "id": 0,
432 "displayId": "string",
433 "status": "CREATED",
434 "name": "string",
435 "erpSystemId": 0,
436 "schema": "string",
437 "countryDisplayId": "string"
438 },
439 "taxCode": {
440 "id": 0,
441 "displayId": "string",
442 "status": "CREATED",
443 "name": "string",
444 "erpSystemId": 0
445 },
446 "taxExpenseAccount": {
447 "id": 0,
448 "displayId": "string",
449 "generalLedgerAccountName": "string",
450 "generalLedgerAccountCode": "string",
451 "openItemManagement": true,
452 "accountCategory": "BALANCESHEET",
453 "shortName": "string",
454 "longName": "string"
455 },
456 "taxLineItems": [
457 {
458 "id": 0,
459 "taxRate": 0.1,
460 "taxAmount": 0,
461 "taxType": "string",
462 "invoiceLineItemId": 0
463 }
464 ],
465 "workBreakdownStructure": {
466 "id": 0,
467 "displayId": "string",
468 "status": "CREATED",
469 "name": "string",
470 "erpSystemId": 0
471 },
472 "costCenter": {
473 "id": 0,
474 "displayId": "string",
475 "status": "CREATED",
476 "name": "string",
477 "erpSystemId": 0
478 },
479 "profitCenter": {
480 "id": 0,
481 "displayId": "string",
482 "status": "CREATED",
483 "name": "string",
484 "validTo": "2019-08-24",
485 "erpSystemId": 0,
486 "erpSystemDisplayId": "string"
487 },
488 "functionalArea": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "businessArea": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "erpSystemId": 0
501 },
502 "segment": {
503 "id": 0,
504 "displayId": "string",
505 "status": "CREATED",
506 "name": "string",
507 "erpSystemId": 0
508 },
509 "network": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "internalOrderType": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "internalOrder": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "erpSystemId": 0,
529 "internalOrderTypeId": 0
530 },
531 "additionalCurrencies": [
532 {
533 "id": 0,
534 "amount": 0,
535 "currency": {
536 "id": 0,
537 "displayId": "string",
538 "status": "CREATED",
539 "name": "string",
540 "decimalPoints": 0
541 },
542 "conversionRate": 0,
543 "conversionDate": "2019-08-24",
544 "translationDateType": "DOCUMENT_DATE",
545 "amountType": "NET_AMOUNT",
546 "currencyDefinitionType": "CONTRACT_CURRENCY",
547 "invoiceEntryId": 0,
548 "invoiceEntryDisplayId": "string"
549 }
550 ],
551 "scheduledPaymentMatches": [
552 {
553 "id": 0,
554 "fromId": 0,
555 "toId": 0,
556 "amount": 0
557 }
558 ],
559 "goodsReceiptLineItemLinks": [
560 {
561 "id": 0,
562 "fromId": 0,
563 "toId": 0,
564 "linkedQuantity": 0
565 }
566 ],
567 "invoiceId": 0,
568 "invoiceDisplayId": "string",
569 "invoiceState": "INV_DRAFT",
570 "vendorPaymentId": 0,
571 "purchaseOrderLineItemId": 0,
572 "netAmount": 0,
573 "allowsSystemGenerateNewId": true,
574 "numberRangeIdentifierValue": "string",
575 "numberRangeIdentifierType": {
576 "name": "string"
577 },
578 "numberRangeType": {
579 "name": "string"
580 }
581 }
582 ],
583 "workspaceId": 0,
584 "workspaceDisplayId": "string",
585 "workspaceName": "string",
586 "workspaceState": "INV_DRAFT",
587 "remainingNetAmount": 0,
588 "remainingTaxAmount": 0,
589 "remainingTotalAmount": 0,
590 "pendingPaymentCount": 0,
591 "allPaymentsPosted": true,
592 "approvalInfo": {
593 "approverUsername": "string",
594 "approvedAt": "2019-08-24T14:15:22Z"
595 },
596 "rejectionReason": "string",
597 "allowsSystemGenerateNewId": true,
598 "numberRangeIdentifierValue": "string",
599 "numberRangeIdentifierType": {
600 "name": "string"
601 },
602 "numberRangeType": {
603 "name": "string"
604 }
605 }
606 ],
607 "rejectionReason": "string",
608 "allowsSystemGenerateNewId": true,
609 "numberRangeIdentifierValue": "string",
610 "numberRangeIdentifierType": {
611 "name": "string"
612 },
613 "numberRangeType": {
614 "name": "string"
615 }
616}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "state": "INV_DRAFT",
18 "issueDate": "2019-08-24",
19 "expectedDeliveryDate": "2019-08-24",
20 "name": "string",
21 "shippingAddress": "string",
22 "notes": "string",
23 "netAmount": 0,
24 "taxAmount": 0,
25 "externalPurchaseOrderDisplayId": "string",
26 "vendor": {
27 "id": 0,
28 "displayId": "string",
29 "status": "CREATED",
30 "name": "string",
31 "erpSystemDisplayId": "string"
32 },
33 "currency": {
34 "id": 0,
35 "displayId": "string",
36 "status": "CREATED",
37 "name": "string",
38 "decimalPoints": 0
39 },
40 "company": {
41 "id": 0,
42 "displayId": "string",
43 "status": "CREATED",
44 "erpSystemId": 0,
45 "erpSystemDisplayId": "string",
46 "countryId": 0,
47 "countryDisplayId": "string",
48 "name": "string",
49 "postingPeriodVariantId": 0,
50 "fiscalVariantId": 0
51 },
52 "purchaseOrderLineItems": [
53 {
54 "id": 0,
55 "displayId": "string",
56 "quantity": 0,
57 "allocatedQuantity": 0,
58 "receivedQuantity": 0,
59 "unitPrice": 0,
60 "description": "string",
61 "expenseCategory": {
62 "id": 0,
63 "displayId": "string",
64 "status": "CREATED",
65 "name": "string",
66 "expenseCategoryType": "PAYMENT"
67 },
68 "costCenter": {
69 "id": 0,
70 "displayId": "string",
71 "status": "CREATED",
72 "name": "string",
73 "erpSystemId": 0
74 },
75 "profitCenter": {
76 "id": 0,
77 "displayId": "string",
78 "status": "CREATED",
79 "name": "string",
80 "validTo": "2019-08-24",
81 "erpSystemId": 0,
82 "erpSystemDisplayId": "string"
83 },
84 "taxJurisdiction": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "erpSystemId": 0,
90 "schema": "string",
91 "countryDisplayId": "string"
92 },
93 "taxCode": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0
99 },
100 "taxLineItems": [
101 {
102 "id": 0,
103 "taxRate": 0.1,
104 "taxAmount": 0,
105 "taxType": "string",
106 "purchaseOrderLineItemId": 0
107 }
108 ],
109 "purchaseOrderId": 0,
110 "purchaseOrderDisplayId": "string",
111 "purchaseOrderState": "INV_DRAFT",
112 "invoiceLineItems": [
113 {
114 "id": 0,
115 "displayId": "string",
116 "expenseCategory": {
117 "id": 0,
118 "displayId": "string",
119 "status": "CREATED",
120 "name": "string",
121 "expenseCategoryType": "PAYMENT"
122 },
123 "description": "string",
124 "unitOfMeasure": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "erpSystemId": 0
130 },
131 "quantity": 0,
132 "unitPrice": 0,
133 "taxJurisdiction": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0,
139 "schema": "string",
140 "countryDisplayId": "string"
141 },
142 "taxCode": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0
148 },
149 "taxExpenseAccount": {
150 "id": 0,
151 "displayId": "string",
152 "generalLedgerAccountName": "string",
153 "generalLedgerAccountCode": "string",
154 "openItemManagement": true,
155 "accountCategory": "BALANCESHEET",
156 "shortName": "string",
157 "longName": "string"
158 },
159 "taxLineItems": [
160 {
161 "id": 0,
162 "taxRate": 0.1,
163 "taxAmount": 0,
164 "taxType": "string",
165 "invoiceLineItemId": 0
166 }
167 ],
168 "workBreakdownStructure": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "costCenter": {
176 "id": 0,
177 "displayId": "string",
178 "status": "CREATED",
179 "name": "string",
180 "erpSystemId": 0
181 },
182 "profitCenter": {
183 "id": 0,
184 "displayId": "string",
185 "status": "CREATED",
186 "name": "string",
187 "validTo": "2019-08-24",
188 "erpSystemId": 0,
189 "erpSystemDisplayId": "string"
190 },
191 "functionalArea": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "businessArea": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "erpSystemId": 0
204 },
205 "segment": {
206 "id": 0,
207 "displayId": "string",
208 "status": "CREATED",
209 "name": "string",
210 "erpSystemId": 0
211 },
212 "network": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "internalOrderType": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "internalOrder": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0,
232 "internalOrderTypeId": 0
233 },
234 "additionalCurrencies": [
235 {
236 "id": 0,
237 "amount": 0,
238 "currency": {
239 "id": 0,
240 "displayId": "string",
241 "status": "CREATED",
242 "name": "string",
243 "decimalPoints": 0
244 },
245 "conversionRate": 0,
246 "conversionDate": "2019-08-24",
247 "translationDateType": "DOCUMENT_DATE",
248 "amountType": "NET_AMOUNT",
249 "currencyDefinitionType": "CONTRACT_CURRENCY",
250 "invoiceEntryId": 0,
251 "invoiceEntryDisplayId": "string"
252 }
253 ],
254 "scheduledPaymentMatches": [
255 {
256 "id": 0,
257 "fromId": 0,
258 "toId": 0,
259 "amount": 0
260 }
261 ],
262 "goodsReceiptLineItemLinks": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "linkedQuantity": 0
268 }
269 ],
270 "invoiceId": 0,
271 "invoiceDisplayId": "string",
272 "invoiceState": "INV_DRAFT",
273 "vendorPaymentId": 0,
274 "purchaseOrderLineItemId": 0,
275 "netAmount": 0,
276 "allowsSystemGenerateNewId": true,
277 "numberRangeIdentifierValue": "string",
278 "numberRangeIdentifierType": {
279 "name": "string"
280 },
281 "numberRangeType": {
282 "name": "string"
283 }
284 }
285 ],
286 "goodsReceiptLineItems": [
287 {
288 "id": 0,
289 "displayId": "string",
290 "quantity": 0,
291 "invoicedQuantity": 0,
292 "description": "string",
293 "expenseCategory": {
294 "id": 0,
295 "displayId": "string",
296 "status": "CREATED",
297 "name": "string",
298 "expenseCategoryType": "PAYMENT"
299 },
300 "goodsReceiptId": 0,
301 "goodsReceiptDisplayId": "string",
302 "goodsReceiptState": "INV_DRAFT",
303 "purchaseOrderLineItemId": 0,
304 "invoiceLineItemLinks": [
305 {
306 "id": 0,
307 "fromId": 0,
308 "toId": 0,
309 "linkedQuantity": 0
310 }
311 ],
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "vendorPaymentId": 0,
324 "purchaseRequisitionLineItemId": 0,
325 "purchaseRequisitionDisplayId": "string",
326 "purchaseRequisitionLineItemAvailableQuantity": 0,
327 "remainingQuantity": 0,
328 "availableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "purchaseRequisitionIds": [
340 0
341 ],
342 "purchaseRequisitionDisplayIds": [
343 "string"
344 ],
345 "invoices": [
346 {
347 "id": 0,
348 "displayId": "string",
349 "name": "string",
350 "invoiceType": "VENDOR_INV",
351 "state": "INV_DRAFT",
352 "externalDocumentNumber": "string",
353 "purchaseOrderReference": "string",
354 "invoiceDate": "2019-08-24",
355 "dueDate": "2019-08-24",
356 "notes": "string",
357 "billingPeriodFromDate": "2019-08-24",
358 "billingPeriodToDate": "2019-08-24",
359 "currency": {
360 "id": 0,
361 "displayId": "string",
362 "status": "CREATED",
363 "name": "string",
364 "decimalPoints": 0
365 },
366 "vendor": {
367 "id": 0,
368 "displayId": "string",
369 "status": "CREATED",
370 "name": "string",
371 "erpSystemDisplayId": "string"
372 },
373 "company": {
374 "id": 0,
375 "displayId": "string",
376 "status": "CREATED",
377 "erpSystemId": 0,
378 "erpSystemDisplayId": "string",
379 "countryId": 0,
380 "countryDisplayId": "string",
381 "name": "string",
382 "postingPeriodVariantId": 0,
383 "fiscalVariantId": 0
384 },
385 "netAmount": 0,
386 "taxAmount": 0,
387 "totalAmount": 0,
388 "netAmountBalance": 0,
389 "taxAmountBalance": 0,
390 "paymentTerm": {
391 "id": 0,
392 "displayId": "string",
393 "status": "CREATED",
394 "name": "string"
395 },
396 "paymentMethod": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "type": "string"
402 },
403 "paymentBlock": {
404 "id": 0,
405 "displayId": "string",
406 "status": "CREATED",
407 "name": "string"
408 },
409 "defaultCostCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "defaultProfitCenter": {
417 "id": 0,
418 "displayId": "string",
419 "status": "CREATED",
420 "name": "string",
421 "validTo": "2019-08-24",
422 "erpSystemId": 0,
423 "erpSystemDisplayId": "string"
424 },
425 "invoiceLineItems": [
426 {
427 "id": 0,
428 "displayId": "string",
429 "expenseCategory": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "expenseCategoryType": "PAYMENT"
435 },
436 "description": "string",
437 "unitOfMeasure": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "erpSystemId": 0
443 },
444 "quantity": 0,
445 "unitPrice": 0,
446 "taxJurisdiction": {
447 "id": 0,
448 "displayId": "string",
449 "status": "CREATED",
450 "name": "string",
451 "erpSystemId": 0,
452 "schema": "string",
453 "countryDisplayId": "string"
454 },
455 "taxCode": {
456 "id": 0,
457 "displayId": "string",
458 "status": "CREATED",
459 "name": "string",
460 "erpSystemId": 0
461 },
462 "taxExpenseAccount": {
463 "id": 0,
464 "displayId": "string",
465 "generalLedgerAccountName": "string",
466 "generalLedgerAccountCode": "string",
467 "openItemManagement": true,
468 "accountCategory": "BALANCESHEET",
469 "shortName": "string",
470 "longName": "string"
471 },
472 "taxLineItems": [
473 {
474 "id": 0,
475 "taxRate": 0.1,
476 "taxAmount": 0,
477 "taxType": "string",
478 "invoiceLineItemId": 0
479 }
480 ],
481 "workBreakdownStructure": {
482 "id": 0,
483 "displayId": "string",
484 "status": "CREATED",
485 "name": "string",
486 "erpSystemId": 0
487 },
488 "costCenter": {
489 "id": 0,
490 "displayId": "string",
491 "status": "CREATED",
492 "name": "string",
493 "erpSystemId": 0
494 },
495 "profitCenter": {
496 "id": 0,
497 "displayId": "string",
498 "status": "CREATED",
499 "name": "string",
500 "validTo": "2019-08-24",
501 "erpSystemId": 0,
502 "erpSystemDisplayId": "string"
503 },
504 "functionalArea": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "businessArea": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "segment": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "erpSystemId": 0
524 },
525 "network": {
526 "id": 0,
527 "displayId": "string",
528 "status": "CREATED",
529 "name": "string",
530 "erpSystemId": 0
531 },
532 "internalOrderType": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "internalOrder": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0,
545 "internalOrderTypeId": 0
546 },
547 "additionalCurrencies": [
548 {
549 "id": 0,
550 "amount": 0,
551 "currency": {
552 "id": 0,
553 "displayId": "string",
554 "status": "CREATED",
555 "name": "string",
556 "decimalPoints": 0
557 },
558 "conversionRate": 0,
559 "conversionDate": "2019-08-24",
560 "translationDateType": "DOCUMENT_DATE",
561 "amountType": "NET_AMOUNT",
562 "currencyDefinitionType": "CONTRACT_CURRENCY",
563 "invoiceEntryId": 0,
564 "invoiceEntryDisplayId": "string"
565 }
566 ],
567 "scheduledPaymentMatches": [
568 {
569 "id": 0,
570 "fromId": 0,
571 "toId": 0,
572 "amount": 0
573 }
574 ],
575 "goodsReceiptLineItemLinks": [
576 {
577 "id": 0,
578 "fromId": 0,
579 "toId": 0,
580 "linkedQuantity": 0
581 }
582 ],
583 "invoiceId": 0,
584 "invoiceDisplayId": "string",
585 "invoiceState": "INV_DRAFT",
586 "vendorPaymentId": 0,
587 "purchaseOrderLineItemId": 0,
588 "netAmount": 0,
589 "allowsSystemGenerateNewId": true,
590 "numberRangeIdentifierValue": "string",
591 "numberRangeIdentifierType": {
592 "name": "string"
593 },
594 "numberRangeType": {
595 "name": "string"
596 }
597 }
598 ],
599 "workspaceId": 0,
600 "workspaceDisplayId": "string",
601 "workspaceName": "string",
602 "workspaceState": "INV_DRAFT",
603 "remainingNetAmount": 0,
604 "remainingTaxAmount": 0,
605 "remainingTotalAmount": 0,
606 "pendingPaymentCount": 0,
607 "allPaymentsPosted": true,
608 "approvalInfo": {
609 "approverUsername": "string",
610 "approvedAt": "2019-08-24T14:15:22Z"
611 },
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "rejectionReason": "string",
624 "allowsSystemGenerateNewId": true,
625 "numberRangeIdentifierValue": "string",
626 "numberRangeIdentifierType": {
627 "name": "string"
628 },
629 "numberRangeType": {
630 "name": "string"
631 }
632 }
633}
Get Workflow State History For A Purchase Order¶
HTTP Request
GET /api/v1/purchase-order/{purchaseOrderId}/state-history
📋 Description: Returns the ordered list of state transitions the purchase order has gone through.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseOrderId |
path |
integer(int64) |
true |
Unique identifier for the purchase order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "id": 0,
4 "success": true,
5 "failedMessage": "string",
6 "warningMessage": "string",
7 "fromState": "string",
8 "event": "string",
9 "comment": "string",
10 "purchaseOrderId": 0
11 }
12]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the historical states of a purchase order, capturing key status changes and timestamps to provide insights into the order’s lifecycle and facilitate effective procurement management.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» success |
boolean |
false |
none |
Indicates whether the purchase order state transition was successful. |
» failedMessage |
string |
false |
none |
Contains the error message associated with a failed purchase order transaction, providing insights for troubleshooting and resolution. |
» warningMessage |
string |
false |
none |
Message indicating any warnings related to the state changes of a purchase order, providing essential insights for order management. |
» fromState |
string |
false |
none |
Represents the state from which the purchase order transitioned, providing insight into its historical processing status. |
» event |
string |
false |
none |
Represents the specific event associated with the purchase order state change, providing essential context for tracking order status transitions. |
» comment |
string |
false |
none |
Textual feedback or remarks associated with the changes in the purchase order state, providing context for the transaction history. |
» purchaseOrderId |
integer(int64) |
false |
none |
Unique identifier for the purchase order |
Check Whether A Purchase Order Is Marked As Favourite By The Current User¶
HTTP Request
GET /api/v1/purchase-order/{purchaseOrderId}/is-favorite
📋 Description: Check whether a purchase order is marked as favourite by the current user
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseOrderId |
path |
integer(int64) |
true |
Unique identifier for the purchase order |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1true
Get Recently Viewed Purchase Orders For The Current User¶
HTTP Request
GET /api/v1/purchase-order/recents
📋 Description: Get recently viewed purchase orders for the current user
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "internalId": "string",
4 "foreignId": "string",
5 "objectType": "string",
6 "recentType": "VIEWED",
7 "username": "string",
8 "lastAccess": "2019-08-24T14:15:22Z"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the most recent model utilized in predictive analytics, encapsulating key attributes and performance metrics to support informed decision-making in business strategy.] |
|
» internalId |
string |
false |
none |
Unique identifier for the internal |
» foreignId |
string |
false |
none |
Unique identifier for the foreign |
» objectType |
string |
false |
none |
Type of the object |
» recentType |
string |
false |
none |
Type of the recent |
» username |
string |
false |
none |
Represents the unique identifier for a user within the system, facilitating user management and authentication processes. |
» lastAccess |
string(date-time) |
false |
none |
Timestamp indicating the most recent access to the resource, facilitating tracking of user engagement and system utilization. |
Enumerated Values
Attribute |
Value |
|---|---|
recentType |
APPROVED, CLOSED, MODIFIED, VIEWED |
Get All Purchase Orders Marked As Favourite By The Current User¶
HTTP Request
GET /api/v1/purchase-order/favorites
📋 Description: Get all purchase orders marked as favourite by the current user
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1[
2 {
3 "internalId": "string",
4 "foreignId": "string",
5 "objectType": "string",
6 "username": "string",
7 "sequenceNumber": 0,
8 "createdAt": "2019-08-24T14:15:22Z"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a user’s preferred items within the application, facilitating personalized experiences and enhancing user engagement.] |
|
» internalId |
string |
false |
none |
Unique identifier for the internal |
» foreignId |
string |
false |
none |
Unique identifier for the foreign |
» objectType |
string |
false |
none |
Type of the object |
» username |
string |
false |
none |
Represents the unique username associated with a user in the system, facilitating user identification and access management. |
» sequenceNumber |
integer(int32) |
false |
none |
Sequential identifier for the favorite items, ensuring a consistent order within the user’s preferences. |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
Delete A User Link From A Purchase Order¶
HTTP Request
DELETE /api/v1/purchase-order/link/{linkId}
📋 Description: Delete a user link from a purchase order
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
linkId |
path |
integer(int64) |
true |
Link ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "errorCode": "string",
3 "balances": [
4 {
5 "id": 0,
6 "displayId": "string",
7 "invoiceId": 0,
8 "invoiceDisplayId": "string",
9 "invoiceLineItemId": 0,
10 "invoiceLineItemDisplayId": "string",
11 "invoiceLineItemDescription": "string",
12 "expenseCategory": {
13 "id": 0,
14 "displayId": "string",
15 "name": "string"
16 },
17 "totalNetAmount": 0,
18 "totalTaxAmount": 0,
19 "reservedNetAmount": 0,
20 "reservedTaxAmount": 0,
21 "remainingTotalAmount": 0,
22 "remainingNetAmount": 0,
23 "remainingTaxAmount": 0,
24 "allowsSystemGenerateNewId": true,
25 "numberRangeIdentifierValue": "string",
26 "numberRangeIdentifierType": {
27 "name": "string"
28 },
29 "numberRangeType": {
30 "name": "string"
31 }
32 }
33 ]
34}