Purchase Requisition¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/purchase-requisition/{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 "shippingAddress": "string",
18 "state": "INV_DRAFT",
19 "notes": "string",
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 "totalAmount": 0,
40 "purchaseRequisitionItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
72 "purchaseRequisitionDisplayId": "string",
73 "purchaseOrderLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "quantity": 0,
78 "allocatedQuantity": 0,
79 "receivedQuantity": 0,
80 "unitPrice": 0,
81 "description": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "costCenter": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0
95 },
96 "profitCenter": {
97 "id": 0,
98 "displayId": "string",
99 "status": "CREATED",
100 "name": "string",
101 "validTo": "2019-08-24",
102 "erpSystemId": 0,
103 "erpSystemDisplayId": "string"
104 },
105 "taxJurisdiction": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0,
111 "schema": "string",
112 "countryDisplayId": "string"
113 },
114 "taxCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "purchaseOrderLineItemId": 0
128 }
129 ],
130 "purchaseOrderId": 0,
131 "purchaseOrderDisplayId": "string",
132 "purchaseOrderState": "INV_DRAFT",
133 "invoiceLineItems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "expenseCategory": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "expenseCategoryType": "PAYMENT"
143 },
144 "description": "string",
145 "unitOfMeasure": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string",
150 "erpSystemId": 0
151 },
152 "quantity": 0,
153 "unitPrice": 0,
154 "taxJurisdiction": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0,
160 "schema": "string",
161 "countryDisplayId": "string"
162 },
163 "taxCode": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "taxExpenseAccount": {
171 "id": 0,
172 "displayId": "string",
173 "generalLedgerAccountName": "string",
174 "generalLedgerAccountCode": "string",
175 "openItemManagement": true,
176 "accountCategory": "BALANCESHEET",
177 "shortName": "string",
178 "longName": "string"
179 },
180 "taxLineItems": [
181 {
182 "id": 0,
183 "taxRate": 0.1,
184 "taxAmount": 0,
185 "taxType": "string",
186 "invoiceLineItemId": 0
187 }
188 ],
189 "workBreakdownStructure": {
190 "id": 0,
191 "displayId": "string",
192 "status": "CREATED",
193 "name": "string",
194 "erpSystemId": 0
195 },
196 "costCenter": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "profitCenter": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "validTo": "2019-08-24",
209 "erpSystemId": 0,
210 "erpSystemDisplayId": "string"
211 },
212 "functionalArea": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "businessArea": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "segment": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0
232 },
233 "network": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "erpSystemId": 0
239 },
240 "internalOrderType": {
241 "id": 0,
242 "displayId": "string",
243 "status": "CREATED",
244 "name": "string",
245 "erpSystemId": 0
246 },
247 "internalOrder": {
248 "id": 0,
249 "displayId": "string",
250 "status": "CREATED",
251 "name": "string",
252 "erpSystemId": 0,
253 "internalOrderTypeId": 0
254 },
255 "additionalCurrencies": [
256 {
257 "id": 0,
258 "amount": 0,
259 "currency": {},
260 "conversionRate": 0,
261 "conversionDate": "2019-08-24",
262 "translationDateType": "DOCUMENT_DATE",
263 "amountType": "NET_AMOUNT",
264 "currencyDefinitionType": "CONTRACT_CURRENCY",
265 "invoiceEntryId": 0,
266 "invoiceEntryDisplayId": "string"
267 }
268 ],
269 "scheduledPaymentMatches": [
270 {
271 "id": 0,
272 "fromId": 0,
273 "toId": 0,
274 "amount": 0
275 }
276 ],
277 "goodsReceiptLineItemLinks": [
278 {
279 "id": 0,
280 "fromId": 0,
281 "toId": 0,
282 "linkedQuantity": 0
283 }
284 ],
285 "invoiceId": 0,
286 "invoiceDisplayId": "string",
287 "invoiceState": "INV_DRAFT",
288 "vendorPaymentId": 0,
289 "purchaseOrderLineItemId": 0,
290 "netAmount": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ],
301 "goodsReceiptLineItems": [
302 {
303 "id": 0,
304 "displayId": "string",
305 "quantity": 0,
306 "invoicedQuantity": 0,
307 "description": "string",
308 "expenseCategory": {
309 "id": 0,
310 "displayId": "string",
311 "status": "CREATED",
312 "name": "string",
313 "expenseCategoryType": "PAYMENT"
314 },
315 "goodsReceiptId": 0,
316 "goodsReceiptDisplayId": "string",
317 "goodsReceiptState": "INV_DRAFT",
318 "purchaseOrderLineItemId": 0,
319 "invoiceLineItemLinks": [
320 {
321 "id": 0,
322 "fromId": 0,
323 "toId": 0,
324 "linkedQuantity": 0
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "vendorPaymentId": 0,
339 "purchaseRequisitionLineItemId": 0,
340 "purchaseRequisitionDisplayId": "string",
341 "purchaseRequisitionLineItemAvailableQuantity": 0,
342 "remainingQuantity": 0,
343 "availableQuantity": 0,
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "availableQuantity": 0,
355 "allowsSystemGenerateNewId": true,
356 "numberRangeIdentifierValue": "string",
357 "numberRangeIdentifierType": {
358 "name": "string"
359 },
360 "numberRangeType": {
361 "name": "string"
362 }
363 }
364 ],
365 "purchaseOrders": [
366 {
367 "id": 0,
368 "displayId": "string",
369 "state": "INV_DRAFT",
370 "issueDate": "2019-08-24",
371 "expectedDeliveryDate": "2019-08-24",
372 "name": "string",
373 "shippingAddress": "string",
374 "notes": "string",
375 "netAmount": 0,
376 "taxAmount": 0,
377 "externalPurchaseOrderDisplayId": "string",
378 "vendor": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "name": "string",
383 "erpSystemDisplayId": "string"
384 },
385 "currency": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "decimalPoints": 0
391 },
392 "company": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "erpSystemId": 0,
397 "erpSystemDisplayId": "string",
398 "countryId": 0,
399 "countryDisplayId": "string",
400 "name": "string",
401 "postingPeriodVariantId": 0,
402 "fiscalVariantId": 0
403 },
404 "purchaseOrderLineItems": [
405 {
406 "id": 0,
407 "displayId": "string",
408 "quantity": 0,
409 "allocatedQuantity": 0,
410 "receivedQuantity": 0,
411 "unitPrice": 0,
412 "description": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "costCenter": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0
426 },
427 "profitCenter": {
428 "id": 0,
429 "displayId": "string",
430 "status": "CREATED",
431 "name": "string",
432 "validTo": "2019-08-24",
433 "erpSystemId": 0,
434 "erpSystemDisplayId": "string"
435 },
436 "taxJurisdiction": {
437 "id": 0,
438 "displayId": "string",
439 "status": "CREATED",
440 "name": "string",
441 "erpSystemId": 0,
442 "schema": "string",
443 "countryDisplayId": "string"
444 },
445 "taxCode": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "taxLineItems": [
453 {
454 "id": 0,
455 "taxRate": 0.1,
456 "taxAmount": 0,
457 "taxType": "string",
458 "purchaseOrderLineItemId": 0
459 }
460 ],
461 "purchaseOrderId": 0,
462 "purchaseOrderDisplayId": "string",
463 "purchaseOrderState": "INV_DRAFT",
464 "invoiceLineItems": [
465 {
466 "id": 0,
467 "displayId": "string",
468 "expenseCategory": {
469 "id": 0,
470 "displayId": "string",
471 "status": "CREATED",
472 "name": "string",
473 "expenseCategoryType": "PAYMENT"
474 },
475 "description": "string",
476 "unitOfMeasure": {
477 "id": 0,
478 "displayId": "string",
479 "status": "CREATED",
480 "name": "string",
481 "erpSystemId": 0
482 },
483 "quantity": 0,
484 "unitPrice": 0,
485 "taxJurisdiction": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "erpSystemId": 0,
491 "schema": "string",
492 "countryDisplayId": "string"
493 },
494 "taxCode": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "taxExpenseAccount": {
502 "id": 0,
503 "displayId": "string",
504 "generalLedgerAccountName": "string",
505 "generalLedgerAccountCode": "string",
506 "openItemManagement": true,
507 "accountCategory": "BALANCESHEET",
508 "shortName": "string",
509 "longName": "string"
510 },
511 "taxLineItems": [
512 {
513 "id": 0,
514 "taxRate": 0.1,
515 "taxAmount": 0,
516 "taxType": "string",
517 "invoiceLineItemId": 0
518 }
519 ],
520 "workBreakdownStructure": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "costCenter": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "profitCenter": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "validTo": "2019-08-24",
540 "erpSystemId": 0,
541 "erpSystemDisplayId": "string"
542 },
543 "functionalArea": {
544 "id": 0,
545 "displayId": "string",
546 "status": "CREATED",
547 "name": "string",
548 "erpSystemId": 0
549 },
550 "businessArea": {
551 "id": 0,
552 "displayId": "string",
553 "status": "CREATED",
554 "name": "string",
555 "erpSystemId": 0
556 },
557 "segment": {
558 "id": 0,
559 "displayId": "string",
560 "status": "CREATED",
561 "name": "string",
562 "erpSystemId": 0
563 },
564 "network": {
565 "id": 0,
566 "displayId": "string",
567 "status": "CREATED",
568 "name": "string",
569 "erpSystemId": 0
570 },
571 "internalOrderType": {
572 "id": 0,
573 "displayId": "string",
574 "status": "CREATED",
575 "name": "string",
576 "erpSystemId": 0
577 },
578 "internalOrder": {
579 "id": 0,
580 "displayId": "string",
581 "status": "CREATED",
582 "name": "string",
583 "erpSystemId": 0,
584 "internalOrderTypeId": 0
585 },
586 "additionalCurrencies": [
587 {
588 "id": 0,
589 "amount": 0,
590 "currency": {},
591 "conversionRate": 0,
592 "conversionDate": "2019-08-24",
593 "translationDateType": "DOCUMENT_DATE",
594 "amountType": "NET_AMOUNT",
595 "currencyDefinitionType": "CONTRACT_CURRENCY",
596 "invoiceEntryId": 0,
597 "invoiceEntryDisplayId": "string"
598 }
599 ],
600 "scheduledPaymentMatches": [
601 {
602 "id": 0,
603 "fromId": 0,
604 "toId": 0,
605 "amount": 0
606 }
607 ],
608 "goodsReceiptLineItemLinks": [
609 {
610 "id": 0,
611 "fromId": 0,
612 "toId": 0,
613 "linkedQuantity": 0
614 }
615 ],
616 "invoiceId": 0,
617 "invoiceDisplayId": "string",
618 "invoiceState": "INV_DRAFT",
619 "vendorPaymentId": 0,
620 "purchaseOrderLineItemId": 0,
621 "netAmount": 0,
622 "allowsSystemGenerateNewId": true,
623 "numberRangeIdentifierValue": "string",
624 "numberRangeIdentifierType": {
625 "name": "string"
626 },
627 "numberRangeType": {
628 "name": "string"
629 }
630 }
631 ],
632 "goodsReceiptLineItems": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "quantity": 0,
637 "invoicedQuantity": 0,
638 "description": "string",
639 "expenseCategory": {
640 "id": 0,
641 "displayId": "string",
642 "status": "CREATED",
643 "name": "string",
644 "expenseCategoryType": "PAYMENT"
645 },
646 "goodsReceiptId": 0,
647 "goodsReceiptDisplayId": "string",
648 "goodsReceiptState": "INV_DRAFT",
649 "purchaseOrderLineItemId": 0,
650 "invoiceLineItemLinks": [
651 {
652 "id": 0,
653 "fromId": 0,
654 "toId": 0,
655 "linkedQuantity": 0
656 }
657 ],
658 "availableQuantity": 0,
659 "allowsSystemGenerateNewId": true,
660 "numberRangeIdentifierValue": "string",
661 "numberRangeIdentifierType": {
662 "name": "string"
663 },
664 "numberRangeType": {
665 "name": "string"
666 }
667 }
668 ],
669 "vendorPaymentId": 0,
670 "purchaseRequisitionLineItemId": 0,
671 "purchaseRequisitionDisplayId": "string",
672 "purchaseRequisitionLineItemAvailableQuantity": 0,
673 "remainingQuantity": 0,
674 "availableQuantity": 0,
675 "allowsSystemGenerateNewId": true,
676 "numberRangeIdentifierValue": "string",
677 "numberRangeIdentifierType": {
678 "name": "string"
679 },
680 "numberRangeType": {
681 "name": "string"
682 }
683 }
684 ],
685 "purchaseRequisitionIds": [
686 0
687 ],
688 "purchaseRequisitionDisplayIds": [
689 "string"
690 ],
691 "invoices": [
692 {
693 "id": 0,
694 "displayId": "string",
695 "name": "string",
696 "invoiceType": "VENDOR_INV",
697 "state": "INV_DRAFT",
698 "externalDocumentNumber": "string",
699 "purchaseOrderReference": "string",
700 "invoiceDate": "2019-08-24",
701 "dueDate": "2019-08-24",
702 "notes": "string",
703 "billingPeriodFromDate": "2019-08-24",
704 "billingPeriodToDate": "2019-08-24",
705 "currency": {
706 "id": 0,
707 "displayId": "string",
708 "status": "CREATED",
709 "name": "string",
710 "decimalPoints": 0
711 },
712 "vendor": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "erpSystemDisplayId": "string"
718 },
719 "company": {
720 "id": 0,
721 "displayId": "string",
722 "status": "CREATED",
723 "erpSystemId": 0,
724 "erpSystemDisplayId": "string",
725 "countryId": 0,
726 "countryDisplayId": "string",
727 "name": "string",
728 "postingPeriodVariantId": 0,
729 "fiscalVariantId": 0
730 },
731 "netAmount": 0,
732 "taxAmount": 0,
733 "totalAmount": 0,
734 "netAmountBalance": 0,
735 "taxAmountBalance": 0,
736 "paymentTerm": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string"
741 },
742 "paymentMethod": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "type": "string"
748 },
749 "paymentBlock": {
750 "id": 0,
751 "displayId": "string",
752 "status": "CREATED",
753 "name": "string"
754 },
755 "defaultCostCenter": {
756 "id": 0,
757 "displayId": "string",
758 "status": "CREATED",
759 "name": "string",
760 "erpSystemId": 0
761 },
762 "defaultProfitCenter": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "validTo": "2019-08-24",
768 "erpSystemId": 0,
769 "erpSystemDisplayId": "string"
770 },
771 "invoiceLineItems": [
772 {
773 "id": 0,
774 "displayId": "string",
775 "expenseCategory": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "expenseCategoryType": "PAYMENT"
781 },
782 "description": "string",
783 "unitOfMeasure": {
784 "id": 0,
785 "displayId": "string",
786 "status": "CREATED",
787 "name": "string",
788 "erpSystemId": 0
789 },
790 "quantity": 0,
791 "unitPrice": 0,
792 "taxJurisdiction": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0,
798 "schema": "string",
799 "countryDisplayId": "string"
800 },
801 "taxCode": {
802 "id": 0,
803 "displayId": "string",
804 "status": "CREATED",
805 "name": "string",
806 "erpSystemId": 0
807 },
808 "taxExpenseAccount": {
809 "id": 0,
810 "displayId": "string",
811 "generalLedgerAccountName": "string",
812 "generalLedgerAccountCode": "string",
813 "openItemManagement": true,
814 "accountCategory": "BALANCESHEET",
815 "shortName": "string",
816 "longName": "string"
817 },
818 "taxLineItems": [
819 {
820 "id": 0,
821 "taxRate": 0.1,
822 "taxAmount": 0,
823 "taxType": "string",
824 "invoiceLineItemId": 0
825 }
826 ],
827 "workBreakdownStructure": {
828 "id": 0,
829 "displayId": "string",
830 "status": "CREATED",
831 "name": "string",
832 "erpSystemId": 0
833 },
834 "costCenter": {
835 "id": 0,
836 "displayId": "string",
837 "status": "CREATED",
838 "name": "string",
839 "erpSystemId": 0
840 },
841 "profitCenter": {
842 "id": 0,
843 "displayId": "string",
844 "status": "CREATED",
845 "name": "string",
846 "validTo": "2019-08-24",
847 "erpSystemId": 0,
848 "erpSystemDisplayId": "string"
849 },
850 "functionalArea": {
851 "id": 0,
852 "displayId": "string",
853 "status": "CREATED",
854 "name": "string",
855 "erpSystemId": 0
856 },
857 "businessArea": {
858 "id": 0,
859 "displayId": "string",
860 "status": "CREATED",
861 "name": "string",
862 "erpSystemId": 0
863 },
864 "segment": {
865 "id": 0,
866 "displayId": "string",
867 "status": "CREATED",
868 "name": "string",
869 "erpSystemId": 0
870 },
871 "network": {
872 "id": 0,
873 "displayId": "string",
874 "status": "CREATED",
875 "name": "string",
876 "erpSystemId": 0
877 },
878 "internalOrderType": {
879 "id": 0,
880 "displayId": "string",
881 "status": "CREATED",
882 "name": "string",
883 "erpSystemId": 0
884 },
885 "internalOrder": {
886 "id": 0,
887 "displayId": "string",
888 "status": "CREATED",
889 "name": "string",
890 "erpSystemId": 0,
891 "internalOrderTypeId": 0
892 },
893 "additionalCurrencies": [
894 {
895 "id": 0,
896 "amount": 0,
897 "currency": {},
898 "conversionRate": 0,
899 "conversionDate": "2019-08-24",
900 "translationDateType": "DOCUMENT_DATE",
901 "amountType": "NET_AMOUNT",
902 "currencyDefinitionType": "CONTRACT_CURRENCY",
903 "invoiceEntryId": 0,
904 "invoiceEntryDisplayId": "string"
905 }
906 ],
907 "scheduledPaymentMatches": [
908 {
909 "id": 0,
910 "fromId": 0,
911 "toId": 0,
912 "amount": 0
913 }
914 ],
915 "goodsReceiptLineItemLinks": [
916 {
917 "id": 0,
918 "fromId": 0,
919 "toId": 0,
920 "linkedQuantity": 0
921 }
922 ],
923 "invoiceId": 0,
924 "invoiceDisplayId": "string",
925 "invoiceState": "INV_DRAFT",
926 "vendorPaymentId": 0,
927 "purchaseOrderLineItemId": 0,
928 "netAmount": 0,
929 "allowsSystemGenerateNewId": true,
930 "numberRangeIdentifierValue": "string",
931 "numberRangeIdentifierType": {
932 "name": "string"
933 },
934 "numberRangeType": {
935 "name": "string"
936 }
937 }
938 ],
939 "workspaceId": 0,
940 "workspaceDisplayId": "string",
941 "workspaceName": "string",
942 "workspaceState": "INV_DRAFT",
943 "remainingNetAmount": 0,
944 "remainingTaxAmount": 0,
945 "remainingTotalAmount": 0,
946 "pendingPaymentCount": 0,
947 "allPaymentsPosted": true,
948 "approvalInfo": {
949 "approverUsername": "string",
950 "approvedAt": "2019-08-24T14:15:22Z"
951 },
952 "rejectionReason": "string",
953 "allowsSystemGenerateNewId": true,
954 "numberRangeIdentifierValue": "string",
955 "numberRangeIdentifierType": {
956 "name": "string"
957 },
958 "numberRangeType": {
959 "name": "string"
960 }
961 }
962 ],
963 "rejectionReason": "string",
964 "allowsSystemGenerateNewId": true,
965 "numberRangeIdentifierValue": "string",
966 "numberRangeIdentifierType": {
967 "name": "string"
968 },
969 "numberRangeType": {
970 "name": "string"
971 }
972 }
973 ],
974 "approvalInfo": {
975 "approverUsername": "string",
976 "approvedAt": "2019-08-24T14:15:22Z"
977 },
978 "rejectionReason": "string",
979 "allowsSystemGenerateNewId": true,
980 "numberRangeIdentifierValue": "string",
981 "numberRangeIdentifierType": {
982 "name": "string"
983 },
984 "numberRangeType": {
985 "name": "string"
986 }
987 }
988}
Update A Resource¶
HTTP Request
PUT /api/v1/purchase-requisition/{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 requisition details, including item specifications, quantities, and approval status. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "shippingAddress": "string",
5 "state": "INV_DRAFT",
6 "notes": "string",
7 "currency": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string",
12 "decimalPoints": 0
13 },
14 "company": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "name": "string",
23 "postingPeriodVariantId": 0,
24 "fiscalVariantId": 0
25 },
26 "totalAmount": 0,
27 "purchaseRequisitionItems": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "quantity": 0,
32 "allocatedQuantity": 0,
33 "unitPrice": 0,
34 "description": "string",
35 "expenseCategory": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "expenseCategoryType": "PAYMENT"
41 },
42 "costCenter": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "profitCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "validTo": "2019-08-24",
55 "erpSystemId": 0,
56 "erpSystemDisplayId": "string"
57 },
58 "purchaseRequisitionId": 0,
59 "purchaseRequisitionDisplayId": "string",
60 "purchaseOrderLineItems": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "quantity": 0,
65 "allocatedQuantity": 0,
66 "receivedQuantity": 0,
67 "unitPrice": 0,
68 "description": "string",
69 "expenseCategory": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "expenseCategoryType": "PAYMENT"
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "taxJurisdiction": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0,
98 "schema": "string",
99 "countryDisplayId": "string"
100 },
101 "taxCode": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "purchaseOrderLineItemId": 0
115 }
116 ],
117 "purchaseOrderId": 0,
118 "purchaseOrderDisplayId": "string",
119 "purchaseOrderState": "INV_DRAFT",
120 "invoiceLineItems": [
121 {
122 "id": 0,
123 "displayId": "string",
124 "expenseCategory": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "expenseCategoryType": "PAYMENT"
130 },
131 "description": "string",
132 "unitOfMeasure": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0
138 },
139 "quantity": 0,
140 "unitPrice": 0,
141 "taxJurisdiction": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0,
147 "schema": "string",
148 "countryDisplayId": "string"
149 },
150 "taxCode": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "taxExpenseAccount": {
158 "id": 0,
159 "displayId": "string",
160 "generalLedgerAccountName": "string",
161 "generalLedgerAccountCode": "string",
162 "openItemManagement": true,
163 "accountCategory": "BALANCESHEET",
164 "shortName": "string",
165 "longName": "string"
166 },
167 "taxLineItems": [
168 {
169 "id": 0,
170 "taxRate": 0.1,
171 "taxAmount": 0,
172 "taxType": "string",
173 "invoiceLineItemId": 0
174 }
175 ],
176 "workBreakdownStructure": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 },
183 "costCenter": {
184 "id": 0,
185 "displayId": "string",
186 "status": "CREATED",
187 "name": "string",
188 "erpSystemId": 0
189 },
190 "profitCenter": {
191 "id": 0,
192 "displayId": "string",
193 "status": "CREATED",
194 "name": "string",
195 "validTo": "2019-08-24",
196 "erpSystemId": 0,
197 "erpSystemDisplayId": "string"
198 },
199 "functionalArea": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "businessArea": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "segment": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "network": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0
226 },
227 "internalOrderType": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "erpSystemId": 0
233 },
234 "internalOrder": {
235 "id": 0,
236 "displayId": "string",
237 "status": "CREATED",
238 "name": "string",
239 "erpSystemId": 0,
240 "internalOrderTypeId": 0
241 },
242 "additionalCurrencies": [
243 {
244 "id": 0,
245 "amount": 0,
246 "currency": {
247 "id": 0,
248 "displayId": "string",
249 "status": "CREATED",
250 "name": "string",
251 "decimalPoints": 0
252 },
253 "conversionRate": 0,
254 "conversionDate": "2019-08-24",
255 "translationDateType": "DOCUMENT_DATE",
256 "amountType": "NET_AMOUNT",
257 "currencyDefinitionType": "CONTRACT_CURRENCY",
258 "invoiceEntryId": 0,
259 "invoiceEntryDisplayId": "string"
260 }
261 ],
262 "scheduledPaymentMatches": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "amount": 0
268 }
269 ],
270 "goodsReceiptLineItemLinks": [
271 {
272 "id": 0,
273 "fromId": 0,
274 "toId": 0,
275 "linkedQuantity": 0
276 }
277 ],
278 "invoiceId": 0,
279 "invoiceDisplayId": "string",
280 "invoiceState": "INV_DRAFT",
281 "vendorPaymentId": 0,
282 "purchaseOrderLineItemId": 0,
283 "netAmount": 0,
284 "allowsSystemGenerateNewId": true,
285 "numberRangeIdentifierValue": "string",
286 "numberRangeIdentifierType": {
287 "name": "string"
288 },
289 "numberRangeType": {
290 "name": "string"
291 }
292 }
293 ],
294 "goodsReceiptLineItems": [
295 {
296 "id": 0,
297 "displayId": "string",
298 "quantity": 0,
299 "invoicedQuantity": 0,
300 "description": "string",
301 "expenseCategory": {
302 "id": 0,
303 "displayId": "string",
304 "status": "CREATED",
305 "name": "string",
306 "expenseCategoryType": "PAYMENT"
307 },
308 "goodsReceiptId": 0,
309 "goodsReceiptDisplayId": "string",
310 "goodsReceiptState": "INV_DRAFT",
311 "purchaseOrderLineItemId": 0,
312 "invoiceLineItemLinks": [
313 {
314 "id": 0,
315 "fromId": 0,
316 "toId": 0,
317 "linkedQuantity": 0
318 }
319 ],
320 "allowsSystemGenerateNewId": true,
321 "numberRangeIdentifierValue": "string",
322 "numberRangeIdentifierType": {
323 "name": "string"
324 },
325 "numberRangeType": {
326 "name": "string"
327 }
328 }
329 ],
330 "vendorPaymentId": 0,
331 "purchaseRequisitionLineItemId": 0,
332 "purchaseRequisitionDisplayId": "string",
333 "purchaseRequisitionLineItemAvailableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343 ],
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "purchaseOrders": [
355 {
356 "id": 0,
357 "displayId": "string",
358 "state": "INV_DRAFT",
359 "issueDate": "2019-08-24",
360 "expectedDeliveryDate": "2019-08-24",
361 "name": "string",
362 "shippingAddress": "string",
363 "notes": "string",
364 "netAmount": 0,
365 "taxAmount": 0,
366 "externalPurchaseOrderDisplayId": "string",
367 "vendor": {
368 "id": 0,
369 "displayId": "string",
370 "status": "CREATED",
371 "name": "string",
372 "erpSystemDisplayId": "string"
373 },
374 "currency": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "name": "string",
379 "decimalPoints": 0
380 },
381 "company": {
382 "id": 0,
383 "displayId": "string",
384 "status": "CREATED",
385 "erpSystemId": 0,
386 "erpSystemDisplayId": "string",
387 "countryId": 0,
388 "countryDisplayId": "string",
389 "name": "string",
390 "postingPeriodVariantId": 0,
391 "fiscalVariantId": 0
392 },
393 "purchaseOrderLineItems": [
394 {
395 "id": 0,
396 "displayId": "string",
397 "quantity": 0,
398 "allocatedQuantity": 0,
399 "receivedQuantity": 0,
400 "unitPrice": 0,
401 "description": "string",
402 "expenseCategory": {
403 "id": 0,
404 "displayId": "string",
405 "status": "CREATED",
406 "name": "string",
407 "expenseCategoryType": "PAYMENT"
408 },
409 "costCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "profitCenter": {
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 "taxJurisdiction": {
426 "id": 0,
427 "displayId": "string",
428 "status": "CREATED",
429 "name": "string",
430 "erpSystemId": 0,
431 "schema": "string",
432 "countryDisplayId": "string"
433 },
434 "taxCode": {
435 "id": 0,
436 "displayId": "string",
437 "status": "CREATED",
438 "name": "string",
439 "erpSystemId": 0
440 },
441 "taxLineItems": [
442 {
443 "id": 0,
444 "taxRate": 0.1,
445 "taxAmount": 0,
446 "taxType": "string",
447 "purchaseOrderLineItemId": 0
448 }
449 ],
450 "purchaseOrderId": 0,
451 "purchaseOrderDisplayId": "string",
452 "purchaseOrderState": "INV_DRAFT",
453 "invoiceLineItems": [
454 {
455 "id": 0,
456 "displayId": "string",
457 "expenseCategory": {
458 "id": 0,
459 "displayId": "string",
460 "status": "CREATED",
461 "name": "string",
462 "expenseCategoryType": "PAYMENT"
463 },
464 "description": "string",
465 "unitOfMeasure": {
466 "id": 0,
467 "displayId": "string",
468 "status": "CREATED",
469 "name": "string",
470 "erpSystemId": 0
471 },
472 "quantity": 0,
473 "unitPrice": 0,
474 "taxJurisdiction": {
475 "id": 0,
476 "displayId": "string",
477 "status": "CREATED",
478 "name": "string",
479 "erpSystemId": 0,
480 "schema": "string",
481 "countryDisplayId": "string"
482 },
483 "taxCode": {
484 "id": 0,
485 "displayId": "string",
486 "status": "CREATED",
487 "name": "string",
488 "erpSystemId": 0
489 },
490 "taxExpenseAccount": {
491 "id": 0,
492 "displayId": "string",
493 "generalLedgerAccountName": "string",
494 "generalLedgerAccountCode": "string",
495 "openItemManagement": true,
496 "accountCategory": "BALANCESHEET",
497 "shortName": "string",
498 "longName": "string"
499 },
500 "taxLineItems": [
501 {
502 "id": 0,
503 "taxRate": 0.1,
504 "taxAmount": 0,
505 "taxType": "string",
506 "invoiceLineItemId": 0
507 }
508 ],
509 "workBreakdownStructure": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "costCenter": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "profitCenter": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "validTo": "2019-08-24",
529 "erpSystemId": 0,
530 "erpSystemDisplayId": "string"
531 },
532 "functionalArea": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "businessArea": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0
545 },
546 "segment": {
547 "id": 0,
548 "displayId": "string",
549 "status": "CREATED",
550 "name": "string",
551 "erpSystemId": 0
552 },
553 "network": {
554 "id": 0,
555 "displayId": "string",
556 "status": "CREATED",
557 "name": "string",
558 "erpSystemId": 0
559 },
560 "internalOrderType": {
561 "id": 0,
562 "displayId": "string",
563 "status": "CREATED",
564 "name": "string",
565 "erpSystemId": 0
566 },
567 "internalOrder": {
568 "id": 0,
569 "displayId": "string",
570 "status": "CREATED",
571 "name": "string",
572 "erpSystemId": 0,
573 "internalOrderTypeId": 0
574 },
575 "additionalCurrencies": [
576 {
577 "id": 0,
578 "amount": 0,
579 "currency": {
580 "id": 0,
581 "displayId": "string",
582 "status": "CREATED",
583 "name": "string",
584 "decimalPoints": 0
585 },
586 "conversionRate": 0,
587 "conversionDate": "2019-08-24",
588 "translationDateType": "DOCUMENT_DATE",
589 "amountType": "NET_AMOUNT",
590 "currencyDefinitionType": "CONTRACT_CURRENCY",
591 "invoiceEntryId": 0,
592 "invoiceEntryDisplayId": "string"
593 }
594 ],
595 "scheduledPaymentMatches": [
596 {
597 "id": 0,
598 "fromId": 0,
599 "toId": 0,
600 "amount": 0
601 }
602 ],
603 "goodsReceiptLineItemLinks": [
604 {
605 "id": 0,
606 "fromId": 0,
607 "toId": 0,
608 "linkedQuantity": 0
609 }
610 ],
611 "invoiceId": 0,
612 "invoiceDisplayId": "string",
613 "invoiceState": "INV_DRAFT",
614 "vendorPaymentId": 0,
615 "purchaseOrderLineItemId": 0,
616 "netAmount": 0,
617 "allowsSystemGenerateNewId": true,
618 "numberRangeIdentifierValue": "string",
619 "numberRangeIdentifierType": {
620 "name": "string"
621 },
622 "numberRangeType": {
623 "name": "string"
624 }
625 }
626 ],
627 "goodsReceiptLineItems": [
628 {
629 "id": 0,
630 "displayId": "string",
631 "quantity": 0,
632 "invoicedQuantity": 0,
633 "description": "string",
634 "expenseCategory": {
635 "id": 0,
636 "displayId": "string",
637 "status": "CREATED",
638 "name": "string",
639 "expenseCategoryType": "PAYMENT"
640 },
641 "goodsReceiptId": 0,
642 "goodsReceiptDisplayId": "string",
643 "goodsReceiptState": "INV_DRAFT",
644 "purchaseOrderLineItemId": 0,
645 "invoiceLineItemLinks": [
646 {
647 "id": 0,
648 "fromId": 0,
649 "toId": 0,
650 "linkedQuantity": 0
651 }
652 ],
653 "allowsSystemGenerateNewId": true,
654 "numberRangeIdentifierValue": "string",
655 "numberRangeIdentifierType": {
656 "name": "string"
657 },
658 "numberRangeType": {
659 "name": "string"
660 }
661 }
662 ],
663 "vendorPaymentId": 0,
664 "purchaseRequisitionLineItemId": 0,
665 "purchaseRequisitionDisplayId": "string",
666 "purchaseRequisitionLineItemAvailableQuantity": 0,
667 "allowsSystemGenerateNewId": true,
668 "numberRangeIdentifierValue": "string",
669 "numberRangeIdentifierType": {
670 "name": "string"
671 },
672 "numberRangeType": {
673 "name": "string"
674 }
675 }
676 ],
677 "purchaseRequisitionIds": [
678 0
679 ],
680 "purchaseRequisitionDisplayIds": [
681 "string"
682 ],
683 "invoices": [
684 {
685 "id": 0,
686 "displayId": "string",
687 "name": "string",
688 "invoiceType": "VENDOR_INV",
689 "state": "INV_DRAFT",
690 "externalDocumentNumber": "string",
691 "purchaseOrderReference": "string",
692 "invoiceDate": "2019-08-24",
693 "dueDate": "2019-08-24",
694 "notes": "string",
695 "billingPeriodFromDate": "2019-08-24",
696 "billingPeriodToDate": "2019-08-24",
697 "currency": {
698 "id": 0,
699 "displayId": "string",
700 "status": "CREATED",
701 "name": "string",
702 "decimalPoints": 0
703 },
704 "vendor": {
705 "id": 0,
706 "displayId": "string",
707 "status": "CREATED",
708 "name": "string",
709 "erpSystemDisplayId": "string"
710 },
711 "company": {
712 "id": 0,
713 "displayId": "string",
714 "status": "CREATED",
715 "erpSystemId": 0,
716 "erpSystemDisplayId": "string",
717 "countryId": 0,
718 "countryDisplayId": "string",
719 "name": "string",
720 "postingPeriodVariantId": 0,
721 "fiscalVariantId": 0
722 },
723 "netAmount": 0,
724 "taxAmount": 0,
725 "totalAmount": 0,
726 "netAmountBalance": 0,
727 "taxAmountBalance": 0,
728 "paymentTerm": {
729 "id": 0,
730 "displayId": "string",
731 "status": "CREATED",
732 "name": "string"
733 },
734 "paymentMethod": {
735 "id": 0,
736 "displayId": "string",
737 "status": "CREATED",
738 "name": "string",
739 "type": "string"
740 },
741 "paymentBlock": {
742 "id": 0,
743 "displayId": "string",
744 "status": "CREATED",
745 "name": "string"
746 },
747 "defaultCostCenter": {
748 "id": 0,
749 "displayId": "string",
750 "status": "CREATED",
751 "name": "string",
752 "erpSystemId": 0
753 },
754 "defaultProfitCenter": {
755 "id": 0,
756 "displayId": "string",
757 "status": "CREATED",
758 "name": "string",
759 "validTo": "2019-08-24",
760 "erpSystemId": 0,
761 "erpSystemDisplayId": "string"
762 },
763 "invoiceLineItems": [
764 {
765 "id": 0,
766 "displayId": "string",
767 "expenseCategory": {
768 "id": 0,
769 "displayId": "string",
770 "status": "CREATED",
771 "name": "string",
772 "expenseCategoryType": "PAYMENT"
773 },
774 "description": "string",
775 "unitOfMeasure": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "erpSystemId": 0
781 },
782 "quantity": 0,
783 "unitPrice": 0,
784 "taxJurisdiction": {
785 "id": 0,
786 "displayId": "string",
787 "status": "CREATED",
788 "name": "string",
789 "erpSystemId": 0,
790 "schema": "string",
791 "countryDisplayId": "string"
792 },
793 "taxCode": {
794 "id": 0,
795 "displayId": "string",
796 "status": "CREATED",
797 "name": "string",
798 "erpSystemId": 0
799 },
800 "taxExpenseAccount": {
801 "id": 0,
802 "displayId": "string",
803 "generalLedgerAccountName": "string",
804 "generalLedgerAccountCode": "string",
805 "openItemManagement": true,
806 "accountCategory": "BALANCESHEET",
807 "shortName": "string",
808 "longName": "string"
809 },
810 "taxLineItems": [
811 {
812 "id": 0,
813 "taxRate": 0.1,
814 "taxAmount": 0,
815 "taxType": "string",
816 "invoiceLineItemId": 0
817 }
818 ],
819 "workBreakdownStructure": {
820 "id": 0,
821 "displayId": "string",
822 "status": "CREATED",
823 "name": "string",
824 "erpSystemId": 0
825 },
826 "costCenter": {
827 "id": 0,
828 "displayId": "string",
829 "status": "CREATED",
830 "name": "string",
831 "erpSystemId": 0
832 },
833 "profitCenter": {
834 "id": 0,
835 "displayId": "string",
836 "status": "CREATED",
837 "name": "string",
838 "validTo": "2019-08-24",
839 "erpSystemId": 0,
840 "erpSystemDisplayId": "string"
841 },
842 "functionalArea": {
843 "id": 0,
844 "displayId": "string",
845 "status": "CREATED",
846 "name": "string",
847 "erpSystemId": 0
848 },
849 "businessArea": {
850 "id": 0,
851 "displayId": "string",
852 "status": "CREATED",
853 "name": "string",
854 "erpSystemId": 0
855 },
856 "segment": {
857 "id": 0,
858 "displayId": "string",
859 "status": "CREATED",
860 "name": "string",
861 "erpSystemId": 0
862 },
863 "network": {
864 "id": 0,
865 "displayId": "string",
866 "status": "CREATED",
867 "name": "string",
868 "erpSystemId": 0
869 },
870 "internalOrderType": {
871 "id": 0,
872 "displayId": "string",
873 "status": "CREATED",
874 "name": "string",
875 "erpSystemId": 0
876 },
877 "internalOrder": {
878 "id": 0,
879 "displayId": "string",
880 "status": "CREATED",
881 "name": "string",
882 "erpSystemId": 0,
883 "internalOrderTypeId": 0
884 },
885 "additionalCurrencies": [
886 {
887 "id": 0,
888 "amount": 0,
889 "currency": {
890 "id": 0,
891 "displayId": "string",
892 "status": "CREATED",
893 "name": "string",
894 "decimalPoints": 0
895 },
896 "conversionRate": 0,
897 "conversionDate": "2019-08-24",
898 "translationDateType": "DOCUMENT_DATE",
899 "amountType": "NET_AMOUNT",
900 "currencyDefinitionType": "CONTRACT_CURRENCY",
901 "invoiceEntryId": 0,
902 "invoiceEntryDisplayId": "string"
903 }
904 ],
905 "scheduledPaymentMatches": [
906 {
907 "id": 0,
908 "fromId": 0,
909 "toId": 0,
910 "amount": 0
911 }
912 ],
913 "goodsReceiptLineItemLinks": [
914 {
915 "id": 0,
916 "fromId": 0,
917 "toId": 0,
918 "linkedQuantity": 0
919 }
920 ],
921 "invoiceId": 0,
922 "invoiceDisplayId": "string",
923 "invoiceState": "INV_DRAFT",
924 "vendorPaymentId": 0,
925 "purchaseOrderLineItemId": 0,
926 "netAmount": 0,
927 "allowsSystemGenerateNewId": true,
928 "numberRangeIdentifierValue": "string",
929 "numberRangeIdentifierType": {
930 "name": "string"
931 },
932 "numberRangeType": {
933 "name": "string"
934 }
935 }
936 ],
937 "workspaceId": 0,
938 "workspaceDisplayId": "string",
939 "workspaceName": "string",
940 "workspaceState": "INV_DRAFT",
941 "remainingNetAmount": 0,
942 "remainingTaxAmount": 0,
943 "remainingTotalAmount": 0,
944 "pendingPaymentCount": 0,
945 "allPaymentsPosted": true,
946 "approvalInfo": {
947 "approverUsername": "string",
948 "approvedAt": "2019-08-24T14:15:22Z"
949 },
950 "rejectionReason": "string",
951 "allowsSystemGenerateNewId": true,
952 "numberRangeIdentifierValue": "string",
953 "numberRangeIdentifierType": {
954 "name": "string"
955 },
956 "numberRangeType": {
957 "name": "string"
958 }
959 }
960 ],
961 "rejectionReason": "string",
962 "allowsSystemGenerateNewId": true,
963 "numberRangeIdentifierValue": "string",
964 "numberRangeIdentifierType": {
965 "name": "string"
966 },
967 "numberRangeType": {
968 "name": "string"
969 }
970 }
971 ],
972 "approvalInfo": {
973 "approverUsername": "string",
974 "approvedAt": "2019-08-24T14:15:22Z"
975 },
976 "rejectionReason": "string",
977 "allowsSystemGenerateNewId": true,
978 "numberRangeIdentifierValue": "string",
979 "numberRangeIdentifierType": {
980 "name": "string"
981 },
982 "numberRangeType": {
983 "name": "string"
984 }
985}
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 "shippingAddress": "string",
18 "state": "INV_DRAFT",
19 "notes": "string",
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 "totalAmount": 0,
40 "purchaseRequisitionItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
72 "purchaseRequisitionDisplayId": "string",
73 "purchaseOrderLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "quantity": 0,
78 "allocatedQuantity": 0,
79 "receivedQuantity": 0,
80 "unitPrice": 0,
81 "description": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "costCenter": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0
95 },
96 "profitCenter": {
97 "id": 0,
98 "displayId": "string",
99 "status": "CREATED",
100 "name": "string",
101 "validTo": "2019-08-24",
102 "erpSystemId": 0,
103 "erpSystemDisplayId": "string"
104 },
105 "taxJurisdiction": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0,
111 "schema": "string",
112 "countryDisplayId": "string"
113 },
114 "taxCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "purchaseOrderLineItemId": 0
128 }
129 ],
130 "purchaseOrderId": 0,
131 "purchaseOrderDisplayId": "string",
132 "purchaseOrderState": "INV_DRAFT",
133 "invoiceLineItems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "expenseCategory": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "expenseCategoryType": "PAYMENT"
143 },
144 "description": "string",
145 "unitOfMeasure": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string",
150 "erpSystemId": 0
151 },
152 "quantity": 0,
153 "unitPrice": 0,
154 "taxJurisdiction": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0,
160 "schema": "string",
161 "countryDisplayId": "string"
162 },
163 "taxCode": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "taxExpenseAccount": {
171 "id": 0,
172 "displayId": "string",
173 "generalLedgerAccountName": "string",
174 "generalLedgerAccountCode": "string",
175 "openItemManagement": true,
176 "accountCategory": "BALANCESHEET",
177 "shortName": "string",
178 "longName": "string"
179 },
180 "taxLineItems": [
181 {
182 "id": 0,
183 "taxRate": 0.1,
184 "taxAmount": 0,
185 "taxType": "string",
186 "invoiceLineItemId": 0
187 }
188 ],
189 "workBreakdownStructure": {
190 "id": 0,
191 "displayId": "string",
192 "status": "CREATED",
193 "name": "string",
194 "erpSystemId": 0
195 },
196 "costCenter": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "profitCenter": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "validTo": "2019-08-24",
209 "erpSystemId": 0,
210 "erpSystemDisplayId": "string"
211 },
212 "functionalArea": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "businessArea": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "segment": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0
232 },
233 "network": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "erpSystemId": 0
239 },
240 "internalOrderType": {
241 "id": 0,
242 "displayId": "string",
243 "status": "CREATED",
244 "name": "string",
245 "erpSystemId": 0
246 },
247 "internalOrder": {
248 "id": 0,
249 "displayId": "string",
250 "status": "CREATED",
251 "name": "string",
252 "erpSystemId": 0,
253 "internalOrderTypeId": 0
254 },
255 "additionalCurrencies": [
256 {
257 "id": 0,
258 "amount": 0,
259 "currency": {},
260 "conversionRate": 0,
261 "conversionDate": "2019-08-24",
262 "translationDateType": "DOCUMENT_DATE",
263 "amountType": "NET_AMOUNT",
264 "currencyDefinitionType": "CONTRACT_CURRENCY",
265 "invoiceEntryId": 0,
266 "invoiceEntryDisplayId": "string"
267 }
268 ],
269 "scheduledPaymentMatches": [
270 {
271 "id": 0,
272 "fromId": 0,
273 "toId": 0,
274 "amount": 0
275 }
276 ],
277 "goodsReceiptLineItemLinks": [
278 {
279 "id": 0,
280 "fromId": 0,
281 "toId": 0,
282 "linkedQuantity": 0
283 }
284 ],
285 "invoiceId": 0,
286 "invoiceDisplayId": "string",
287 "invoiceState": "INV_DRAFT",
288 "vendorPaymentId": 0,
289 "purchaseOrderLineItemId": 0,
290 "netAmount": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ],
301 "goodsReceiptLineItems": [
302 {
303 "id": 0,
304 "displayId": "string",
305 "quantity": 0,
306 "invoicedQuantity": 0,
307 "description": "string",
308 "expenseCategory": {
309 "id": 0,
310 "displayId": "string",
311 "status": "CREATED",
312 "name": "string",
313 "expenseCategoryType": "PAYMENT"
314 },
315 "goodsReceiptId": 0,
316 "goodsReceiptDisplayId": "string",
317 "goodsReceiptState": "INV_DRAFT",
318 "purchaseOrderLineItemId": 0,
319 "invoiceLineItemLinks": [
320 {
321 "id": 0,
322 "fromId": 0,
323 "toId": 0,
324 "linkedQuantity": 0
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "vendorPaymentId": 0,
339 "purchaseRequisitionLineItemId": 0,
340 "purchaseRequisitionDisplayId": "string",
341 "purchaseRequisitionLineItemAvailableQuantity": 0,
342 "remainingQuantity": 0,
343 "availableQuantity": 0,
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "availableQuantity": 0,
355 "allowsSystemGenerateNewId": true,
356 "numberRangeIdentifierValue": "string",
357 "numberRangeIdentifierType": {
358 "name": "string"
359 },
360 "numberRangeType": {
361 "name": "string"
362 }
363 }
364 ],
365 "purchaseOrders": [
366 {
367 "id": 0,
368 "displayId": "string",
369 "state": "INV_DRAFT",
370 "issueDate": "2019-08-24",
371 "expectedDeliveryDate": "2019-08-24",
372 "name": "string",
373 "shippingAddress": "string",
374 "notes": "string",
375 "netAmount": 0,
376 "taxAmount": 0,
377 "externalPurchaseOrderDisplayId": "string",
378 "vendor": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "name": "string",
383 "erpSystemDisplayId": "string"
384 },
385 "currency": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "decimalPoints": 0
391 },
392 "company": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "erpSystemId": 0,
397 "erpSystemDisplayId": "string",
398 "countryId": 0,
399 "countryDisplayId": "string",
400 "name": "string",
401 "postingPeriodVariantId": 0,
402 "fiscalVariantId": 0
403 },
404 "purchaseOrderLineItems": [
405 {
406 "id": 0,
407 "displayId": "string",
408 "quantity": 0,
409 "allocatedQuantity": 0,
410 "receivedQuantity": 0,
411 "unitPrice": 0,
412 "description": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "costCenter": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0
426 },
427 "profitCenter": {
428 "id": 0,
429 "displayId": "string",
430 "status": "CREATED",
431 "name": "string",
432 "validTo": "2019-08-24",
433 "erpSystemId": 0,
434 "erpSystemDisplayId": "string"
435 },
436 "taxJurisdiction": {
437 "id": 0,
438 "displayId": "string",
439 "status": "CREATED",
440 "name": "string",
441 "erpSystemId": 0,
442 "schema": "string",
443 "countryDisplayId": "string"
444 },
445 "taxCode": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "taxLineItems": [
453 {
454 "id": 0,
455 "taxRate": 0.1,
456 "taxAmount": 0,
457 "taxType": "string",
458 "purchaseOrderLineItemId": 0
459 }
460 ],
461 "purchaseOrderId": 0,
462 "purchaseOrderDisplayId": "string",
463 "purchaseOrderState": "INV_DRAFT",
464 "invoiceLineItems": [
465 {
466 "id": 0,
467 "displayId": "string",
468 "expenseCategory": {
469 "id": 0,
470 "displayId": "string",
471 "status": "CREATED",
472 "name": "string",
473 "expenseCategoryType": "PAYMENT"
474 },
475 "description": "string",
476 "unitOfMeasure": {
477 "id": 0,
478 "displayId": "string",
479 "status": "CREATED",
480 "name": "string",
481 "erpSystemId": 0
482 },
483 "quantity": 0,
484 "unitPrice": 0,
485 "taxJurisdiction": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "erpSystemId": 0,
491 "schema": "string",
492 "countryDisplayId": "string"
493 },
494 "taxCode": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "taxExpenseAccount": {
502 "id": 0,
503 "displayId": "string",
504 "generalLedgerAccountName": "string",
505 "generalLedgerAccountCode": "string",
506 "openItemManagement": true,
507 "accountCategory": "BALANCESHEET",
508 "shortName": "string",
509 "longName": "string"
510 },
511 "taxLineItems": [
512 {
513 "id": 0,
514 "taxRate": 0.1,
515 "taxAmount": 0,
516 "taxType": "string",
517 "invoiceLineItemId": 0
518 }
519 ],
520 "workBreakdownStructure": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "costCenter": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "profitCenter": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "validTo": "2019-08-24",
540 "erpSystemId": 0,
541 "erpSystemDisplayId": "string"
542 },
543 "functionalArea": {
544 "id": 0,
545 "displayId": "string",
546 "status": "CREATED",
547 "name": "string",
548 "erpSystemId": 0
549 },
550 "businessArea": {
551 "id": 0,
552 "displayId": "string",
553 "status": "CREATED",
554 "name": "string",
555 "erpSystemId": 0
556 },
557 "segment": {
558 "id": 0,
559 "displayId": "string",
560 "status": "CREATED",
561 "name": "string",
562 "erpSystemId": 0
563 },
564 "network": {
565 "id": 0,
566 "displayId": "string",
567 "status": "CREATED",
568 "name": "string",
569 "erpSystemId": 0
570 },
571 "internalOrderType": {
572 "id": 0,
573 "displayId": "string",
574 "status": "CREATED",
575 "name": "string",
576 "erpSystemId": 0
577 },
578 "internalOrder": {
579 "id": 0,
580 "displayId": "string",
581 "status": "CREATED",
582 "name": "string",
583 "erpSystemId": 0,
584 "internalOrderTypeId": 0
585 },
586 "additionalCurrencies": [
587 {
588 "id": 0,
589 "amount": 0,
590 "currency": {},
591 "conversionRate": 0,
592 "conversionDate": "2019-08-24",
593 "translationDateType": "DOCUMENT_DATE",
594 "amountType": "NET_AMOUNT",
595 "currencyDefinitionType": "CONTRACT_CURRENCY",
596 "invoiceEntryId": 0,
597 "invoiceEntryDisplayId": "string"
598 }
599 ],
600 "scheduledPaymentMatches": [
601 {
602 "id": 0,
603 "fromId": 0,
604 "toId": 0,
605 "amount": 0
606 }
607 ],
608 "goodsReceiptLineItemLinks": [
609 {
610 "id": 0,
611 "fromId": 0,
612 "toId": 0,
613 "linkedQuantity": 0
614 }
615 ],
616 "invoiceId": 0,
617 "invoiceDisplayId": "string",
618 "invoiceState": "INV_DRAFT",
619 "vendorPaymentId": 0,
620 "purchaseOrderLineItemId": 0,
621 "netAmount": 0,
622 "allowsSystemGenerateNewId": true,
623 "numberRangeIdentifierValue": "string",
624 "numberRangeIdentifierType": {
625 "name": "string"
626 },
627 "numberRangeType": {
628 "name": "string"
629 }
630 }
631 ],
632 "goodsReceiptLineItems": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "quantity": 0,
637 "invoicedQuantity": 0,
638 "description": "string",
639 "expenseCategory": {
640 "id": 0,
641 "displayId": "string",
642 "status": "CREATED",
643 "name": "string",
644 "expenseCategoryType": "PAYMENT"
645 },
646 "goodsReceiptId": 0,
647 "goodsReceiptDisplayId": "string",
648 "goodsReceiptState": "INV_DRAFT",
649 "purchaseOrderLineItemId": 0,
650 "invoiceLineItemLinks": [
651 {
652 "id": 0,
653 "fromId": 0,
654 "toId": 0,
655 "linkedQuantity": 0
656 }
657 ],
658 "availableQuantity": 0,
659 "allowsSystemGenerateNewId": true,
660 "numberRangeIdentifierValue": "string",
661 "numberRangeIdentifierType": {
662 "name": "string"
663 },
664 "numberRangeType": {
665 "name": "string"
666 }
667 }
668 ],
669 "vendorPaymentId": 0,
670 "purchaseRequisitionLineItemId": 0,
671 "purchaseRequisitionDisplayId": "string",
672 "purchaseRequisitionLineItemAvailableQuantity": 0,
673 "remainingQuantity": 0,
674 "availableQuantity": 0,
675 "allowsSystemGenerateNewId": true,
676 "numberRangeIdentifierValue": "string",
677 "numberRangeIdentifierType": {
678 "name": "string"
679 },
680 "numberRangeType": {
681 "name": "string"
682 }
683 }
684 ],
685 "purchaseRequisitionIds": [
686 0
687 ],
688 "purchaseRequisitionDisplayIds": [
689 "string"
690 ],
691 "invoices": [
692 {
693 "id": 0,
694 "displayId": "string",
695 "name": "string",
696 "invoiceType": "VENDOR_INV",
697 "state": "INV_DRAFT",
698 "externalDocumentNumber": "string",
699 "purchaseOrderReference": "string",
700 "invoiceDate": "2019-08-24",
701 "dueDate": "2019-08-24",
702 "notes": "string",
703 "billingPeriodFromDate": "2019-08-24",
704 "billingPeriodToDate": "2019-08-24",
705 "currency": {
706 "id": 0,
707 "displayId": "string",
708 "status": "CREATED",
709 "name": "string",
710 "decimalPoints": 0
711 },
712 "vendor": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "erpSystemDisplayId": "string"
718 },
719 "company": {
720 "id": 0,
721 "displayId": "string",
722 "status": "CREATED",
723 "erpSystemId": 0,
724 "erpSystemDisplayId": "string",
725 "countryId": 0,
726 "countryDisplayId": "string",
727 "name": "string",
728 "postingPeriodVariantId": 0,
729 "fiscalVariantId": 0
730 },
731 "netAmount": 0,
732 "taxAmount": 0,
733 "totalAmount": 0,
734 "netAmountBalance": 0,
735 "taxAmountBalance": 0,
736 "paymentTerm": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string"
741 },
742 "paymentMethod": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "type": "string"
748 },
749 "paymentBlock": {
750 "id": 0,
751 "displayId": "string",
752 "status": "CREATED",
753 "name": "string"
754 },
755 "defaultCostCenter": {
756 "id": 0,
757 "displayId": "string",
758 "status": "CREATED",
759 "name": "string",
760 "erpSystemId": 0
761 },
762 "defaultProfitCenter": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "validTo": "2019-08-24",
768 "erpSystemId": 0,
769 "erpSystemDisplayId": "string"
770 },
771 "invoiceLineItems": [
772 {
773 "id": 0,
774 "displayId": "string",
775 "expenseCategory": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "expenseCategoryType": "PAYMENT"
781 },
782 "description": "string",
783 "unitOfMeasure": {
784 "id": 0,
785 "displayId": "string",
786 "status": "CREATED",
787 "name": "string",
788 "erpSystemId": 0
789 },
790 "quantity": 0,
791 "unitPrice": 0,
792 "taxJurisdiction": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0,
798 "schema": "string",
799 "countryDisplayId": "string"
800 },
801 "taxCode": {
802 "id": 0,
803 "displayId": "string",
804 "status": "CREATED",
805 "name": "string",
806 "erpSystemId": 0
807 },
808 "taxExpenseAccount": {
809 "id": 0,
810 "displayId": "string",
811 "generalLedgerAccountName": "string",
812 "generalLedgerAccountCode": "string",
813 "openItemManagement": true,
814 "accountCategory": "BALANCESHEET",
815 "shortName": "string",
816 "longName": "string"
817 },
818 "taxLineItems": [
819 {
820 "id": 0,
821 "taxRate": 0.1,
822 "taxAmount": 0,
823 "taxType": "string",
824 "invoiceLineItemId": 0
825 }
826 ],
827 "workBreakdownStructure": {
828 "id": 0,
829 "displayId": "string",
830 "status": "CREATED",
831 "name": "string",
832 "erpSystemId": 0
833 },
834 "costCenter": {
835 "id": 0,
836 "displayId": "string",
837 "status": "CREATED",
838 "name": "string",
839 "erpSystemId": 0
840 },
841 "profitCenter": {
842 "id": 0,
843 "displayId": "string",
844 "status": "CREATED",
845 "name": "string",
846 "validTo": "2019-08-24",
847 "erpSystemId": 0,
848 "erpSystemDisplayId": "string"
849 },
850 "functionalArea": {
851 "id": 0,
852 "displayId": "string",
853 "status": "CREATED",
854 "name": "string",
855 "erpSystemId": 0
856 },
857 "businessArea": {
858 "id": 0,
859 "displayId": "string",
860 "status": "CREATED",
861 "name": "string",
862 "erpSystemId": 0
863 },
864 "segment": {
865 "id": 0,
866 "displayId": "string",
867 "status": "CREATED",
868 "name": "string",
869 "erpSystemId": 0
870 },
871 "network": {
872 "id": 0,
873 "displayId": "string",
874 "status": "CREATED",
875 "name": "string",
876 "erpSystemId": 0
877 },
878 "internalOrderType": {
879 "id": 0,
880 "displayId": "string",
881 "status": "CREATED",
882 "name": "string",
883 "erpSystemId": 0
884 },
885 "internalOrder": {
886 "id": 0,
887 "displayId": "string",
888 "status": "CREATED",
889 "name": "string",
890 "erpSystemId": 0,
891 "internalOrderTypeId": 0
892 },
893 "additionalCurrencies": [
894 {
895 "id": 0,
896 "amount": 0,
897 "currency": {},
898 "conversionRate": 0,
899 "conversionDate": "2019-08-24",
900 "translationDateType": "DOCUMENT_DATE",
901 "amountType": "NET_AMOUNT",
902 "currencyDefinitionType": "CONTRACT_CURRENCY",
903 "invoiceEntryId": 0,
904 "invoiceEntryDisplayId": "string"
905 }
906 ],
907 "scheduledPaymentMatches": [
908 {
909 "id": 0,
910 "fromId": 0,
911 "toId": 0,
912 "amount": 0
913 }
914 ],
915 "goodsReceiptLineItemLinks": [
916 {
917 "id": 0,
918 "fromId": 0,
919 "toId": 0,
920 "linkedQuantity": 0
921 }
922 ],
923 "invoiceId": 0,
924 "invoiceDisplayId": "string",
925 "invoiceState": "INV_DRAFT",
926 "vendorPaymentId": 0,
927 "purchaseOrderLineItemId": 0,
928 "netAmount": 0,
929 "allowsSystemGenerateNewId": true,
930 "numberRangeIdentifierValue": "string",
931 "numberRangeIdentifierType": {
932 "name": "string"
933 },
934 "numberRangeType": {
935 "name": "string"
936 }
937 }
938 ],
939 "workspaceId": 0,
940 "workspaceDisplayId": "string",
941 "workspaceName": "string",
942 "workspaceState": "INV_DRAFT",
943 "remainingNetAmount": 0,
944 "remainingTaxAmount": 0,
945 "remainingTotalAmount": 0,
946 "pendingPaymentCount": 0,
947 "allPaymentsPosted": true,
948 "approvalInfo": {
949 "approverUsername": "string",
950 "approvedAt": "2019-08-24T14:15:22Z"
951 },
952 "rejectionReason": "string",
953 "allowsSystemGenerateNewId": true,
954 "numberRangeIdentifierValue": "string",
955 "numberRangeIdentifierType": {
956 "name": "string"
957 },
958 "numberRangeType": {
959 "name": "string"
960 }
961 }
962 ],
963 "rejectionReason": "string",
964 "allowsSystemGenerateNewId": true,
965 "numberRangeIdentifierValue": "string",
966 "numberRangeIdentifierType": {
967 "name": "string"
968 },
969 "numberRangeType": {
970 "name": "string"
971 }
972 }
973 ],
974 "approvalInfo": {
975 "approverUsername": "string",
976 "approvedAt": "2019-08-24T14:15:22Z"
977 },
978 "rejectionReason": "string",
979 "allowsSystemGenerateNewId": true,
980 "numberRangeIdentifierValue": "string",
981 "numberRangeIdentifierType": {
982 "name": "string"
983 },
984 "numberRangeType": {
985 "name": "string"
986 }
987 }
988}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/purchase-requisition/{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-requisition/{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 requisition details, including item specifications, quantities, and approval status. |
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 "shippingAddress": "string",
18 "state": "INV_DRAFT",
19 "notes": "string",
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 "totalAmount": 0,
40 "purchaseRequisitionItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
72 "purchaseRequisitionDisplayId": "string",
73 "purchaseOrderLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "quantity": 0,
78 "allocatedQuantity": 0,
79 "receivedQuantity": 0,
80 "unitPrice": 0,
81 "description": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "costCenter": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0
95 },
96 "profitCenter": {
97 "id": 0,
98 "displayId": "string",
99 "status": "CREATED",
100 "name": "string",
101 "validTo": "2019-08-24",
102 "erpSystemId": 0,
103 "erpSystemDisplayId": "string"
104 },
105 "taxJurisdiction": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0,
111 "schema": "string",
112 "countryDisplayId": "string"
113 },
114 "taxCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "purchaseOrderLineItemId": 0
128 }
129 ],
130 "purchaseOrderId": 0,
131 "purchaseOrderDisplayId": "string",
132 "purchaseOrderState": "INV_DRAFT",
133 "invoiceLineItems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "expenseCategory": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "expenseCategoryType": "PAYMENT"
143 },
144 "description": "string",
145 "unitOfMeasure": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string",
150 "erpSystemId": 0
151 },
152 "quantity": 0,
153 "unitPrice": 0,
154 "taxJurisdiction": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0,
160 "schema": "string",
161 "countryDisplayId": "string"
162 },
163 "taxCode": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "taxExpenseAccount": {
171 "id": 0,
172 "displayId": "string",
173 "generalLedgerAccountName": "string",
174 "generalLedgerAccountCode": "string",
175 "openItemManagement": true,
176 "accountCategory": "BALANCESHEET",
177 "shortName": "string",
178 "longName": "string"
179 },
180 "taxLineItems": [
181 {
182 "id": 0,
183 "taxRate": 0.1,
184 "taxAmount": 0,
185 "taxType": "string",
186 "invoiceLineItemId": 0
187 }
188 ],
189 "workBreakdownStructure": {
190 "id": 0,
191 "displayId": "string",
192 "status": "CREATED",
193 "name": "string",
194 "erpSystemId": 0
195 },
196 "costCenter": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "profitCenter": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "validTo": "2019-08-24",
209 "erpSystemId": 0,
210 "erpSystemDisplayId": "string"
211 },
212 "functionalArea": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "businessArea": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "segment": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0
232 },
233 "network": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "erpSystemId": 0
239 },
240 "internalOrderType": {
241 "id": 0,
242 "displayId": "string",
243 "status": "CREATED",
244 "name": "string",
245 "erpSystemId": 0
246 },
247 "internalOrder": {
248 "id": 0,
249 "displayId": "string",
250 "status": "CREATED",
251 "name": "string",
252 "erpSystemId": 0,
253 "internalOrderTypeId": 0
254 },
255 "additionalCurrencies": [
256 {
257 "id": 0,
258 "amount": 0,
259 "currency": {},
260 "conversionRate": 0,
261 "conversionDate": "2019-08-24",
262 "translationDateType": "DOCUMENT_DATE",
263 "amountType": "NET_AMOUNT",
264 "currencyDefinitionType": "CONTRACT_CURRENCY",
265 "invoiceEntryId": 0,
266 "invoiceEntryDisplayId": "string"
267 }
268 ],
269 "scheduledPaymentMatches": [
270 {
271 "id": 0,
272 "fromId": 0,
273 "toId": 0,
274 "amount": 0
275 }
276 ],
277 "goodsReceiptLineItemLinks": [
278 {
279 "id": 0,
280 "fromId": 0,
281 "toId": 0,
282 "linkedQuantity": 0
283 }
284 ],
285 "invoiceId": 0,
286 "invoiceDisplayId": "string",
287 "invoiceState": "INV_DRAFT",
288 "vendorPaymentId": 0,
289 "purchaseOrderLineItemId": 0,
290 "netAmount": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ],
301 "goodsReceiptLineItems": [
302 {
303 "id": 0,
304 "displayId": "string",
305 "quantity": 0,
306 "invoicedQuantity": 0,
307 "description": "string",
308 "expenseCategory": {
309 "id": 0,
310 "displayId": "string",
311 "status": "CREATED",
312 "name": "string",
313 "expenseCategoryType": "PAYMENT"
314 },
315 "goodsReceiptId": 0,
316 "goodsReceiptDisplayId": "string",
317 "goodsReceiptState": "INV_DRAFT",
318 "purchaseOrderLineItemId": 0,
319 "invoiceLineItemLinks": [
320 {
321 "id": 0,
322 "fromId": 0,
323 "toId": 0,
324 "linkedQuantity": 0
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "vendorPaymentId": 0,
339 "purchaseRequisitionLineItemId": 0,
340 "purchaseRequisitionDisplayId": "string",
341 "purchaseRequisitionLineItemAvailableQuantity": 0,
342 "remainingQuantity": 0,
343 "availableQuantity": 0,
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "availableQuantity": 0,
355 "allowsSystemGenerateNewId": true,
356 "numberRangeIdentifierValue": "string",
357 "numberRangeIdentifierType": {
358 "name": "string"
359 },
360 "numberRangeType": {
361 "name": "string"
362 }
363 }
364 ],
365 "purchaseOrders": [
366 {
367 "id": 0,
368 "displayId": "string",
369 "state": "INV_DRAFT",
370 "issueDate": "2019-08-24",
371 "expectedDeliveryDate": "2019-08-24",
372 "name": "string",
373 "shippingAddress": "string",
374 "notes": "string",
375 "netAmount": 0,
376 "taxAmount": 0,
377 "externalPurchaseOrderDisplayId": "string",
378 "vendor": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "name": "string",
383 "erpSystemDisplayId": "string"
384 },
385 "currency": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "decimalPoints": 0
391 },
392 "company": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "erpSystemId": 0,
397 "erpSystemDisplayId": "string",
398 "countryId": 0,
399 "countryDisplayId": "string",
400 "name": "string",
401 "postingPeriodVariantId": 0,
402 "fiscalVariantId": 0
403 },
404 "purchaseOrderLineItems": [
405 {
406 "id": 0,
407 "displayId": "string",
408 "quantity": 0,
409 "allocatedQuantity": 0,
410 "receivedQuantity": 0,
411 "unitPrice": 0,
412 "description": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "costCenter": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0
426 },
427 "profitCenter": {
428 "id": 0,
429 "displayId": "string",
430 "status": "CREATED",
431 "name": "string",
432 "validTo": "2019-08-24",
433 "erpSystemId": 0,
434 "erpSystemDisplayId": "string"
435 },
436 "taxJurisdiction": {
437 "id": 0,
438 "displayId": "string",
439 "status": "CREATED",
440 "name": "string",
441 "erpSystemId": 0,
442 "schema": "string",
443 "countryDisplayId": "string"
444 },
445 "taxCode": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "taxLineItems": [
453 {
454 "id": 0,
455 "taxRate": 0.1,
456 "taxAmount": 0,
457 "taxType": "string",
458 "purchaseOrderLineItemId": 0
459 }
460 ],
461 "purchaseOrderId": 0,
462 "purchaseOrderDisplayId": "string",
463 "purchaseOrderState": "INV_DRAFT",
464 "invoiceLineItems": [
465 {
466 "id": 0,
467 "displayId": "string",
468 "expenseCategory": {
469 "id": 0,
470 "displayId": "string",
471 "status": "CREATED",
472 "name": "string",
473 "expenseCategoryType": "PAYMENT"
474 },
475 "description": "string",
476 "unitOfMeasure": {
477 "id": 0,
478 "displayId": "string",
479 "status": "CREATED",
480 "name": "string",
481 "erpSystemId": 0
482 },
483 "quantity": 0,
484 "unitPrice": 0,
485 "taxJurisdiction": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "erpSystemId": 0,
491 "schema": "string",
492 "countryDisplayId": "string"
493 },
494 "taxCode": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "taxExpenseAccount": {
502 "id": 0,
503 "displayId": "string",
504 "generalLedgerAccountName": "string",
505 "generalLedgerAccountCode": "string",
506 "openItemManagement": true,
507 "accountCategory": "BALANCESHEET",
508 "shortName": "string",
509 "longName": "string"
510 },
511 "taxLineItems": [
512 {
513 "id": 0,
514 "taxRate": 0.1,
515 "taxAmount": 0,
516 "taxType": "string",
517 "invoiceLineItemId": 0
518 }
519 ],
520 "workBreakdownStructure": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "costCenter": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "profitCenter": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "validTo": "2019-08-24",
540 "erpSystemId": 0,
541 "erpSystemDisplayId": "string"
542 },
543 "functionalArea": {
544 "id": 0,
545 "displayId": "string",
546 "status": "CREATED",
547 "name": "string",
548 "erpSystemId": 0
549 },
550 "businessArea": {
551 "id": 0,
552 "displayId": "string",
553 "status": "CREATED",
554 "name": "string",
555 "erpSystemId": 0
556 },
557 "segment": {
558 "id": 0,
559 "displayId": "string",
560 "status": "CREATED",
561 "name": "string",
562 "erpSystemId": 0
563 },
564 "network": {
565 "id": 0,
566 "displayId": "string",
567 "status": "CREATED",
568 "name": "string",
569 "erpSystemId": 0
570 },
571 "internalOrderType": {
572 "id": 0,
573 "displayId": "string",
574 "status": "CREATED",
575 "name": "string",
576 "erpSystemId": 0
577 },
578 "internalOrder": {
579 "id": 0,
580 "displayId": "string",
581 "status": "CREATED",
582 "name": "string",
583 "erpSystemId": 0,
584 "internalOrderTypeId": 0
585 },
586 "additionalCurrencies": [
587 {
588 "id": 0,
589 "amount": 0,
590 "currency": {},
591 "conversionRate": 0,
592 "conversionDate": "2019-08-24",
593 "translationDateType": "DOCUMENT_DATE",
594 "amountType": "NET_AMOUNT",
595 "currencyDefinitionType": "CONTRACT_CURRENCY",
596 "invoiceEntryId": 0,
597 "invoiceEntryDisplayId": "string"
598 }
599 ],
600 "scheduledPaymentMatches": [
601 {
602 "id": 0,
603 "fromId": 0,
604 "toId": 0,
605 "amount": 0
606 }
607 ],
608 "goodsReceiptLineItemLinks": [
609 {
610 "id": 0,
611 "fromId": 0,
612 "toId": 0,
613 "linkedQuantity": 0
614 }
615 ],
616 "invoiceId": 0,
617 "invoiceDisplayId": "string",
618 "invoiceState": "INV_DRAFT",
619 "vendorPaymentId": 0,
620 "purchaseOrderLineItemId": 0,
621 "netAmount": 0,
622 "allowsSystemGenerateNewId": true,
623 "numberRangeIdentifierValue": "string",
624 "numberRangeIdentifierType": {
625 "name": "string"
626 },
627 "numberRangeType": {
628 "name": "string"
629 }
630 }
631 ],
632 "goodsReceiptLineItems": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "quantity": 0,
637 "invoicedQuantity": 0,
638 "description": "string",
639 "expenseCategory": {
640 "id": 0,
641 "displayId": "string",
642 "status": "CREATED",
643 "name": "string",
644 "expenseCategoryType": "PAYMENT"
645 },
646 "goodsReceiptId": 0,
647 "goodsReceiptDisplayId": "string",
648 "goodsReceiptState": "INV_DRAFT",
649 "purchaseOrderLineItemId": 0,
650 "invoiceLineItemLinks": [
651 {
652 "id": 0,
653 "fromId": 0,
654 "toId": 0,
655 "linkedQuantity": 0
656 }
657 ],
658 "availableQuantity": 0,
659 "allowsSystemGenerateNewId": true,
660 "numberRangeIdentifierValue": "string",
661 "numberRangeIdentifierType": {
662 "name": "string"
663 },
664 "numberRangeType": {
665 "name": "string"
666 }
667 }
668 ],
669 "vendorPaymentId": 0,
670 "purchaseRequisitionLineItemId": 0,
671 "purchaseRequisitionDisplayId": "string",
672 "purchaseRequisitionLineItemAvailableQuantity": 0,
673 "remainingQuantity": 0,
674 "availableQuantity": 0,
675 "allowsSystemGenerateNewId": true,
676 "numberRangeIdentifierValue": "string",
677 "numberRangeIdentifierType": {
678 "name": "string"
679 },
680 "numberRangeType": {
681 "name": "string"
682 }
683 }
684 ],
685 "purchaseRequisitionIds": [
686 0
687 ],
688 "purchaseRequisitionDisplayIds": [
689 "string"
690 ],
691 "invoices": [
692 {
693 "id": 0,
694 "displayId": "string",
695 "name": "string",
696 "invoiceType": "VENDOR_INV",
697 "state": "INV_DRAFT",
698 "externalDocumentNumber": "string",
699 "purchaseOrderReference": "string",
700 "invoiceDate": "2019-08-24",
701 "dueDate": "2019-08-24",
702 "notes": "string",
703 "billingPeriodFromDate": "2019-08-24",
704 "billingPeriodToDate": "2019-08-24",
705 "currency": {
706 "id": 0,
707 "displayId": "string",
708 "status": "CREATED",
709 "name": "string",
710 "decimalPoints": 0
711 },
712 "vendor": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "erpSystemDisplayId": "string"
718 },
719 "company": {
720 "id": 0,
721 "displayId": "string",
722 "status": "CREATED",
723 "erpSystemId": 0,
724 "erpSystemDisplayId": "string",
725 "countryId": 0,
726 "countryDisplayId": "string",
727 "name": "string",
728 "postingPeriodVariantId": 0,
729 "fiscalVariantId": 0
730 },
731 "netAmount": 0,
732 "taxAmount": 0,
733 "totalAmount": 0,
734 "netAmountBalance": 0,
735 "taxAmountBalance": 0,
736 "paymentTerm": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string"
741 },
742 "paymentMethod": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "type": "string"
748 },
749 "paymentBlock": {
750 "id": 0,
751 "displayId": "string",
752 "status": "CREATED",
753 "name": "string"
754 },
755 "defaultCostCenter": {
756 "id": 0,
757 "displayId": "string",
758 "status": "CREATED",
759 "name": "string",
760 "erpSystemId": 0
761 },
762 "defaultProfitCenter": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "validTo": "2019-08-24",
768 "erpSystemId": 0,
769 "erpSystemDisplayId": "string"
770 },
771 "invoiceLineItems": [
772 {
773 "id": 0,
774 "displayId": "string",
775 "expenseCategory": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "expenseCategoryType": "PAYMENT"
781 },
782 "description": "string",
783 "unitOfMeasure": {
784 "id": 0,
785 "displayId": "string",
786 "status": "CREATED",
787 "name": "string",
788 "erpSystemId": 0
789 },
790 "quantity": 0,
791 "unitPrice": 0,
792 "taxJurisdiction": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0,
798 "schema": "string",
799 "countryDisplayId": "string"
800 },
801 "taxCode": {
802 "id": 0,
803 "displayId": "string",
804 "status": "CREATED",
805 "name": "string",
806 "erpSystemId": 0
807 },
808 "taxExpenseAccount": {
809 "id": 0,
810 "displayId": "string",
811 "generalLedgerAccountName": "string",
812 "generalLedgerAccountCode": "string",
813 "openItemManagement": true,
814 "accountCategory": "BALANCESHEET",
815 "shortName": "string",
816 "longName": "string"
817 },
818 "taxLineItems": [
819 {
820 "id": 0,
821 "taxRate": 0.1,
822 "taxAmount": 0,
823 "taxType": "string",
824 "invoiceLineItemId": 0
825 }
826 ],
827 "workBreakdownStructure": {
828 "id": 0,
829 "displayId": "string",
830 "status": "CREATED",
831 "name": "string",
832 "erpSystemId": 0
833 },
834 "costCenter": {
835 "id": 0,
836 "displayId": "string",
837 "status": "CREATED",
838 "name": "string",
839 "erpSystemId": 0
840 },
841 "profitCenter": {
842 "id": 0,
843 "displayId": "string",
844 "status": "CREATED",
845 "name": "string",
846 "validTo": "2019-08-24",
847 "erpSystemId": 0,
848 "erpSystemDisplayId": "string"
849 },
850 "functionalArea": {
851 "id": 0,
852 "displayId": "string",
853 "status": "CREATED",
854 "name": "string",
855 "erpSystemId": 0
856 },
857 "businessArea": {
858 "id": 0,
859 "displayId": "string",
860 "status": "CREATED",
861 "name": "string",
862 "erpSystemId": 0
863 },
864 "segment": {
865 "id": 0,
866 "displayId": "string",
867 "status": "CREATED",
868 "name": "string",
869 "erpSystemId": 0
870 },
871 "network": {
872 "id": 0,
873 "displayId": "string",
874 "status": "CREATED",
875 "name": "string",
876 "erpSystemId": 0
877 },
878 "internalOrderType": {
879 "id": 0,
880 "displayId": "string",
881 "status": "CREATED",
882 "name": "string",
883 "erpSystemId": 0
884 },
885 "internalOrder": {
886 "id": 0,
887 "displayId": "string",
888 "status": "CREATED",
889 "name": "string",
890 "erpSystemId": 0,
891 "internalOrderTypeId": 0
892 },
893 "additionalCurrencies": [
894 {
895 "id": 0,
896 "amount": 0,
897 "currency": {},
898 "conversionRate": 0,
899 "conversionDate": "2019-08-24",
900 "translationDateType": "DOCUMENT_DATE",
901 "amountType": "NET_AMOUNT",
902 "currencyDefinitionType": "CONTRACT_CURRENCY",
903 "invoiceEntryId": 0,
904 "invoiceEntryDisplayId": "string"
905 }
906 ],
907 "scheduledPaymentMatches": [
908 {
909 "id": 0,
910 "fromId": 0,
911 "toId": 0,
912 "amount": 0
913 }
914 ],
915 "goodsReceiptLineItemLinks": [
916 {
917 "id": 0,
918 "fromId": 0,
919 "toId": 0,
920 "linkedQuantity": 0
921 }
922 ],
923 "invoiceId": 0,
924 "invoiceDisplayId": "string",
925 "invoiceState": "INV_DRAFT",
926 "vendorPaymentId": 0,
927 "purchaseOrderLineItemId": 0,
928 "netAmount": 0,
929 "allowsSystemGenerateNewId": true,
930 "numberRangeIdentifierValue": "string",
931 "numberRangeIdentifierType": {
932 "name": "string"
933 },
934 "numberRangeType": {
935 "name": "string"
936 }
937 }
938 ],
939 "workspaceId": 0,
940 "workspaceDisplayId": "string",
941 "workspaceName": "string",
942 "workspaceState": "INV_DRAFT",
943 "remainingNetAmount": 0,
944 "remainingTaxAmount": 0,
945 "remainingTotalAmount": 0,
946 "pendingPaymentCount": 0,
947 "allPaymentsPosted": true,
948 "approvalInfo": {
949 "approverUsername": "string",
950 "approvedAt": "2019-08-24T14:15:22Z"
951 },
952 "rejectionReason": "string",
953 "allowsSystemGenerateNewId": true,
954 "numberRangeIdentifierValue": "string",
955 "numberRangeIdentifierType": {
956 "name": "string"
957 },
958 "numberRangeType": {
959 "name": "string"
960 }
961 }
962 ],
963 "rejectionReason": "string",
964 "allowsSystemGenerateNewId": true,
965 "numberRangeIdentifierValue": "string",
966 "numberRangeIdentifierType": {
967 "name": "string"
968 },
969 "numberRangeType": {
970 "name": "string"
971 }
972 }
973 ],
974 "approvalInfo": {
975 "approverUsername": "string",
976 "approvedAt": "2019-08-24T14:15:22Z"
977 },
978 "rejectionReason": "string",
979 "allowsSystemGenerateNewId": true,
980 "numberRangeIdentifierValue": "string",
981 "numberRangeIdentifierType": {
982 "name": "string"
983 },
984 "numberRangeType": {
985 "name": "string"
986 }
987 }
988}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/purchase-requisition/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 requisition objects for bulk creation or updates, including relevant details such as item specifications, quantities, and associated metadata. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "shippingAddress": "string",
6 "state": "INV_DRAFT",
7 "notes": "string",
8 "currency": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string",
13 "decimalPoints": 0
14 },
15 "company": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "name": "string",
24 "postingPeriodVariantId": 0,
25 "fiscalVariantId": 0
26 },
27 "totalAmount": 0,
28 "purchaseRequisitionItems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "quantity": 0,
33 "allocatedQuantity": 0,
34 "unitPrice": 0,
35 "description": "string",
36 "expenseCategory": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "expenseCategoryType": "PAYMENT"
42 },
43 "costCenter": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "profitCenter": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "validTo": "2019-08-24",
56 "erpSystemId": 0,
57 "erpSystemDisplayId": "string"
58 },
59 "purchaseRequisitionId": 0,
60 "purchaseRequisitionDisplayId": "string",
61 "purchaseOrderLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "quantity": 0,
66 "allocatedQuantity": 0,
67 "receivedQuantity": 0,
68 "unitPrice": 0,
69 "description": "string",
70 "expenseCategory": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "expenseCategoryType": "PAYMENT"
76 },
77 "costCenter": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "erpSystemId": 0
83 },
84 "profitCenter": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "validTo": "2019-08-24",
90 "erpSystemId": 0,
91 "erpSystemDisplayId": "string"
92 },
93 "taxJurisdiction": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0,
99 "schema": "string",
100 "countryDisplayId": "string"
101 },
102 "taxCode": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "erpSystemId": 0
108 },
109 "taxLineItems": [
110 {
111 "id": 0,
112 "taxRate": 0.1,
113 "taxAmount": 0,
114 "taxType": "string",
115 "purchaseOrderLineItemId": 0
116 }
117 ],
118 "purchaseOrderId": 0,
119 "purchaseOrderDisplayId": "string",
120 "purchaseOrderState": "INV_DRAFT",
121 "invoiceLineItems": [
122 {
123 "id": 0,
124 "displayId": "string",
125 "expenseCategory": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "expenseCategoryType": "PAYMENT"
131 },
132 "description": "string",
133 "unitOfMeasure": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0
139 },
140 "quantity": 0,
141 "unitPrice": 0,
142 "taxJurisdiction": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0,
148 "schema": "string",
149 "countryDisplayId": "string"
150 },
151 "taxCode": {
152 "id": 0,
153 "displayId": "string",
154 "status": "CREATED",
155 "name": "string",
156 "erpSystemId": 0
157 },
158 "taxExpenseAccount": {
159 "id": 0,
160 "displayId": "string",
161 "generalLedgerAccountName": "string",
162 "generalLedgerAccountCode": "string",
163 "openItemManagement": true,
164 "accountCategory": "BALANCESHEET",
165 "shortName": "string",
166 "longName": "string"
167 },
168 "taxLineItems": [
169 {
170 "id": 0,
171 "taxRate": 0.1,
172 "taxAmount": 0,
173 "taxType": "string",
174 "invoiceLineItemId": 0
175 }
176 ],
177 "workBreakdownStructure": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "erpSystemId": 0
183 },
184 "costCenter": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "profitCenter": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "validTo": "2019-08-24",
197 "erpSystemId": 0,
198 "erpSystemDisplayId": "string"
199 },
200 "functionalArea": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "businessArea": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "segment": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "network": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0
227 },
228 "internalOrderType": {
229 "id": 0,
230 "displayId": "string",
231 "status": "CREATED",
232 "name": "string",
233 "erpSystemId": 0
234 },
235 "internalOrder": {
236 "id": 0,
237 "displayId": "string",
238 "status": "CREATED",
239 "name": "string",
240 "erpSystemId": 0,
241 "internalOrderTypeId": 0
242 },
243 "additionalCurrencies": [
244 {
245 "id": 0,
246 "amount": 0,
247 "currency": {},
248 "conversionRate": 0,
249 "conversionDate": "2019-08-24",
250 "translationDateType": "DOCUMENT_DATE",
251 "amountType": "NET_AMOUNT",
252 "currencyDefinitionType": "CONTRACT_CURRENCY",
253 "invoiceEntryId": 0,
254 "invoiceEntryDisplayId": "string"
255 }
256 ],
257 "scheduledPaymentMatches": [
258 {
259 "id": 0,
260 "fromId": 0,
261 "toId": 0,
262 "amount": 0
263 }
264 ],
265 "goodsReceiptLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "invoiceId": 0,
274 "invoiceDisplayId": "string",
275 "invoiceState": "INV_DRAFT",
276 "vendorPaymentId": 0,
277 "purchaseOrderLineItemId": 0,
278 "netAmount": 0,
279 "allowsSystemGenerateNewId": true,
280 "numberRangeIdentifierValue": "string",
281 "numberRangeIdentifierType": {
282 "name": "string"
283 },
284 "numberRangeType": {
285 "name": "string"
286 }
287 }
288 ],
289 "goodsReceiptLineItems": [
290 {
291 "id": 0,
292 "displayId": "string",
293 "quantity": 0,
294 "invoicedQuantity": 0,
295 "description": "string",
296 "expenseCategory": {
297 "id": 0,
298 "displayId": "string",
299 "status": "CREATED",
300 "name": "string",
301 "expenseCategoryType": "PAYMENT"
302 },
303 "goodsReceiptId": 0,
304 "goodsReceiptDisplayId": "string",
305 "goodsReceiptState": "INV_DRAFT",
306 "purchaseOrderLineItemId": 0,
307 "invoiceLineItemLinks": [
308 {
309 "id": 0,
310 "fromId": 0,
311 "toId": 0,
312 "linkedQuantity": 0
313 }
314 ],
315 "allowsSystemGenerateNewId": true,
316 "numberRangeIdentifierValue": "string",
317 "numberRangeIdentifierType": {
318 "name": "string"
319 },
320 "numberRangeType": {
321 "name": "string"
322 }
323 }
324 ],
325 "vendorPaymentId": 0,
326 "purchaseRequisitionLineItemId": 0,
327 "purchaseRequisitionDisplayId": "string",
328 "purchaseRequisitionLineItemAvailableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "allowsSystemGenerateNewId": true,
340 "numberRangeIdentifierValue": "string",
341 "numberRangeIdentifierType": {
342 "name": "string"
343 },
344 "numberRangeType": {
345 "name": "string"
346 }
347 }
348 ],
349 "purchaseOrders": [
350 {
351 "id": 0,
352 "displayId": "string",
353 "state": "INV_DRAFT",
354 "issueDate": "2019-08-24",
355 "expectedDeliveryDate": "2019-08-24",
356 "name": "string",
357 "shippingAddress": "string",
358 "notes": "string",
359 "netAmount": 0,
360 "taxAmount": 0,
361 "externalPurchaseOrderDisplayId": "string",
362 "vendor": {
363 "id": 0,
364 "displayId": "string",
365 "status": "CREATED",
366 "name": "string",
367 "erpSystemDisplayId": "string"
368 },
369 "currency": {
370 "id": 0,
371 "displayId": "string",
372 "status": "CREATED",
373 "name": "string",
374 "decimalPoints": 0
375 },
376 "company": {
377 "id": 0,
378 "displayId": "string",
379 "status": "CREATED",
380 "erpSystemId": 0,
381 "erpSystemDisplayId": "string",
382 "countryId": 0,
383 "countryDisplayId": "string",
384 "name": "string",
385 "postingPeriodVariantId": 0,
386 "fiscalVariantId": 0
387 },
388 "purchaseOrderLineItems": [
389 {
390 "id": 0,
391 "displayId": "string",
392 "quantity": 0,
393 "allocatedQuantity": 0,
394 "receivedQuantity": 0,
395 "unitPrice": 0,
396 "description": "string",
397 "expenseCategory": {
398 "id": 0,
399 "displayId": "string",
400 "status": "CREATED",
401 "name": "string",
402 "expenseCategoryType": "PAYMENT"
403 },
404 "costCenter": {
405 "id": 0,
406 "displayId": "string",
407 "status": "CREATED",
408 "name": "string",
409 "erpSystemId": 0
410 },
411 "profitCenter": {
412 "id": 0,
413 "displayId": "string",
414 "status": "CREATED",
415 "name": "string",
416 "validTo": "2019-08-24",
417 "erpSystemId": 0,
418 "erpSystemDisplayId": "string"
419 },
420 "taxJurisdiction": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0,
426 "schema": "string",
427 "countryDisplayId": "string"
428 },
429 "taxCode": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "erpSystemId": 0
435 },
436 "taxLineItems": [
437 {
438 "id": 0,
439 "taxRate": 0.1,
440 "taxAmount": 0,
441 "taxType": "string",
442 "purchaseOrderLineItemId": 0
443 }
444 ],
445 "purchaseOrderId": 0,
446 "purchaseOrderDisplayId": "string",
447 "purchaseOrderState": "INV_DRAFT",
448 "invoiceLineItems": [
449 {
450 "id": 0,
451 "displayId": "string",
452 "expenseCategory": {
453 "id": 0,
454 "displayId": "string",
455 "status": "CREATED",
456 "name": "string",
457 "expenseCategoryType": "PAYMENT"
458 },
459 "description": "string",
460 "unitOfMeasure": {
461 "id": 0,
462 "displayId": "string",
463 "status": "CREATED",
464 "name": "string",
465 "erpSystemId": 0
466 },
467 "quantity": 0,
468 "unitPrice": 0,
469 "taxJurisdiction": {
470 "id": 0,
471 "displayId": "string",
472 "status": "CREATED",
473 "name": "string",
474 "erpSystemId": 0,
475 "schema": "string",
476 "countryDisplayId": "string"
477 },
478 "taxCode": {
479 "id": 0,
480 "displayId": "string",
481 "status": "CREATED",
482 "name": "string",
483 "erpSystemId": 0
484 },
485 "taxExpenseAccount": {
486 "id": 0,
487 "displayId": "string",
488 "generalLedgerAccountName": "string",
489 "generalLedgerAccountCode": "string",
490 "openItemManagement": true,
491 "accountCategory": "BALANCESHEET",
492 "shortName": "string",
493 "longName": "string"
494 },
495 "taxLineItems": [
496 {
497 "id": 0,
498 "taxRate": 0.1,
499 "taxAmount": 0,
500 "taxType": "string",
501 "invoiceLineItemId": 0
502 }
503 ],
504 "workBreakdownStructure": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "costCenter": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "profitCenter": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "validTo": "2019-08-24",
524 "erpSystemId": 0,
525 "erpSystemDisplayId": "string"
526 },
527 "functionalArea": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "businessArea": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "erpSystemId": 0
540 },
541 "segment": {
542 "id": 0,
543 "displayId": "string",
544 "status": "CREATED",
545 "name": "string",
546 "erpSystemId": 0
547 },
548 "network": {
549 "id": 0,
550 "displayId": "string",
551 "status": "CREATED",
552 "name": "string",
553 "erpSystemId": 0
554 },
555 "internalOrderType": {
556 "id": 0,
557 "displayId": "string",
558 "status": "CREATED",
559 "name": "string",
560 "erpSystemId": 0
561 },
562 "internalOrder": {
563 "id": 0,
564 "displayId": "string",
565 "status": "CREATED",
566 "name": "string",
567 "erpSystemId": 0,
568 "internalOrderTypeId": 0
569 },
570 "additionalCurrencies": [
571 {
572 "id": 0,
573 "amount": 0,
574 "currency": {},
575 "conversionRate": 0,
576 "conversionDate": "2019-08-24",
577 "translationDateType": "DOCUMENT_DATE",
578 "amountType": "NET_AMOUNT",
579 "currencyDefinitionType": "CONTRACT_CURRENCY",
580 "invoiceEntryId": 0,
581 "invoiceEntryDisplayId": "string"
582 }
583 ],
584 "scheduledPaymentMatches": [
585 {
586 "id": 0,
587 "fromId": 0,
588 "toId": 0,
589 "amount": 0
590 }
591 ],
592 "goodsReceiptLineItemLinks": [
593 {
594 "id": 0,
595 "fromId": 0,
596 "toId": 0,
597 "linkedQuantity": 0
598 }
599 ],
600 "invoiceId": 0,
601 "invoiceDisplayId": "string",
602 "invoiceState": "INV_DRAFT",
603 "vendorPaymentId": 0,
604 "purchaseOrderLineItemId": 0,
605 "netAmount": 0,
606 "allowsSystemGenerateNewId": true,
607 "numberRangeIdentifierValue": "string",
608 "numberRangeIdentifierType": {
609 "name": "string"
610 },
611 "numberRangeType": {
612 "name": "string"
613 }
614 }
615 ],
616 "goodsReceiptLineItems": [
617 {
618 "id": 0,
619 "displayId": "string",
620 "quantity": 0,
621 "invoicedQuantity": 0,
622 "description": "string",
623 "expenseCategory": {
624 "id": 0,
625 "displayId": "string",
626 "status": "CREATED",
627 "name": "string",
628 "expenseCategoryType": "PAYMENT"
629 },
630 "goodsReceiptId": 0,
631 "goodsReceiptDisplayId": "string",
632 "goodsReceiptState": "INV_DRAFT",
633 "purchaseOrderLineItemId": 0,
634 "invoiceLineItemLinks": [
635 {
636 "id": 0,
637 "fromId": 0,
638 "toId": 0,
639 "linkedQuantity": 0
640 }
641 ],
642 "allowsSystemGenerateNewId": true,
643 "numberRangeIdentifierValue": "string",
644 "numberRangeIdentifierType": {
645 "name": "string"
646 },
647 "numberRangeType": {
648 "name": "string"
649 }
650 }
651 ],
652 "vendorPaymentId": 0,
653 "purchaseRequisitionLineItemId": 0,
654 "purchaseRequisitionDisplayId": "string",
655 "purchaseRequisitionLineItemAvailableQuantity": 0,
656 "allowsSystemGenerateNewId": true,
657 "numberRangeIdentifierValue": "string",
658 "numberRangeIdentifierType": {
659 "name": "string"
660 },
661 "numberRangeType": {
662 "name": "string"
663 }
664 }
665 ],
666 "purchaseRequisitionIds": [
667 0
668 ],
669 "purchaseRequisitionDisplayIds": [
670 "string"
671 ],
672 "invoices": [
673 {
674 "id": 0,
675 "displayId": "string",
676 "name": "string",
677 "invoiceType": "VENDOR_INV",
678 "state": "INV_DRAFT",
679 "externalDocumentNumber": "string",
680 "purchaseOrderReference": "string",
681 "invoiceDate": "2019-08-24",
682 "dueDate": "2019-08-24",
683 "notes": "string",
684 "billingPeriodFromDate": "2019-08-24",
685 "billingPeriodToDate": "2019-08-24",
686 "currency": {
687 "id": 0,
688 "displayId": "string",
689 "status": "CREATED",
690 "name": "string",
691 "decimalPoints": 0
692 },
693 "vendor": {
694 "id": 0,
695 "displayId": "string",
696 "status": "CREATED",
697 "name": "string",
698 "erpSystemDisplayId": "string"
699 },
700 "company": {
701 "id": 0,
702 "displayId": "string",
703 "status": "CREATED",
704 "erpSystemId": 0,
705 "erpSystemDisplayId": "string",
706 "countryId": 0,
707 "countryDisplayId": "string",
708 "name": "string",
709 "postingPeriodVariantId": 0,
710 "fiscalVariantId": 0
711 },
712 "netAmount": 0,
713 "taxAmount": 0,
714 "totalAmount": 0,
715 "netAmountBalance": 0,
716 "taxAmountBalance": 0,
717 "paymentTerm": {
718 "id": 0,
719 "displayId": "string",
720 "status": "CREATED",
721 "name": "string"
722 },
723 "paymentMethod": {
724 "id": 0,
725 "displayId": "string",
726 "status": "CREATED",
727 "name": "string",
728 "type": "string"
729 },
730 "paymentBlock": {
731 "id": 0,
732 "displayId": "string",
733 "status": "CREATED",
734 "name": "string"
735 },
736 "defaultCostCenter": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string",
741 "erpSystemId": 0
742 },
743 "defaultProfitCenter": {
744 "id": 0,
745 "displayId": "string",
746 "status": "CREATED",
747 "name": "string",
748 "validTo": "2019-08-24",
749 "erpSystemId": 0,
750 "erpSystemDisplayId": "string"
751 },
752 "invoiceLineItems": [
753 {
754 "id": 0,
755 "displayId": "string",
756 "expenseCategory": {
757 "id": 0,
758 "displayId": "string",
759 "status": "CREATED",
760 "name": "string",
761 "expenseCategoryType": "PAYMENT"
762 },
763 "description": "string",
764 "unitOfMeasure": {
765 "id": 0,
766 "displayId": "string",
767 "status": "CREATED",
768 "name": "string",
769 "erpSystemId": 0
770 },
771 "quantity": 0,
772 "unitPrice": 0,
773 "taxJurisdiction": {
774 "id": 0,
775 "displayId": "string",
776 "status": "CREATED",
777 "name": "string",
778 "erpSystemId": 0,
779 "schema": "string",
780 "countryDisplayId": "string"
781 },
782 "taxCode": {
783 "id": 0,
784 "displayId": "string",
785 "status": "CREATED",
786 "name": "string",
787 "erpSystemId": 0
788 },
789 "taxExpenseAccount": {
790 "id": 0,
791 "displayId": "string",
792 "generalLedgerAccountName": "string",
793 "generalLedgerAccountCode": "string",
794 "openItemManagement": true,
795 "accountCategory": "BALANCESHEET",
796 "shortName": "string",
797 "longName": "string"
798 },
799 "taxLineItems": [
800 {
801 "id": 0,
802 "taxRate": 0.1,
803 "taxAmount": 0,
804 "taxType": "string",
805 "invoiceLineItemId": 0
806 }
807 ],
808 "workBreakdownStructure": {
809 "id": 0,
810 "displayId": "string",
811 "status": "CREATED",
812 "name": "string",
813 "erpSystemId": 0
814 },
815 "costCenter": {
816 "id": 0,
817 "displayId": "string",
818 "status": "CREATED",
819 "name": "string",
820 "erpSystemId": 0
821 },
822 "profitCenter": {
823 "id": 0,
824 "displayId": "string",
825 "status": "CREATED",
826 "name": "string",
827 "validTo": "2019-08-24",
828 "erpSystemId": 0,
829 "erpSystemDisplayId": "string"
830 },
831 "functionalArea": {
832 "id": 0,
833 "displayId": "string",
834 "status": "CREATED",
835 "name": "string",
836 "erpSystemId": 0
837 },
838 "businessArea": {
839 "id": 0,
840 "displayId": "string",
841 "status": "CREATED",
842 "name": "string",
843 "erpSystemId": 0
844 },
845 "segment": {
846 "id": 0,
847 "displayId": "string",
848 "status": "CREATED",
849 "name": "string",
850 "erpSystemId": 0
851 },
852 "network": {
853 "id": 0,
854 "displayId": "string",
855 "status": "CREATED",
856 "name": "string",
857 "erpSystemId": 0
858 },
859 "internalOrderType": {
860 "id": 0,
861 "displayId": "string",
862 "status": "CREATED",
863 "name": "string",
864 "erpSystemId": 0
865 },
866 "internalOrder": {
867 "id": 0,
868 "displayId": "string",
869 "status": "CREATED",
870 "name": "string",
871 "erpSystemId": 0,
872 "internalOrderTypeId": 0
873 },
874 "additionalCurrencies": [
875 {
876 "id": 0,
877 "amount": 0,
878 "currency": {},
879 "conversionRate": 0,
880 "conversionDate": "2019-08-24",
881 "translationDateType": "DOCUMENT_DATE",
882 "amountType": "NET_AMOUNT",
883 "currencyDefinitionType": "CONTRACT_CURRENCY",
884 "invoiceEntryId": 0,
885 "invoiceEntryDisplayId": "string"
886 }
887 ],
888 "scheduledPaymentMatches": [
889 {
890 "id": 0,
891 "fromId": 0,
892 "toId": 0,
893 "amount": 0
894 }
895 ],
896 "goodsReceiptLineItemLinks": [
897 {
898 "id": 0,
899 "fromId": 0,
900 "toId": 0,
901 "linkedQuantity": 0
902 }
903 ],
904 "invoiceId": 0,
905 "invoiceDisplayId": "string",
906 "invoiceState": "INV_DRAFT",
907 "vendorPaymentId": 0,
908 "purchaseOrderLineItemId": 0,
909 "netAmount": 0,
910 "allowsSystemGenerateNewId": true,
911 "numberRangeIdentifierValue": "string",
912 "numberRangeIdentifierType": {
913 "name": "string"
914 },
915 "numberRangeType": {
916 "name": "string"
917 }
918 }
919 ],
920 "workspaceId": 0,
921 "workspaceDisplayId": "string",
922 "workspaceName": "string",
923 "workspaceState": "INV_DRAFT",
924 "remainingNetAmount": 0,
925 "remainingTaxAmount": 0,
926 "remainingTotalAmount": 0,
927 "pendingPaymentCount": 0,
928 "allPaymentsPosted": true,
929 "approvalInfo": {
930 "approverUsername": "string",
931 "approvedAt": "2019-08-24T14:15:22Z"
932 },
933 "rejectionReason": "string",
934 "allowsSystemGenerateNewId": true,
935 "numberRangeIdentifierValue": "string",
936 "numberRangeIdentifierType": {
937 "name": "string"
938 },
939 "numberRangeType": {
940 "name": "string"
941 }
942 }
943 ],
944 "rejectionReason": "string",
945 "allowsSystemGenerateNewId": true,
946 "numberRangeIdentifierValue": "string",
947 "numberRangeIdentifierType": {
948 "name": "string"
949 },
950 "numberRangeType": {
951 "name": "string"
952 }
953 }
954 ],
955 "approvalInfo": {
956 "approverUsername": "string",
957 "approvedAt": "2019-08-24T14:15:22Z"
958 },
959 "rejectionReason": "string",
960 "allowsSystemGenerateNewId": true,
961 "numberRangeIdentifierValue": "string",
962 "numberRangeIdentifierType": {
963 "name": "string"
964 },
965 "numberRangeType": {
966 "name": "string"
967 }
968 }
969]
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 "shippingAddress": "string",
19 "state": "INV_DRAFT",
20 "notes": "string",
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 "totalAmount": 0,
41 "purchaseRequisitionItems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "quantity": 0,
46 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
73 "purchaseRequisitionDisplayId": "string",
74 "purchaseOrderLineItems": [
75 {
76 "id": 0,
77 "displayId": "string",
78 "quantity": 0,
79 "allocatedQuantity": 0,
80 "receivedQuantity": 0,
81 "unitPrice": 0,
82 "description": "string",
83 "expenseCategory": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "expenseCategoryType": "PAYMENT"
89 },
90 "costCenter": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "profitCenter": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "validTo": "2019-08-24",
103 "erpSystemId": 0,
104 "erpSystemDisplayId": "string"
105 },
106 "taxJurisdiction": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0,
112 "schema": "string",
113 "countryDisplayId": "string"
114 },
115 "taxCode": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0
121 },
122 "taxLineItems": [
123 {
124 "id": 0,
125 "taxRate": 0.1,
126 "taxAmount": 0,
127 "taxType": "string",
128 "purchaseOrderLineItemId": 0
129 }
130 ],
131 "purchaseOrderId": 0,
132 "purchaseOrderDisplayId": "string",
133 "purchaseOrderState": "INV_DRAFT",
134 "invoiceLineItems": [
135 {
136 "id": 0,
137 "displayId": "string",
138 "expenseCategory": {
139 "id": 0,
140 "displayId": "string",
141 "status": "CREATED",
142 "name": "string",
143 "expenseCategoryType": "PAYMENT"
144 },
145 "description": "string",
146 "unitOfMeasure": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "quantity": 0,
154 "unitPrice": 0,
155 "taxJurisdiction": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0,
161 "schema": "string",
162 "countryDisplayId": "string"
163 },
164 "taxCode": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "taxExpenseAccount": {
172 "id": 0,
173 "displayId": "string",
174 "generalLedgerAccountName": "string",
175 "generalLedgerAccountCode": "string",
176 "openItemManagement": true,
177 "accountCategory": "BALANCESHEET",
178 "shortName": "string",
179 "longName": "string"
180 },
181 "taxLineItems": [
182 {}
183 ],
184 "workBreakdownStructure": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "costCenter": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "profitCenter": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "validTo": "2019-08-24",
204 "erpSystemId": 0,
205 "erpSystemDisplayId": "string"
206 },
207 "functionalArea": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "businessArea": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "segment": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0
227 },
228 "network": {
229 "id": 0,
230 "displayId": "string",
231 "status": "CREATED",
232 "name": "string",
233 "erpSystemId": 0
234 },
235 "internalOrderType": {
236 "id": 0,
237 "displayId": "string",
238 "status": "CREATED",
239 "name": "string",
240 "erpSystemId": 0
241 },
242 "internalOrder": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "erpSystemId": 0,
248 "internalOrderTypeId": 0
249 },
250 "additionalCurrencies": [
251 {}
252 ],
253 "scheduledPaymentMatches": [
254 {}
255 ],
256 "goodsReceiptLineItemLinks": [
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 ],
296 "availableQuantity": 0,
297 "allowsSystemGenerateNewId": true,
298 "numberRangeIdentifierValue": "string",
299 "numberRangeIdentifierType": {
300 "name": "string"
301 },
302 "numberRangeType": {
303 "name": "string"
304 }
305 }
306 ],
307 "vendorPaymentId": 0,
308 "purchaseRequisitionLineItemId": 0,
309 "purchaseRequisitionDisplayId": "string",
310 "purchaseRequisitionLineItemAvailableQuantity": 0,
311 "remainingQuantity": 0,
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "availableQuantity": 0,
324 "allowsSystemGenerateNewId": true,
325 "numberRangeIdentifierValue": "string",
326 "numberRangeIdentifierType": {
327 "name": "string"
328 },
329 "numberRangeType": {
330 "name": "string"
331 }
332 }
333 ],
334 "purchaseOrders": [
335 {
336 "id": 0,
337 "displayId": "string",
338 "state": "INV_DRAFT",
339 "issueDate": "2019-08-24",
340 "expectedDeliveryDate": "2019-08-24",
341 "name": "string",
342 "shippingAddress": "string",
343 "notes": "string",
344 "netAmount": 0,
345 "taxAmount": 0,
346 "externalPurchaseOrderDisplayId": "string",
347 "vendor": {
348 "id": 0,
349 "displayId": "string",
350 "status": "CREATED",
351 "name": "string",
352 "erpSystemDisplayId": "string"
353 },
354 "currency": {
355 "id": 0,
356 "displayId": "string",
357 "status": "CREATED",
358 "name": "string",
359 "decimalPoints": 0
360 },
361 "company": {
362 "id": 0,
363 "displayId": "string",
364 "status": "CREATED",
365 "erpSystemId": 0,
366 "erpSystemDisplayId": "string",
367 "countryId": 0,
368 "countryDisplayId": "string",
369 "name": "string",
370 "postingPeriodVariantId": 0,
371 "fiscalVariantId": 0
372 },
373 "purchaseOrderLineItems": [
374 {
375 "id": 0,
376 "displayId": "string",
377 "quantity": 0,
378 "allocatedQuantity": 0,
379 "receivedQuantity": 0,
380 "unitPrice": 0,
381 "description": "string",
382 "expenseCategory": {
383 "id": 0,
384 "displayId": "string",
385 "status": "CREATED",
386 "name": "string",
387 "expenseCategoryType": "PAYMENT"
388 },
389 "costCenter": {
390 "id": 0,
391 "displayId": "string",
392 "status": "CREATED",
393 "name": "string",
394 "erpSystemId": 0
395 },
396 "profitCenter": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "validTo": "2019-08-24",
402 "erpSystemId": 0,
403 "erpSystemDisplayId": "string"
404 },
405 "taxJurisdiction": {
406 "id": 0,
407 "displayId": "string",
408 "status": "CREATED",
409 "name": "string",
410 "erpSystemId": 0,
411 "schema": "string",
412 "countryDisplayId": "string"
413 },
414 "taxCode": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "erpSystemId": 0
420 },
421 "taxLineItems": [
422 {
423 "id": 0,
424 "taxRate": 0.1,
425 "taxAmount": 0,
426 "taxType": "string",
427 "purchaseOrderLineItemId": 0
428 }
429 ],
430 "purchaseOrderId": 0,
431 "purchaseOrderDisplayId": "string",
432 "purchaseOrderState": "INV_DRAFT",
433 "invoiceLineItems": [
434 {
435 "id": 0,
436 "displayId": "string",
437 "expenseCategory": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "expenseCategoryType": "PAYMENT"
443 },
444 "description": "string",
445 "unitOfMeasure": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "quantity": 0,
453 "unitPrice": 0,
454 "taxJurisdiction": {
455 "id": 0,
456 "displayId": "string",
457 "status": "CREATED",
458 "name": "string",
459 "erpSystemId": 0,
460 "schema": "string",
461 "countryDisplayId": "string"
462 },
463 "taxCode": {
464 "id": 0,
465 "displayId": "string",
466 "status": "CREATED",
467 "name": "string",
468 "erpSystemId": 0
469 },
470 "taxExpenseAccount": {
471 "id": 0,
472 "displayId": "string",
473 "generalLedgerAccountName": "string",
474 "generalLedgerAccountCode": "string",
475 "openItemManagement": true,
476 "accountCategory": "BALANCESHEET",
477 "shortName": "string",
478 "longName": "string"
479 },
480 "taxLineItems": [
481 {}
482 ],
483 "workBreakdownStructure": {
484 "id": 0,
485 "displayId": "string",
486 "status": "CREATED",
487 "name": "string",
488 "erpSystemId": 0
489 },
490 "costCenter": {
491 "id": 0,
492 "displayId": "string",
493 "status": "CREATED",
494 "name": "string",
495 "erpSystemId": 0
496 },
497 "profitCenter": {
498 "id": 0,
499 "displayId": "string",
500 "status": "CREATED",
501 "name": "string",
502 "validTo": "2019-08-24",
503 "erpSystemId": 0,
504 "erpSystemDisplayId": "string"
505 },
506 "functionalArea": {
507 "id": 0,
508 "displayId": "string",
509 "status": "CREATED",
510 "name": "string",
511 "erpSystemId": 0
512 },
513 "businessArea": {
514 "id": 0,
515 "displayId": "string",
516 "status": "CREATED",
517 "name": "string",
518 "erpSystemId": 0
519 },
520 "segment": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "network": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "internalOrderType": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "erpSystemId": 0
540 },
541 "internalOrder": {
542 "id": 0,
543 "displayId": "string",
544 "status": "CREATED",
545 "name": "string",
546 "erpSystemId": 0,
547 "internalOrderTypeId": 0
548 },
549 "additionalCurrencies": [
550 {}
551 ],
552 "scheduledPaymentMatches": [
553 {}
554 ],
555 "goodsReceiptLineItemLinks": [
556 {}
557 ],
558 "invoiceId": 0,
559 "invoiceDisplayId": "string",
560 "invoiceState": "INV_DRAFT",
561 "vendorPaymentId": 0,
562 "purchaseOrderLineItemId": 0,
563 "netAmount": 0,
564 "allowsSystemGenerateNewId": true,
565 "numberRangeIdentifierValue": "string",
566 "numberRangeIdentifierType": {
567 "name": "string"
568 },
569 "numberRangeType": {
570 "name": "string"
571 }
572 }
573 ],
574 "goodsReceiptLineItems": [
575 {
576 "id": 0,
577 "displayId": "string",
578 "quantity": 0,
579 "invoicedQuantity": 0,
580 "description": "string",
581 "expenseCategory": {
582 "id": 0,
583 "displayId": "string",
584 "status": "CREATED",
585 "name": "string",
586 "expenseCategoryType": "PAYMENT"
587 },
588 "goodsReceiptId": 0,
589 "goodsReceiptDisplayId": "string",
590 "goodsReceiptState": "INV_DRAFT",
591 "purchaseOrderLineItemId": 0,
592 "invoiceLineItemLinks": [
593 {}
594 ],
595 "availableQuantity": 0,
596 "allowsSystemGenerateNewId": true,
597 "numberRangeIdentifierValue": "string",
598 "numberRangeIdentifierType": {
599 "name": "string"
600 },
601 "numberRangeType": {
602 "name": "string"
603 }
604 }
605 ],
606 "vendorPaymentId": 0,
607 "purchaseRequisitionLineItemId": 0,
608 "purchaseRequisitionDisplayId": "string",
609 "purchaseRequisitionLineItemAvailableQuantity": 0,
610 "remainingQuantity": 0,
611 "availableQuantity": 0,
612 "allowsSystemGenerateNewId": true,
613 "numberRangeIdentifierValue": "string",
614 "numberRangeIdentifierType": {
615 "name": "string"
616 },
617 "numberRangeType": {
618 "name": "string"
619 }
620 }
621 ],
622 "purchaseRequisitionIds": [
623 0
624 ],
625 "purchaseRequisitionDisplayIds": [
626 "string"
627 ],
628 "invoices": [
629 {
630 "id": 0,
631 "displayId": "string",
632 "name": "string",
633 "invoiceType": "VENDOR_INV",
634 "state": "INV_DRAFT",
635 "externalDocumentNumber": "string",
636 "purchaseOrderReference": "string",
637 "invoiceDate": "2019-08-24",
638 "dueDate": "2019-08-24",
639 "notes": "string",
640 "billingPeriodFromDate": "2019-08-24",
641 "billingPeriodToDate": "2019-08-24",
642 "currency": {
643 "id": 0,
644 "displayId": "string",
645 "status": "CREATED",
646 "name": "string",
647 "decimalPoints": 0
648 },
649 "vendor": {
650 "id": 0,
651 "displayId": "string",
652 "status": "CREATED",
653 "name": "string",
654 "erpSystemDisplayId": "string"
655 },
656 "company": {
657 "id": 0,
658 "displayId": "string",
659 "status": "CREATED",
660 "erpSystemId": 0,
661 "erpSystemDisplayId": "string",
662 "countryId": 0,
663 "countryDisplayId": "string",
664 "name": "string",
665 "postingPeriodVariantId": 0,
666 "fiscalVariantId": 0
667 },
668 "netAmount": 0,
669 "taxAmount": 0,
670 "totalAmount": 0,
671 "netAmountBalance": 0,
672 "taxAmountBalance": 0,
673 "paymentTerm": {
674 "id": 0,
675 "displayId": "string",
676 "status": "CREATED",
677 "name": "string"
678 },
679 "paymentMethod": {
680 "id": 0,
681 "displayId": "string",
682 "status": "CREATED",
683 "name": "string",
684 "type": "string"
685 },
686 "paymentBlock": {
687 "id": 0,
688 "displayId": "string",
689 "status": "CREATED",
690 "name": "string"
691 },
692 "defaultCostCenter": {
693 "id": 0,
694 "displayId": "string",
695 "status": "CREATED",
696 "name": "string",
697 "erpSystemId": 0
698 },
699 "defaultProfitCenter": {
700 "id": 0,
701 "displayId": "string",
702 "status": "CREATED",
703 "name": "string",
704 "validTo": "2019-08-24",
705 "erpSystemId": 0,
706 "erpSystemDisplayId": "string"
707 },
708 "invoiceLineItems": [
709 {
710 "id": 0,
711 "displayId": "string",
712 "expenseCategory": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "expenseCategoryType": "PAYMENT"
718 },
719 "description": "string",
720 "unitOfMeasure": {
721 "id": 0,
722 "displayId": "string",
723 "status": "CREATED",
724 "name": "string",
725 "erpSystemId": 0
726 },
727 "quantity": 0,
728 "unitPrice": 0,
729 "taxJurisdiction": {
730 "id": 0,
731 "displayId": "string",
732 "status": "CREATED",
733 "name": "string",
734 "erpSystemId": 0,
735 "schema": "string",
736 "countryDisplayId": "string"
737 },
738 "taxCode": {
739 "id": 0,
740 "displayId": "string",
741 "status": "CREATED",
742 "name": "string",
743 "erpSystemId": 0
744 },
745 "taxExpenseAccount": {
746 "id": 0,
747 "displayId": "string",
748 "generalLedgerAccountName": "string",
749 "generalLedgerAccountCode": "string",
750 "openItemManagement": true,
751 "accountCategory": "BALANCESHEET",
752 "shortName": "string",
753 "longName": "string"
754 },
755 "taxLineItems": [
756 {}
757 ],
758 "workBreakdownStructure": {
759 "id": 0,
760 "displayId": "string",
761 "status": "CREATED",
762 "name": "string",
763 "erpSystemId": 0
764 },
765 "costCenter": {
766 "id": 0,
767 "displayId": "string",
768 "status": "CREATED",
769 "name": "string",
770 "erpSystemId": 0
771 },
772 "profitCenter": {
773 "id": 0,
774 "displayId": "string",
775 "status": "CREATED",
776 "name": "string",
777 "validTo": "2019-08-24",
778 "erpSystemId": 0,
779 "erpSystemDisplayId": "string"
780 },
781 "functionalArea": {
782 "id": 0,
783 "displayId": "string",
784 "status": "CREATED",
785 "name": "string",
786 "erpSystemId": 0
787 },
788 "businessArea": {
789 "id": 0,
790 "displayId": "string",
791 "status": "CREATED",
792 "name": "string",
793 "erpSystemId": 0
794 },
795 "segment": {
796 "id": 0,
797 "displayId": "string",
798 "status": "CREATED",
799 "name": "string",
800 "erpSystemId": 0
801 },
802 "network": {
803 "id": 0,
804 "displayId": "string",
805 "status": "CREATED",
806 "name": "string",
807 "erpSystemId": 0
808 },
809 "internalOrderType": {
810 "id": 0,
811 "displayId": "string",
812 "status": "CREATED",
813 "name": "string",
814 "erpSystemId": 0
815 },
816 "internalOrder": {
817 "id": 0,
818 "displayId": "string",
819 "status": "CREATED",
820 "name": "string",
821 "erpSystemId": 0,
822 "internalOrderTypeId": 0
823 },
824 "additionalCurrencies": [
825 {}
826 ],
827 "scheduledPaymentMatches": [
828 {}
829 ],
830 "goodsReceiptLineItemLinks": [
831 {}
832 ],
833 "invoiceId": 0,
834 "invoiceDisplayId": "string",
835 "invoiceState": "INV_DRAFT",
836 "vendorPaymentId": 0,
837 "purchaseOrderLineItemId": 0,
838 "netAmount": 0,
839 "allowsSystemGenerateNewId": true,
840 "numberRangeIdentifierValue": "string",
841 "numberRangeIdentifierType": {
842 "name": "string"
843 },
844 "numberRangeType": {
845 "name": "string"
846 }
847 }
848 ],
849 "workspaceId": 0,
850 "workspaceDisplayId": "string",
851 "workspaceName": "string",
852 "workspaceState": "INV_DRAFT",
853 "remainingNetAmount": 0,
854 "remainingTaxAmount": 0,
855 "remainingTotalAmount": 0,
856 "pendingPaymentCount": 0,
857 "allPaymentsPosted": true,
858 "approvalInfo": {
859 "approverUsername": "string",
860 "approvedAt": "2019-08-24T14:15:22Z"
861 },
862 "rejectionReason": "string",
863 "allowsSystemGenerateNewId": true,
864 "numberRangeIdentifierValue": "string",
865 "numberRangeIdentifierType": {
866 "name": "string"
867 },
868 "numberRangeType": {
869 "name": "string"
870 }
871 }
872 ],
873 "rejectionReason": "string",
874 "allowsSystemGenerateNewId": true,
875 "numberRangeIdentifierValue": "string",
876 "numberRangeIdentifierType": {
877 "name": "string"
878 },
879 "numberRangeType": {
880 "name": "string"
881 }
882 }
883 ],
884 "approvalInfo": {
885 "approverUsername": "string",
886 "approvedAt": "2019-08-24T14:15:22Z"
887 },
888 "rejectionReason": "string",
889 "allowsSystemGenerateNewId": true,
890 "numberRangeIdentifierValue": "string",
891 "numberRangeIdentifierType": {
892 "name": "string"
893 },
894 "numberRangeType": {
895 "name": "string"
896 }
897 }
898 ]
899}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/purchase-requisition/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 requisition details, including item specifications, quantities, and associated metadata for creating or updating requisitions. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "shippingAddress": "string",
5 "state": "INV_DRAFT",
6 "notes": "string",
7 "currency": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string",
12 "decimalPoints": 0
13 },
14 "company": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "name": "string",
23 "postingPeriodVariantId": 0,
24 "fiscalVariantId": 0
25 },
26 "totalAmount": 0,
27 "purchaseRequisitionItems": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "quantity": 0,
32 "allocatedQuantity": 0,
33 "unitPrice": 0,
34 "description": "string",
35 "expenseCategory": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "expenseCategoryType": "PAYMENT"
41 },
42 "costCenter": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "profitCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "validTo": "2019-08-24",
55 "erpSystemId": 0,
56 "erpSystemDisplayId": "string"
57 },
58 "purchaseRequisitionId": 0,
59 "purchaseRequisitionDisplayId": "string",
60 "purchaseOrderLineItems": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "quantity": 0,
65 "allocatedQuantity": 0,
66 "receivedQuantity": 0,
67 "unitPrice": 0,
68 "description": "string",
69 "expenseCategory": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "expenseCategoryType": "PAYMENT"
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "taxJurisdiction": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0,
98 "schema": "string",
99 "countryDisplayId": "string"
100 },
101 "taxCode": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "purchaseOrderLineItemId": 0
115 }
116 ],
117 "purchaseOrderId": 0,
118 "purchaseOrderDisplayId": "string",
119 "purchaseOrderState": "INV_DRAFT",
120 "invoiceLineItems": [
121 {
122 "id": 0,
123 "displayId": "string",
124 "expenseCategory": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "expenseCategoryType": "PAYMENT"
130 },
131 "description": "string",
132 "unitOfMeasure": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0
138 },
139 "quantity": 0,
140 "unitPrice": 0,
141 "taxJurisdiction": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0,
147 "schema": "string",
148 "countryDisplayId": "string"
149 },
150 "taxCode": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "taxExpenseAccount": {
158 "id": 0,
159 "displayId": "string",
160 "generalLedgerAccountName": "string",
161 "generalLedgerAccountCode": "string",
162 "openItemManagement": true,
163 "accountCategory": "BALANCESHEET",
164 "shortName": "string",
165 "longName": "string"
166 },
167 "taxLineItems": [
168 {
169 "id": 0,
170 "taxRate": 0.1,
171 "taxAmount": 0,
172 "taxType": "string",
173 "invoiceLineItemId": 0
174 }
175 ],
176 "workBreakdownStructure": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 },
183 "costCenter": {
184 "id": 0,
185 "displayId": "string",
186 "status": "CREATED",
187 "name": "string",
188 "erpSystemId": 0
189 },
190 "profitCenter": {
191 "id": 0,
192 "displayId": "string",
193 "status": "CREATED",
194 "name": "string",
195 "validTo": "2019-08-24",
196 "erpSystemId": 0,
197 "erpSystemDisplayId": "string"
198 },
199 "functionalArea": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "businessArea": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "segment": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "network": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0
226 },
227 "internalOrderType": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "erpSystemId": 0
233 },
234 "internalOrder": {
235 "id": 0,
236 "displayId": "string",
237 "status": "CREATED",
238 "name": "string",
239 "erpSystemId": 0,
240 "internalOrderTypeId": 0
241 },
242 "additionalCurrencies": [
243 {
244 "id": 0,
245 "amount": 0,
246 "currency": {
247 "id": 0,
248 "displayId": "string",
249 "status": "CREATED",
250 "name": "string",
251 "decimalPoints": 0
252 },
253 "conversionRate": 0,
254 "conversionDate": "2019-08-24",
255 "translationDateType": "DOCUMENT_DATE",
256 "amountType": "NET_AMOUNT",
257 "currencyDefinitionType": "CONTRACT_CURRENCY",
258 "invoiceEntryId": 0,
259 "invoiceEntryDisplayId": "string"
260 }
261 ],
262 "scheduledPaymentMatches": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "amount": 0
268 }
269 ],
270 "goodsReceiptLineItemLinks": [
271 {
272 "id": 0,
273 "fromId": 0,
274 "toId": 0,
275 "linkedQuantity": 0
276 }
277 ],
278 "invoiceId": 0,
279 "invoiceDisplayId": "string",
280 "invoiceState": "INV_DRAFT",
281 "vendorPaymentId": 0,
282 "purchaseOrderLineItemId": 0,
283 "netAmount": 0,
284 "allowsSystemGenerateNewId": true,
285 "numberRangeIdentifierValue": "string",
286 "numberRangeIdentifierType": {
287 "name": "string"
288 },
289 "numberRangeType": {
290 "name": "string"
291 }
292 }
293 ],
294 "goodsReceiptLineItems": [
295 {
296 "id": 0,
297 "displayId": "string",
298 "quantity": 0,
299 "invoicedQuantity": 0,
300 "description": "string",
301 "expenseCategory": {
302 "id": 0,
303 "displayId": "string",
304 "status": "CREATED",
305 "name": "string",
306 "expenseCategoryType": "PAYMENT"
307 },
308 "goodsReceiptId": 0,
309 "goodsReceiptDisplayId": "string",
310 "goodsReceiptState": "INV_DRAFT",
311 "purchaseOrderLineItemId": 0,
312 "invoiceLineItemLinks": [
313 {
314 "id": 0,
315 "fromId": 0,
316 "toId": 0,
317 "linkedQuantity": 0
318 }
319 ],
320 "allowsSystemGenerateNewId": true,
321 "numberRangeIdentifierValue": "string",
322 "numberRangeIdentifierType": {
323 "name": "string"
324 },
325 "numberRangeType": {
326 "name": "string"
327 }
328 }
329 ],
330 "vendorPaymentId": 0,
331 "purchaseRequisitionLineItemId": 0,
332 "purchaseRequisitionDisplayId": "string",
333 "purchaseRequisitionLineItemAvailableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343 ],
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "purchaseOrders": [
355 {
356 "id": 0,
357 "displayId": "string",
358 "state": "INV_DRAFT",
359 "issueDate": "2019-08-24",
360 "expectedDeliveryDate": "2019-08-24",
361 "name": "string",
362 "shippingAddress": "string",
363 "notes": "string",
364 "netAmount": 0,
365 "taxAmount": 0,
366 "externalPurchaseOrderDisplayId": "string",
367 "vendor": {
368 "id": 0,
369 "displayId": "string",
370 "status": "CREATED",
371 "name": "string",
372 "erpSystemDisplayId": "string"
373 },
374 "currency": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "name": "string",
379 "decimalPoints": 0
380 },
381 "company": {
382 "id": 0,
383 "displayId": "string",
384 "status": "CREATED",
385 "erpSystemId": 0,
386 "erpSystemDisplayId": "string",
387 "countryId": 0,
388 "countryDisplayId": "string",
389 "name": "string",
390 "postingPeriodVariantId": 0,
391 "fiscalVariantId": 0
392 },
393 "purchaseOrderLineItems": [
394 {
395 "id": 0,
396 "displayId": "string",
397 "quantity": 0,
398 "allocatedQuantity": 0,
399 "receivedQuantity": 0,
400 "unitPrice": 0,
401 "description": "string",
402 "expenseCategory": {
403 "id": 0,
404 "displayId": "string",
405 "status": "CREATED",
406 "name": "string",
407 "expenseCategoryType": "PAYMENT"
408 },
409 "costCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "profitCenter": {
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 "taxJurisdiction": {
426 "id": 0,
427 "displayId": "string",
428 "status": "CREATED",
429 "name": "string",
430 "erpSystemId": 0,
431 "schema": "string",
432 "countryDisplayId": "string"
433 },
434 "taxCode": {
435 "id": 0,
436 "displayId": "string",
437 "status": "CREATED",
438 "name": "string",
439 "erpSystemId": 0
440 },
441 "taxLineItems": [
442 {
443 "id": 0,
444 "taxRate": 0.1,
445 "taxAmount": 0,
446 "taxType": "string",
447 "purchaseOrderLineItemId": 0
448 }
449 ],
450 "purchaseOrderId": 0,
451 "purchaseOrderDisplayId": "string",
452 "purchaseOrderState": "INV_DRAFT",
453 "invoiceLineItems": [
454 {
455 "id": 0,
456 "displayId": "string",
457 "expenseCategory": {
458 "id": 0,
459 "displayId": "string",
460 "status": "CREATED",
461 "name": "string",
462 "expenseCategoryType": "PAYMENT"
463 },
464 "description": "string",
465 "unitOfMeasure": {
466 "id": 0,
467 "displayId": "string",
468 "status": "CREATED",
469 "name": "string",
470 "erpSystemId": 0
471 },
472 "quantity": 0,
473 "unitPrice": 0,
474 "taxJurisdiction": {
475 "id": 0,
476 "displayId": "string",
477 "status": "CREATED",
478 "name": "string",
479 "erpSystemId": 0,
480 "schema": "string",
481 "countryDisplayId": "string"
482 },
483 "taxCode": {
484 "id": 0,
485 "displayId": "string",
486 "status": "CREATED",
487 "name": "string",
488 "erpSystemId": 0
489 },
490 "taxExpenseAccount": {
491 "id": 0,
492 "displayId": "string",
493 "generalLedgerAccountName": "string",
494 "generalLedgerAccountCode": "string",
495 "openItemManagement": true,
496 "accountCategory": "BALANCESHEET",
497 "shortName": "string",
498 "longName": "string"
499 },
500 "taxLineItems": [
501 {
502 "id": 0,
503 "taxRate": 0.1,
504 "taxAmount": 0,
505 "taxType": "string",
506 "invoiceLineItemId": 0
507 }
508 ],
509 "workBreakdownStructure": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "costCenter": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "profitCenter": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "validTo": "2019-08-24",
529 "erpSystemId": 0,
530 "erpSystemDisplayId": "string"
531 },
532 "functionalArea": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "businessArea": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0
545 },
546 "segment": {
547 "id": 0,
548 "displayId": "string",
549 "status": "CREATED",
550 "name": "string",
551 "erpSystemId": 0
552 },
553 "network": {
554 "id": 0,
555 "displayId": "string",
556 "status": "CREATED",
557 "name": "string",
558 "erpSystemId": 0
559 },
560 "internalOrderType": {
561 "id": 0,
562 "displayId": "string",
563 "status": "CREATED",
564 "name": "string",
565 "erpSystemId": 0
566 },
567 "internalOrder": {
568 "id": 0,
569 "displayId": "string",
570 "status": "CREATED",
571 "name": "string",
572 "erpSystemId": 0,
573 "internalOrderTypeId": 0
574 },
575 "additionalCurrencies": [
576 {
577 "id": 0,
578 "amount": 0,
579 "currency": {
580 "id": 0,
581 "displayId": "string",
582 "status": "CREATED",
583 "name": "string",
584 "decimalPoints": 0
585 },
586 "conversionRate": 0,
587 "conversionDate": "2019-08-24",
588 "translationDateType": "DOCUMENT_DATE",
589 "amountType": "NET_AMOUNT",
590 "currencyDefinitionType": "CONTRACT_CURRENCY",
591 "invoiceEntryId": 0,
592 "invoiceEntryDisplayId": "string"
593 }
594 ],
595 "scheduledPaymentMatches": [
596 {
597 "id": 0,
598 "fromId": 0,
599 "toId": 0,
600 "amount": 0
601 }
602 ],
603 "goodsReceiptLineItemLinks": [
604 {
605 "id": 0,
606 "fromId": 0,
607 "toId": 0,
608 "linkedQuantity": 0
609 }
610 ],
611 "invoiceId": 0,
612 "invoiceDisplayId": "string",
613 "invoiceState": "INV_DRAFT",
614 "vendorPaymentId": 0,
615 "purchaseOrderLineItemId": 0,
616 "netAmount": 0,
617 "allowsSystemGenerateNewId": true,
618 "numberRangeIdentifierValue": "string",
619 "numberRangeIdentifierType": {
620 "name": "string"
621 },
622 "numberRangeType": {
623 "name": "string"
624 }
625 }
626 ],
627 "goodsReceiptLineItems": [
628 {
629 "id": 0,
630 "displayId": "string",
631 "quantity": 0,
632 "invoicedQuantity": 0,
633 "description": "string",
634 "expenseCategory": {
635 "id": 0,
636 "displayId": "string",
637 "status": "CREATED",
638 "name": "string",
639 "expenseCategoryType": "PAYMENT"
640 },
641 "goodsReceiptId": 0,
642 "goodsReceiptDisplayId": "string",
643 "goodsReceiptState": "INV_DRAFT",
644 "purchaseOrderLineItemId": 0,
645 "invoiceLineItemLinks": [
646 {
647 "id": 0,
648 "fromId": 0,
649 "toId": 0,
650 "linkedQuantity": 0
651 }
652 ],
653 "allowsSystemGenerateNewId": true,
654 "numberRangeIdentifierValue": "string",
655 "numberRangeIdentifierType": {
656 "name": "string"
657 },
658 "numberRangeType": {
659 "name": "string"
660 }
661 }
662 ],
663 "vendorPaymentId": 0,
664 "purchaseRequisitionLineItemId": 0,
665 "purchaseRequisitionDisplayId": "string",
666 "purchaseRequisitionLineItemAvailableQuantity": 0,
667 "allowsSystemGenerateNewId": true,
668 "numberRangeIdentifierValue": "string",
669 "numberRangeIdentifierType": {
670 "name": "string"
671 },
672 "numberRangeType": {
673 "name": "string"
674 }
675 }
676 ],
677 "purchaseRequisitionIds": [
678 0
679 ],
680 "purchaseRequisitionDisplayIds": [
681 "string"
682 ],
683 "invoices": [
684 {
685 "id": 0,
686 "displayId": "string",
687 "name": "string",
688 "invoiceType": "VENDOR_INV",
689 "state": "INV_DRAFT",
690 "externalDocumentNumber": "string",
691 "purchaseOrderReference": "string",
692 "invoiceDate": "2019-08-24",
693 "dueDate": "2019-08-24",
694 "notes": "string",
695 "billingPeriodFromDate": "2019-08-24",
696 "billingPeriodToDate": "2019-08-24",
697 "currency": {
698 "id": 0,
699 "displayId": "string",
700 "status": "CREATED",
701 "name": "string",
702 "decimalPoints": 0
703 },
704 "vendor": {
705 "id": 0,
706 "displayId": "string",
707 "status": "CREATED",
708 "name": "string",
709 "erpSystemDisplayId": "string"
710 },
711 "company": {
712 "id": 0,
713 "displayId": "string",
714 "status": "CREATED",
715 "erpSystemId": 0,
716 "erpSystemDisplayId": "string",
717 "countryId": 0,
718 "countryDisplayId": "string",
719 "name": "string",
720 "postingPeriodVariantId": 0,
721 "fiscalVariantId": 0
722 },
723 "netAmount": 0,
724 "taxAmount": 0,
725 "totalAmount": 0,
726 "netAmountBalance": 0,
727 "taxAmountBalance": 0,
728 "paymentTerm": {
729 "id": 0,
730 "displayId": "string",
731 "status": "CREATED",
732 "name": "string"
733 },
734 "paymentMethod": {
735 "id": 0,
736 "displayId": "string",
737 "status": "CREATED",
738 "name": "string",
739 "type": "string"
740 },
741 "paymentBlock": {
742 "id": 0,
743 "displayId": "string",
744 "status": "CREATED",
745 "name": "string"
746 },
747 "defaultCostCenter": {
748 "id": 0,
749 "displayId": "string",
750 "status": "CREATED",
751 "name": "string",
752 "erpSystemId": 0
753 },
754 "defaultProfitCenter": {
755 "id": 0,
756 "displayId": "string",
757 "status": "CREATED",
758 "name": "string",
759 "validTo": "2019-08-24",
760 "erpSystemId": 0,
761 "erpSystemDisplayId": "string"
762 },
763 "invoiceLineItems": [
764 {
765 "id": 0,
766 "displayId": "string",
767 "expenseCategory": {
768 "id": 0,
769 "displayId": "string",
770 "status": "CREATED",
771 "name": "string",
772 "expenseCategoryType": "PAYMENT"
773 },
774 "description": "string",
775 "unitOfMeasure": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "erpSystemId": 0
781 },
782 "quantity": 0,
783 "unitPrice": 0,
784 "taxJurisdiction": {
785 "id": 0,
786 "displayId": "string",
787 "status": "CREATED",
788 "name": "string",
789 "erpSystemId": 0,
790 "schema": "string",
791 "countryDisplayId": "string"
792 },
793 "taxCode": {
794 "id": 0,
795 "displayId": "string",
796 "status": "CREATED",
797 "name": "string",
798 "erpSystemId": 0
799 },
800 "taxExpenseAccount": {
801 "id": 0,
802 "displayId": "string",
803 "generalLedgerAccountName": "string",
804 "generalLedgerAccountCode": "string",
805 "openItemManagement": true,
806 "accountCategory": "BALANCESHEET",
807 "shortName": "string",
808 "longName": "string"
809 },
810 "taxLineItems": [
811 {
812 "id": 0,
813 "taxRate": 0.1,
814 "taxAmount": 0,
815 "taxType": "string",
816 "invoiceLineItemId": 0
817 }
818 ],
819 "workBreakdownStructure": {
820 "id": 0,
821 "displayId": "string",
822 "status": "CREATED",
823 "name": "string",
824 "erpSystemId": 0
825 },
826 "costCenter": {
827 "id": 0,
828 "displayId": "string",
829 "status": "CREATED",
830 "name": "string",
831 "erpSystemId": 0
832 },
833 "profitCenter": {
834 "id": 0,
835 "displayId": "string",
836 "status": "CREATED",
837 "name": "string",
838 "validTo": "2019-08-24",
839 "erpSystemId": 0,
840 "erpSystemDisplayId": "string"
841 },
842 "functionalArea": {
843 "id": 0,
844 "displayId": "string",
845 "status": "CREATED",
846 "name": "string",
847 "erpSystemId": 0
848 },
849 "businessArea": {
850 "id": 0,
851 "displayId": "string",
852 "status": "CREATED",
853 "name": "string",
854 "erpSystemId": 0
855 },
856 "segment": {
857 "id": 0,
858 "displayId": "string",
859 "status": "CREATED",
860 "name": "string",
861 "erpSystemId": 0
862 },
863 "network": {
864 "id": 0,
865 "displayId": "string",
866 "status": "CREATED",
867 "name": "string",
868 "erpSystemId": 0
869 },
870 "internalOrderType": {
871 "id": 0,
872 "displayId": "string",
873 "status": "CREATED",
874 "name": "string",
875 "erpSystemId": 0
876 },
877 "internalOrder": {
878 "id": 0,
879 "displayId": "string",
880 "status": "CREATED",
881 "name": "string",
882 "erpSystemId": 0,
883 "internalOrderTypeId": 0
884 },
885 "additionalCurrencies": [
886 {
887 "id": 0,
888 "amount": 0,
889 "currency": {
890 "id": 0,
891 "displayId": "string",
892 "status": "CREATED",
893 "name": "string",
894 "decimalPoints": 0
895 },
896 "conversionRate": 0,
897 "conversionDate": "2019-08-24",
898 "translationDateType": "DOCUMENT_DATE",
899 "amountType": "NET_AMOUNT",
900 "currencyDefinitionType": "CONTRACT_CURRENCY",
901 "invoiceEntryId": 0,
902 "invoiceEntryDisplayId": "string"
903 }
904 ],
905 "scheduledPaymentMatches": [
906 {
907 "id": 0,
908 "fromId": 0,
909 "toId": 0,
910 "amount": 0
911 }
912 ],
913 "goodsReceiptLineItemLinks": [
914 {
915 "id": 0,
916 "fromId": 0,
917 "toId": 0,
918 "linkedQuantity": 0
919 }
920 ],
921 "invoiceId": 0,
922 "invoiceDisplayId": "string",
923 "invoiceState": "INV_DRAFT",
924 "vendorPaymentId": 0,
925 "purchaseOrderLineItemId": 0,
926 "netAmount": 0,
927 "allowsSystemGenerateNewId": true,
928 "numberRangeIdentifierValue": "string",
929 "numberRangeIdentifierType": {
930 "name": "string"
931 },
932 "numberRangeType": {
933 "name": "string"
934 }
935 }
936 ],
937 "workspaceId": 0,
938 "workspaceDisplayId": "string",
939 "workspaceName": "string",
940 "workspaceState": "INV_DRAFT",
941 "remainingNetAmount": 0,
942 "remainingTaxAmount": 0,
943 "remainingTotalAmount": 0,
944 "pendingPaymentCount": 0,
945 "allPaymentsPosted": true,
946 "approvalInfo": {
947 "approverUsername": "string",
948 "approvedAt": "2019-08-24T14:15:22Z"
949 },
950 "rejectionReason": "string",
951 "allowsSystemGenerateNewId": true,
952 "numberRangeIdentifierValue": "string",
953 "numberRangeIdentifierType": {
954 "name": "string"
955 },
956 "numberRangeType": {
957 "name": "string"
958 }
959 }
960 ],
961 "rejectionReason": "string",
962 "allowsSystemGenerateNewId": true,
963 "numberRangeIdentifierValue": "string",
964 "numberRangeIdentifierType": {
965 "name": "string"
966 },
967 "numberRangeType": {
968 "name": "string"
969 }
970 }
971 ],
972 "approvalInfo": {
973 "approverUsername": "string",
974 "approvedAt": "2019-08-24T14:15:22Z"
975 },
976 "rejectionReason": "string",
977 "allowsSystemGenerateNewId": true,
978 "numberRangeIdentifierValue": "string",
979 "numberRangeIdentifierType": {
980 "name": "string"
981 },
982 "numberRangeType": {
983 "name": "string"
984 }
985}
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 "shippingAddress": "string",
18 "state": "INV_DRAFT",
19 "notes": "string",
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 "totalAmount": 0,
40 "purchaseRequisitionItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
72 "purchaseRequisitionDisplayId": "string",
73 "purchaseOrderLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "quantity": 0,
78 "allocatedQuantity": 0,
79 "receivedQuantity": 0,
80 "unitPrice": 0,
81 "description": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "costCenter": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0
95 },
96 "profitCenter": {
97 "id": 0,
98 "displayId": "string",
99 "status": "CREATED",
100 "name": "string",
101 "validTo": "2019-08-24",
102 "erpSystemId": 0,
103 "erpSystemDisplayId": "string"
104 },
105 "taxJurisdiction": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0,
111 "schema": "string",
112 "countryDisplayId": "string"
113 },
114 "taxCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "purchaseOrderLineItemId": 0
128 }
129 ],
130 "purchaseOrderId": 0,
131 "purchaseOrderDisplayId": "string",
132 "purchaseOrderState": "INV_DRAFT",
133 "invoiceLineItems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "expenseCategory": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "expenseCategoryType": "PAYMENT"
143 },
144 "description": "string",
145 "unitOfMeasure": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string",
150 "erpSystemId": 0
151 },
152 "quantity": 0,
153 "unitPrice": 0,
154 "taxJurisdiction": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0,
160 "schema": "string",
161 "countryDisplayId": "string"
162 },
163 "taxCode": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "taxExpenseAccount": {
171 "id": 0,
172 "displayId": "string",
173 "generalLedgerAccountName": "string",
174 "generalLedgerAccountCode": "string",
175 "openItemManagement": true,
176 "accountCategory": "BALANCESHEET",
177 "shortName": "string",
178 "longName": "string"
179 },
180 "taxLineItems": [
181 {
182 "id": 0,
183 "taxRate": 0.1,
184 "taxAmount": 0,
185 "taxType": "string",
186 "invoiceLineItemId": 0
187 }
188 ],
189 "workBreakdownStructure": {
190 "id": 0,
191 "displayId": "string",
192 "status": "CREATED",
193 "name": "string",
194 "erpSystemId": 0
195 },
196 "costCenter": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "profitCenter": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "validTo": "2019-08-24",
209 "erpSystemId": 0,
210 "erpSystemDisplayId": "string"
211 },
212 "functionalArea": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "businessArea": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "segment": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0
232 },
233 "network": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "erpSystemId": 0
239 },
240 "internalOrderType": {
241 "id": 0,
242 "displayId": "string",
243 "status": "CREATED",
244 "name": "string",
245 "erpSystemId": 0
246 },
247 "internalOrder": {
248 "id": 0,
249 "displayId": "string",
250 "status": "CREATED",
251 "name": "string",
252 "erpSystemId": 0,
253 "internalOrderTypeId": 0
254 },
255 "additionalCurrencies": [
256 {
257 "id": 0,
258 "amount": 0,
259 "currency": {},
260 "conversionRate": 0,
261 "conversionDate": "2019-08-24",
262 "translationDateType": "DOCUMENT_DATE",
263 "amountType": "NET_AMOUNT",
264 "currencyDefinitionType": "CONTRACT_CURRENCY",
265 "invoiceEntryId": 0,
266 "invoiceEntryDisplayId": "string"
267 }
268 ],
269 "scheduledPaymentMatches": [
270 {
271 "id": 0,
272 "fromId": 0,
273 "toId": 0,
274 "amount": 0
275 }
276 ],
277 "goodsReceiptLineItemLinks": [
278 {
279 "id": 0,
280 "fromId": 0,
281 "toId": 0,
282 "linkedQuantity": 0
283 }
284 ],
285 "invoiceId": 0,
286 "invoiceDisplayId": "string",
287 "invoiceState": "INV_DRAFT",
288 "vendorPaymentId": 0,
289 "purchaseOrderLineItemId": 0,
290 "netAmount": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ],
301 "goodsReceiptLineItems": [
302 {
303 "id": 0,
304 "displayId": "string",
305 "quantity": 0,
306 "invoicedQuantity": 0,
307 "description": "string",
308 "expenseCategory": {
309 "id": 0,
310 "displayId": "string",
311 "status": "CREATED",
312 "name": "string",
313 "expenseCategoryType": "PAYMENT"
314 },
315 "goodsReceiptId": 0,
316 "goodsReceiptDisplayId": "string",
317 "goodsReceiptState": "INV_DRAFT",
318 "purchaseOrderLineItemId": 0,
319 "invoiceLineItemLinks": [
320 {
321 "id": 0,
322 "fromId": 0,
323 "toId": 0,
324 "linkedQuantity": 0
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "vendorPaymentId": 0,
339 "purchaseRequisitionLineItemId": 0,
340 "purchaseRequisitionDisplayId": "string",
341 "purchaseRequisitionLineItemAvailableQuantity": 0,
342 "remainingQuantity": 0,
343 "availableQuantity": 0,
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "availableQuantity": 0,
355 "allowsSystemGenerateNewId": true,
356 "numberRangeIdentifierValue": "string",
357 "numberRangeIdentifierType": {
358 "name": "string"
359 },
360 "numberRangeType": {
361 "name": "string"
362 }
363 }
364 ],
365 "purchaseOrders": [
366 {
367 "id": 0,
368 "displayId": "string",
369 "state": "INV_DRAFT",
370 "issueDate": "2019-08-24",
371 "expectedDeliveryDate": "2019-08-24",
372 "name": "string",
373 "shippingAddress": "string",
374 "notes": "string",
375 "netAmount": 0,
376 "taxAmount": 0,
377 "externalPurchaseOrderDisplayId": "string",
378 "vendor": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "name": "string",
383 "erpSystemDisplayId": "string"
384 },
385 "currency": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "decimalPoints": 0
391 },
392 "company": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "erpSystemId": 0,
397 "erpSystemDisplayId": "string",
398 "countryId": 0,
399 "countryDisplayId": "string",
400 "name": "string",
401 "postingPeriodVariantId": 0,
402 "fiscalVariantId": 0
403 },
404 "purchaseOrderLineItems": [
405 {
406 "id": 0,
407 "displayId": "string",
408 "quantity": 0,
409 "allocatedQuantity": 0,
410 "receivedQuantity": 0,
411 "unitPrice": 0,
412 "description": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "costCenter": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0
426 },
427 "profitCenter": {
428 "id": 0,
429 "displayId": "string",
430 "status": "CREATED",
431 "name": "string",
432 "validTo": "2019-08-24",
433 "erpSystemId": 0,
434 "erpSystemDisplayId": "string"
435 },
436 "taxJurisdiction": {
437 "id": 0,
438 "displayId": "string",
439 "status": "CREATED",
440 "name": "string",
441 "erpSystemId": 0,
442 "schema": "string",
443 "countryDisplayId": "string"
444 },
445 "taxCode": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "taxLineItems": [
453 {
454 "id": 0,
455 "taxRate": 0.1,
456 "taxAmount": 0,
457 "taxType": "string",
458 "purchaseOrderLineItemId": 0
459 }
460 ],
461 "purchaseOrderId": 0,
462 "purchaseOrderDisplayId": "string",
463 "purchaseOrderState": "INV_DRAFT",
464 "invoiceLineItems": [
465 {
466 "id": 0,
467 "displayId": "string",
468 "expenseCategory": {
469 "id": 0,
470 "displayId": "string",
471 "status": "CREATED",
472 "name": "string",
473 "expenseCategoryType": "PAYMENT"
474 },
475 "description": "string",
476 "unitOfMeasure": {
477 "id": 0,
478 "displayId": "string",
479 "status": "CREATED",
480 "name": "string",
481 "erpSystemId": 0
482 },
483 "quantity": 0,
484 "unitPrice": 0,
485 "taxJurisdiction": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "erpSystemId": 0,
491 "schema": "string",
492 "countryDisplayId": "string"
493 },
494 "taxCode": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "taxExpenseAccount": {
502 "id": 0,
503 "displayId": "string",
504 "generalLedgerAccountName": "string",
505 "generalLedgerAccountCode": "string",
506 "openItemManagement": true,
507 "accountCategory": "BALANCESHEET",
508 "shortName": "string",
509 "longName": "string"
510 },
511 "taxLineItems": [
512 {
513 "id": 0,
514 "taxRate": 0.1,
515 "taxAmount": 0,
516 "taxType": "string",
517 "invoiceLineItemId": 0
518 }
519 ],
520 "workBreakdownStructure": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "costCenter": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "profitCenter": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "validTo": "2019-08-24",
540 "erpSystemId": 0,
541 "erpSystemDisplayId": "string"
542 },
543 "functionalArea": {
544 "id": 0,
545 "displayId": "string",
546 "status": "CREATED",
547 "name": "string",
548 "erpSystemId": 0
549 },
550 "businessArea": {
551 "id": 0,
552 "displayId": "string",
553 "status": "CREATED",
554 "name": "string",
555 "erpSystemId": 0
556 },
557 "segment": {
558 "id": 0,
559 "displayId": "string",
560 "status": "CREATED",
561 "name": "string",
562 "erpSystemId": 0
563 },
564 "network": {
565 "id": 0,
566 "displayId": "string",
567 "status": "CREATED",
568 "name": "string",
569 "erpSystemId": 0
570 },
571 "internalOrderType": {
572 "id": 0,
573 "displayId": "string",
574 "status": "CREATED",
575 "name": "string",
576 "erpSystemId": 0
577 },
578 "internalOrder": {
579 "id": 0,
580 "displayId": "string",
581 "status": "CREATED",
582 "name": "string",
583 "erpSystemId": 0,
584 "internalOrderTypeId": 0
585 },
586 "additionalCurrencies": [
587 {
588 "id": 0,
589 "amount": 0,
590 "currency": {},
591 "conversionRate": 0,
592 "conversionDate": "2019-08-24",
593 "translationDateType": "DOCUMENT_DATE",
594 "amountType": "NET_AMOUNT",
595 "currencyDefinitionType": "CONTRACT_CURRENCY",
596 "invoiceEntryId": 0,
597 "invoiceEntryDisplayId": "string"
598 }
599 ],
600 "scheduledPaymentMatches": [
601 {
602 "id": 0,
603 "fromId": 0,
604 "toId": 0,
605 "amount": 0
606 }
607 ],
608 "goodsReceiptLineItemLinks": [
609 {
610 "id": 0,
611 "fromId": 0,
612 "toId": 0,
613 "linkedQuantity": 0
614 }
615 ],
616 "invoiceId": 0,
617 "invoiceDisplayId": "string",
618 "invoiceState": "INV_DRAFT",
619 "vendorPaymentId": 0,
620 "purchaseOrderLineItemId": 0,
621 "netAmount": 0,
622 "allowsSystemGenerateNewId": true,
623 "numberRangeIdentifierValue": "string",
624 "numberRangeIdentifierType": {
625 "name": "string"
626 },
627 "numberRangeType": {
628 "name": "string"
629 }
630 }
631 ],
632 "goodsReceiptLineItems": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "quantity": 0,
637 "invoicedQuantity": 0,
638 "description": "string",
639 "expenseCategory": {
640 "id": 0,
641 "displayId": "string",
642 "status": "CREATED",
643 "name": "string",
644 "expenseCategoryType": "PAYMENT"
645 },
646 "goodsReceiptId": 0,
647 "goodsReceiptDisplayId": "string",
648 "goodsReceiptState": "INV_DRAFT",
649 "purchaseOrderLineItemId": 0,
650 "invoiceLineItemLinks": [
651 {
652 "id": 0,
653 "fromId": 0,
654 "toId": 0,
655 "linkedQuantity": 0
656 }
657 ],
658 "availableQuantity": 0,
659 "allowsSystemGenerateNewId": true,
660 "numberRangeIdentifierValue": "string",
661 "numberRangeIdentifierType": {
662 "name": "string"
663 },
664 "numberRangeType": {
665 "name": "string"
666 }
667 }
668 ],
669 "vendorPaymentId": 0,
670 "purchaseRequisitionLineItemId": 0,
671 "purchaseRequisitionDisplayId": "string",
672 "purchaseRequisitionLineItemAvailableQuantity": 0,
673 "remainingQuantity": 0,
674 "availableQuantity": 0,
675 "allowsSystemGenerateNewId": true,
676 "numberRangeIdentifierValue": "string",
677 "numberRangeIdentifierType": {
678 "name": "string"
679 },
680 "numberRangeType": {
681 "name": "string"
682 }
683 }
684 ],
685 "purchaseRequisitionIds": [
686 0
687 ],
688 "purchaseRequisitionDisplayIds": [
689 "string"
690 ],
691 "invoices": [
692 {
693 "id": 0,
694 "displayId": "string",
695 "name": "string",
696 "invoiceType": "VENDOR_INV",
697 "state": "INV_DRAFT",
698 "externalDocumentNumber": "string",
699 "purchaseOrderReference": "string",
700 "invoiceDate": "2019-08-24",
701 "dueDate": "2019-08-24",
702 "notes": "string",
703 "billingPeriodFromDate": "2019-08-24",
704 "billingPeriodToDate": "2019-08-24",
705 "currency": {
706 "id": 0,
707 "displayId": "string",
708 "status": "CREATED",
709 "name": "string",
710 "decimalPoints": 0
711 },
712 "vendor": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "erpSystemDisplayId": "string"
718 },
719 "company": {
720 "id": 0,
721 "displayId": "string",
722 "status": "CREATED",
723 "erpSystemId": 0,
724 "erpSystemDisplayId": "string",
725 "countryId": 0,
726 "countryDisplayId": "string",
727 "name": "string",
728 "postingPeriodVariantId": 0,
729 "fiscalVariantId": 0
730 },
731 "netAmount": 0,
732 "taxAmount": 0,
733 "totalAmount": 0,
734 "netAmountBalance": 0,
735 "taxAmountBalance": 0,
736 "paymentTerm": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string"
741 },
742 "paymentMethod": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "type": "string"
748 },
749 "paymentBlock": {
750 "id": 0,
751 "displayId": "string",
752 "status": "CREATED",
753 "name": "string"
754 },
755 "defaultCostCenter": {
756 "id": 0,
757 "displayId": "string",
758 "status": "CREATED",
759 "name": "string",
760 "erpSystemId": 0
761 },
762 "defaultProfitCenter": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "validTo": "2019-08-24",
768 "erpSystemId": 0,
769 "erpSystemDisplayId": "string"
770 },
771 "invoiceLineItems": [
772 {
773 "id": 0,
774 "displayId": "string",
775 "expenseCategory": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "expenseCategoryType": "PAYMENT"
781 },
782 "description": "string",
783 "unitOfMeasure": {
784 "id": 0,
785 "displayId": "string",
786 "status": "CREATED",
787 "name": "string",
788 "erpSystemId": 0
789 },
790 "quantity": 0,
791 "unitPrice": 0,
792 "taxJurisdiction": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0,
798 "schema": "string",
799 "countryDisplayId": "string"
800 },
801 "taxCode": {
802 "id": 0,
803 "displayId": "string",
804 "status": "CREATED",
805 "name": "string",
806 "erpSystemId": 0
807 },
808 "taxExpenseAccount": {
809 "id": 0,
810 "displayId": "string",
811 "generalLedgerAccountName": "string",
812 "generalLedgerAccountCode": "string",
813 "openItemManagement": true,
814 "accountCategory": "BALANCESHEET",
815 "shortName": "string",
816 "longName": "string"
817 },
818 "taxLineItems": [
819 {
820 "id": 0,
821 "taxRate": 0.1,
822 "taxAmount": 0,
823 "taxType": "string",
824 "invoiceLineItemId": 0
825 }
826 ],
827 "workBreakdownStructure": {
828 "id": 0,
829 "displayId": "string",
830 "status": "CREATED",
831 "name": "string",
832 "erpSystemId": 0
833 },
834 "costCenter": {
835 "id": 0,
836 "displayId": "string",
837 "status": "CREATED",
838 "name": "string",
839 "erpSystemId": 0
840 },
841 "profitCenter": {
842 "id": 0,
843 "displayId": "string",
844 "status": "CREATED",
845 "name": "string",
846 "validTo": "2019-08-24",
847 "erpSystemId": 0,
848 "erpSystemDisplayId": "string"
849 },
850 "functionalArea": {
851 "id": 0,
852 "displayId": "string",
853 "status": "CREATED",
854 "name": "string",
855 "erpSystemId": 0
856 },
857 "businessArea": {
858 "id": 0,
859 "displayId": "string",
860 "status": "CREATED",
861 "name": "string",
862 "erpSystemId": 0
863 },
864 "segment": {
865 "id": 0,
866 "displayId": "string",
867 "status": "CREATED",
868 "name": "string",
869 "erpSystemId": 0
870 },
871 "network": {
872 "id": 0,
873 "displayId": "string",
874 "status": "CREATED",
875 "name": "string",
876 "erpSystemId": 0
877 },
878 "internalOrderType": {
879 "id": 0,
880 "displayId": "string",
881 "status": "CREATED",
882 "name": "string",
883 "erpSystemId": 0
884 },
885 "internalOrder": {
886 "id": 0,
887 "displayId": "string",
888 "status": "CREATED",
889 "name": "string",
890 "erpSystemId": 0,
891 "internalOrderTypeId": 0
892 },
893 "additionalCurrencies": [
894 {
895 "id": 0,
896 "amount": 0,
897 "currency": {},
898 "conversionRate": 0,
899 "conversionDate": "2019-08-24",
900 "translationDateType": "DOCUMENT_DATE",
901 "amountType": "NET_AMOUNT",
902 "currencyDefinitionType": "CONTRACT_CURRENCY",
903 "invoiceEntryId": 0,
904 "invoiceEntryDisplayId": "string"
905 }
906 ],
907 "scheduledPaymentMatches": [
908 {
909 "id": 0,
910 "fromId": 0,
911 "toId": 0,
912 "amount": 0
913 }
914 ],
915 "goodsReceiptLineItemLinks": [
916 {
917 "id": 0,
918 "fromId": 0,
919 "toId": 0,
920 "linkedQuantity": 0
921 }
922 ],
923 "invoiceId": 0,
924 "invoiceDisplayId": "string",
925 "invoiceState": "INV_DRAFT",
926 "vendorPaymentId": 0,
927 "purchaseOrderLineItemId": 0,
928 "netAmount": 0,
929 "allowsSystemGenerateNewId": true,
930 "numberRangeIdentifierValue": "string",
931 "numberRangeIdentifierType": {
932 "name": "string"
933 },
934 "numberRangeType": {
935 "name": "string"
936 }
937 }
938 ],
939 "workspaceId": 0,
940 "workspaceDisplayId": "string",
941 "workspaceName": "string",
942 "workspaceState": "INV_DRAFT",
943 "remainingNetAmount": 0,
944 "remainingTaxAmount": 0,
945 "remainingTotalAmount": 0,
946 "pendingPaymentCount": 0,
947 "allPaymentsPosted": true,
948 "approvalInfo": {
949 "approverUsername": "string",
950 "approvedAt": "2019-08-24T14:15:22Z"
951 },
952 "rejectionReason": "string",
953 "allowsSystemGenerateNewId": true,
954 "numberRangeIdentifierValue": "string",
955 "numberRangeIdentifierType": {
956 "name": "string"
957 },
958 "numberRangeType": {
959 "name": "string"
960 }
961 }
962 ],
963 "rejectionReason": "string",
964 "allowsSystemGenerateNewId": true,
965 "numberRangeIdentifierValue": "string",
966 "numberRangeIdentifierType": {
967 "name": "string"
968 },
969 "numberRangeType": {
970 "name": "string"
971 }
972 }
973 ],
974 "approvalInfo": {
975 "approverUsername": "string",
976 "approvedAt": "2019-08-24T14:15:22Z"
977 },
978 "rejectionReason": "string",
979 "allowsSystemGenerateNewId": true,
980 "numberRangeIdentifierValue": "string",
981 "numberRangeIdentifierType": {
982 "name": "string"
983 },
984 "numberRangeType": {
985 "name": "string"
986 }
987 }
988}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/purchase-requisition/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 requisition objects, each including details such as item descriptions, quantities, and associated cost centers for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "shippingAddress": "string",
6 "state": "INV_DRAFT",
7 "notes": "string",
8 "currency": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string",
13 "decimalPoints": 0
14 },
15 "company": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "name": "string",
24 "postingPeriodVariantId": 0,
25 "fiscalVariantId": 0
26 },
27 "totalAmount": 0,
28 "purchaseRequisitionItems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "quantity": 0,
33 "allocatedQuantity": 0,
34 "unitPrice": 0,
35 "description": "string",
36 "expenseCategory": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "expenseCategoryType": "PAYMENT"
42 },
43 "costCenter": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "profitCenter": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "validTo": "2019-08-24",
56 "erpSystemId": 0,
57 "erpSystemDisplayId": "string"
58 },
59 "purchaseRequisitionId": 0,
60 "purchaseRequisitionDisplayId": "string",
61 "purchaseOrderLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "quantity": 0,
66 "allocatedQuantity": 0,
67 "receivedQuantity": 0,
68 "unitPrice": 0,
69 "description": "string",
70 "expenseCategory": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "expenseCategoryType": "PAYMENT"
76 },
77 "costCenter": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "erpSystemId": 0
83 },
84 "profitCenter": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "validTo": "2019-08-24",
90 "erpSystemId": 0,
91 "erpSystemDisplayId": "string"
92 },
93 "taxJurisdiction": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0,
99 "schema": "string",
100 "countryDisplayId": "string"
101 },
102 "taxCode": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "erpSystemId": 0
108 },
109 "taxLineItems": [
110 {
111 "id": 0,
112 "taxRate": 0.1,
113 "taxAmount": 0,
114 "taxType": "string",
115 "purchaseOrderLineItemId": 0
116 }
117 ],
118 "purchaseOrderId": 0,
119 "purchaseOrderDisplayId": "string",
120 "purchaseOrderState": "INV_DRAFT",
121 "invoiceLineItems": [
122 {
123 "id": 0,
124 "displayId": "string",
125 "expenseCategory": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "expenseCategoryType": "PAYMENT"
131 },
132 "description": "string",
133 "unitOfMeasure": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0
139 },
140 "quantity": 0,
141 "unitPrice": 0,
142 "taxJurisdiction": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0,
148 "schema": "string",
149 "countryDisplayId": "string"
150 },
151 "taxCode": {
152 "id": 0,
153 "displayId": "string",
154 "status": "CREATED",
155 "name": "string",
156 "erpSystemId": 0
157 },
158 "taxExpenseAccount": {
159 "id": 0,
160 "displayId": "string",
161 "generalLedgerAccountName": "string",
162 "generalLedgerAccountCode": "string",
163 "openItemManagement": true,
164 "accountCategory": "BALANCESHEET",
165 "shortName": "string",
166 "longName": "string"
167 },
168 "taxLineItems": [
169 {
170 "id": 0,
171 "taxRate": 0.1,
172 "taxAmount": 0,
173 "taxType": "string",
174 "invoiceLineItemId": 0
175 }
176 ],
177 "workBreakdownStructure": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "erpSystemId": 0
183 },
184 "costCenter": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "profitCenter": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "validTo": "2019-08-24",
197 "erpSystemId": 0,
198 "erpSystemDisplayId": "string"
199 },
200 "functionalArea": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "businessArea": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "segment": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "network": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0
227 },
228 "internalOrderType": {
229 "id": 0,
230 "displayId": "string",
231 "status": "CREATED",
232 "name": "string",
233 "erpSystemId": 0
234 },
235 "internalOrder": {
236 "id": 0,
237 "displayId": "string",
238 "status": "CREATED",
239 "name": "string",
240 "erpSystemId": 0,
241 "internalOrderTypeId": 0
242 },
243 "additionalCurrencies": [
244 {
245 "id": 0,
246 "amount": 0,
247 "currency": {},
248 "conversionRate": 0,
249 "conversionDate": "2019-08-24",
250 "translationDateType": "DOCUMENT_DATE",
251 "amountType": "NET_AMOUNT",
252 "currencyDefinitionType": "CONTRACT_CURRENCY",
253 "invoiceEntryId": 0,
254 "invoiceEntryDisplayId": "string"
255 }
256 ],
257 "scheduledPaymentMatches": [
258 {
259 "id": 0,
260 "fromId": 0,
261 "toId": 0,
262 "amount": 0
263 }
264 ],
265 "goodsReceiptLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "invoiceId": 0,
274 "invoiceDisplayId": "string",
275 "invoiceState": "INV_DRAFT",
276 "vendorPaymentId": 0,
277 "purchaseOrderLineItemId": 0,
278 "netAmount": 0,
279 "allowsSystemGenerateNewId": true,
280 "numberRangeIdentifierValue": "string",
281 "numberRangeIdentifierType": {
282 "name": "string"
283 },
284 "numberRangeType": {
285 "name": "string"
286 }
287 }
288 ],
289 "goodsReceiptLineItems": [
290 {
291 "id": 0,
292 "displayId": "string",
293 "quantity": 0,
294 "invoicedQuantity": 0,
295 "description": "string",
296 "expenseCategory": {
297 "id": 0,
298 "displayId": "string",
299 "status": "CREATED",
300 "name": "string",
301 "expenseCategoryType": "PAYMENT"
302 },
303 "goodsReceiptId": 0,
304 "goodsReceiptDisplayId": "string",
305 "goodsReceiptState": "INV_DRAFT",
306 "purchaseOrderLineItemId": 0,
307 "invoiceLineItemLinks": [
308 {
309 "id": 0,
310 "fromId": 0,
311 "toId": 0,
312 "linkedQuantity": 0
313 }
314 ],
315 "allowsSystemGenerateNewId": true,
316 "numberRangeIdentifierValue": "string",
317 "numberRangeIdentifierType": {
318 "name": "string"
319 },
320 "numberRangeType": {
321 "name": "string"
322 }
323 }
324 ],
325 "vendorPaymentId": 0,
326 "purchaseRequisitionLineItemId": 0,
327 "purchaseRequisitionDisplayId": "string",
328 "purchaseRequisitionLineItemAvailableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "allowsSystemGenerateNewId": true,
340 "numberRangeIdentifierValue": "string",
341 "numberRangeIdentifierType": {
342 "name": "string"
343 },
344 "numberRangeType": {
345 "name": "string"
346 }
347 }
348 ],
349 "purchaseOrders": [
350 {
351 "id": 0,
352 "displayId": "string",
353 "state": "INV_DRAFT",
354 "issueDate": "2019-08-24",
355 "expectedDeliveryDate": "2019-08-24",
356 "name": "string",
357 "shippingAddress": "string",
358 "notes": "string",
359 "netAmount": 0,
360 "taxAmount": 0,
361 "externalPurchaseOrderDisplayId": "string",
362 "vendor": {
363 "id": 0,
364 "displayId": "string",
365 "status": "CREATED",
366 "name": "string",
367 "erpSystemDisplayId": "string"
368 },
369 "currency": {
370 "id": 0,
371 "displayId": "string",
372 "status": "CREATED",
373 "name": "string",
374 "decimalPoints": 0
375 },
376 "company": {
377 "id": 0,
378 "displayId": "string",
379 "status": "CREATED",
380 "erpSystemId": 0,
381 "erpSystemDisplayId": "string",
382 "countryId": 0,
383 "countryDisplayId": "string",
384 "name": "string",
385 "postingPeriodVariantId": 0,
386 "fiscalVariantId": 0
387 },
388 "purchaseOrderLineItems": [
389 {
390 "id": 0,
391 "displayId": "string",
392 "quantity": 0,
393 "allocatedQuantity": 0,
394 "receivedQuantity": 0,
395 "unitPrice": 0,
396 "description": "string",
397 "expenseCategory": {
398 "id": 0,
399 "displayId": "string",
400 "status": "CREATED",
401 "name": "string",
402 "expenseCategoryType": "PAYMENT"
403 },
404 "costCenter": {
405 "id": 0,
406 "displayId": "string",
407 "status": "CREATED",
408 "name": "string",
409 "erpSystemId": 0
410 },
411 "profitCenter": {
412 "id": 0,
413 "displayId": "string",
414 "status": "CREATED",
415 "name": "string",
416 "validTo": "2019-08-24",
417 "erpSystemId": 0,
418 "erpSystemDisplayId": "string"
419 },
420 "taxJurisdiction": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0,
426 "schema": "string",
427 "countryDisplayId": "string"
428 },
429 "taxCode": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "erpSystemId": 0
435 },
436 "taxLineItems": [
437 {
438 "id": 0,
439 "taxRate": 0.1,
440 "taxAmount": 0,
441 "taxType": "string",
442 "purchaseOrderLineItemId": 0
443 }
444 ],
445 "purchaseOrderId": 0,
446 "purchaseOrderDisplayId": "string",
447 "purchaseOrderState": "INV_DRAFT",
448 "invoiceLineItems": [
449 {
450 "id": 0,
451 "displayId": "string",
452 "expenseCategory": {
453 "id": 0,
454 "displayId": "string",
455 "status": "CREATED",
456 "name": "string",
457 "expenseCategoryType": "PAYMENT"
458 },
459 "description": "string",
460 "unitOfMeasure": {
461 "id": 0,
462 "displayId": "string",
463 "status": "CREATED",
464 "name": "string",
465 "erpSystemId": 0
466 },
467 "quantity": 0,
468 "unitPrice": 0,
469 "taxJurisdiction": {
470 "id": 0,
471 "displayId": "string",
472 "status": "CREATED",
473 "name": "string",
474 "erpSystemId": 0,
475 "schema": "string",
476 "countryDisplayId": "string"
477 },
478 "taxCode": {
479 "id": 0,
480 "displayId": "string",
481 "status": "CREATED",
482 "name": "string",
483 "erpSystemId": 0
484 },
485 "taxExpenseAccount": {
486 "id": 0,
487 "displayId": "string",
488 "generalLedgerAccountName": "string",
489 "generalLedgerAccountCode": "string",
490 "openItemManagement": true,
491 "accountCategory": "BALANCESHEET",
492 "shortName": "string",
493 "longName": "string"
494 },
495 "taxLineItems": [
496 {
497 "id": 0,
498 "taxRate": 0.1,
499 "taxAmount": 0,
500 "taxType": "string",
501 "invoiceLineItemId": 0
502 }
503 ],
504 "workBreakdownStructure": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "costCenter": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "profitCenter": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "validTo": "2019-08-24",
524 "erpSystemId": 0,
525 "erpSystemDisplayId": "string"
526 },
527 "functionalArea": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "businessArea": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "erpSystemId": 0
540 },
541 "segment": {
542 "id": 0,
543 "displayId": "string",
544 "status": "CREATED",
545 "name": "string",
546 "erpSystemId": 0
547 },
548 "network": {
549 "id": 0,
550 "displayId": "string",
551 "status": "CREATED",
552 "name": "string",
553 "erpSystemId": 0
554 },
555 "internalOrderType": {
556 "id": 0,
557 "displayId": "string",
558 "status": "CREATED",
559 "name": "string",
560 "erpSystemId": 0
561 },
562 "internalOrder": {
563 "id": 0,
564 "displayId": "string",
565 "status": "CREATED",
566 "name": "string",
567 "erpSystemId": 0,
568 "internalOrderTypeId": 0
569 },
570 "additionalCurrencies": [
571 {
572 "id": 0,
573 "amount": 0,
574 "currency": {},
575 "conversionRate": 0,
576 "conversionDate": "2019-08-24",
577 "translationDateType": "DOCUMENT_DATE",
578 "amountType": "NET_AMOUNT",
579 "currencyDefinitionType": "CONTRACT_CURRENCY",
580 "invoiceEntryId": 0,
581 "invoiceEntryDisplayId": "string"
582 }
583 ],
584 "scheduledPaymentMatches": [
585 {
586 "id": 0,
587 "fromId": 0,
588 "toId": 0,
589 "amount": 0
590 }
591 ],
592 "goodsReceiptLineItemLinks": [
593 {
594 "id": 0,
595 "fromId": 0,
596 "toId": 0,
597 "linkedQuantity": 0
598 }
599 ],
600 "invoiceId": 0,
601 "invoiceDisplayId": "string",
602 "invoiceState": "INV_DRAFT",
603 "vendorPaymentId": 0,
604 "purchaseOrderLineItemId": 0,
605 "netAmount": 0,
606 "allowsSystemGenerateNewId": true,
607 "numberRangeIdentifierValue": "string",
608 "numberRangeIdentifierType": {
609 "name": "string"
610 },
611 "numberRangeType": {
612 "name": "string"
613 }
614 }
615 ],
616 "goodsReceiptLineItems": [
617 {
618 "id": 0,
619 "displayId": "string",
620 "quantity": 0,
621 "invoicedQuantity": 0,
622 "description": "string",
623 "expenseCategory": {
624 "id": 0,
625 "displayId": "string",
626 "status": "CREATED",
627 "name": "string",
628 "expenseCategoryType": "PAYMENT"
629 },
630 "goodsReceiptId": 0,
631 "goodsReceiptDisplayId": "string",
632 "goodsReceiptState": "INV_DRAFT",
633 "purchaseOrderLineItemId": 0,
634 "invoiceLineItemLinks": [
635 {
636 "id": 0,
637 "fromId": 0,
638 "toId": 0,
639 "linkedQuantity": 0
640 }
641 ],
642 "allowsSystemGenerateNewId": true,
643 "numberRangeIdentifierValue": "string",
644 "numberRangeIdentifierType": {
645 "name": "string"
646 },
647 "numberRangeType": {
648 "name": "string"
649 }
650 }
651 ],
652 "vendorPaymentId": 0,
653 "purchaseRequisitionLineItemId": 0,
654 "purchaseRequisitionDisplayId": "string",
655 "purchaseRequisitionLineItemAvailableQuantity": 0,
656 "allowsSystemGenerateNewId": true,
657 "numberRangeIdentifierValue": "string",
658 "numberRangeIdentifierType": {
659 "name": "string"
660 },
661 "numberRangeType": {
662 "name": "string"
663 }
664 }
665 ],
666 "purchaseRequisitionIds": [
667 0
668 ],
669 "purchaseRequisitionDisplayIds": [
670 "string"
671 ],
672 "invoices": [
673 {
674 "id": 0,
675 "displayId": "string",
676 "name": "string",
677 "invoiceType": "VENDOR_INV",
678 "state": "INV_DRAFT",
679 "externalDocumentNumber": "string",
680 "purchaseOrderReference": "string",
681 "invoiceDate": "2019-08-24",
682 "dueDate": "2019-08-24",
683 "notes": "string",
684 "billingPeriodFromDate": "2019-08-24",
685 "billingPeriodToDate": "2019-08-24",
686 "currency": {
687 "id": 0,
688 "displayId": "string",
689 "status": "CREATED",
690 "name": "string",
691 "decimalPoints": 0
692 },
693 "vendor": {
694 "id": 0,
695 "displayId": "string",
696 "status": "CREATED",
697 "name": "string",
698 "erpSystemDisplayId": "string"
699 },
700 "company": {
701 "id": 0,
702 "displayId": "string",
703 "status": "CREATED",
704 "erpSystemId": 0,
705 "erpSystemDisplayId": "string",
706 "countryId": 0,
707 "countryDisplayId": "string",
708 "name": "string",
709 "postingPeriodVariantId": 0,
710 "fiscalVariantId": 0
711 },
712 "netAmount": 0,
713 "taxAmount": 0,
714 "totalAmount": 0,
715 "netAmountBalance": 0,
716 "taxAmountBalance": 0,
717 "paymentTerm": {
718 "id": 0,
719 "displayId": "string",
720 "status": "CREATED",
721 "name": "string"
722 },
723 "paymentMethod": {
724 "id": 0,
725 "displayId": "string",
726 "status": "CREATED",
727 "name": "string",
728 "type": "string"
729 },
730 "paymentBlock": {
731 "id": 0,
732 "displayId": "string",
733 "status": "CREATED",
734 "name": "string"
735 },
736 "defaultCostCenter": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string",
741 "erpSystemId": 0
742 },
743 "defaultProfitCenter": {
744 "id": 0,
745 "displayId": "string",
746 "status": "CREATED",
747 "name": "string",
748 "validTo": "2019-08-24",
749 "erpSystemId": 0,
750 "erpSystemDisplayId": "string"
751 },
752 "invoiceLineItems": [
753 {
754 "id": 0,
755 "displayId": "string",
756 "expenseCategory": {
757 "id": 0,
758 "displayId": "string",
759 "status": "CREATED",
760 "name": "string",
761 "expenseCategoryType": "PAYMENT"
762 },
763 "description": "string",
764 "unitOfMeasure": {
765 "id": 0,
766 "displayId": "string",
767 "status": "CREATED",
768 "name": "string",
769 "erpSystemId": 0
770 },
771 "quantity": 0,
772 "unitPrice": 0,
773 "taxJurisdiction": {
774 "id": 0,
775 "displayId": "string",
776 "status": "CREATED",
777 "name": "string",
778 "erpSystemId": 0,
779 "schema": "string",
780 "countryDisplayId": "string"
781 },
782 "taxCode": {
783 "id": 0,
784 "displayId": "string",
785 "status": "CREATED",
786 "name": "string",
787 "erpSystemId": 0
788 },
789 "taxExpenseAccount": {
790 "id": 0,
791 "displayId": "string",
792 "generalLedgerAccountName": "string",
793 "generalLedgerAccountCode": "string",
794 "openItemManagement": true,
795 "accountCategory": "BALANCESHEET",
796 "shortName": "string",
797 "longName": "string"
798 },
799 "taxLineItems": [
800 {
801 "id": 0,
802 "taxRate": 0.1,
803 "taxAmount": 0,
804 "taxType": "string",
805 "invoiceLineItemId": 0
806 }
807 ],
808 "workBreakdownStructure": {
809 "id": 0,
810 "displayId": "string",
811 "status": "CREATED",
812 "name": "string",
813 "erpSystemId": 0
814 },
815 "costCenter": {
816 "id": 0,
817 "displayId": "string",
818 "status": "CREATED",
819 "name": "string",
820 "erpSystemId": 0
821 },
822 "profitCenter": {
823 "id": 0,
824 "displayId": "string",
825 "status": "CREATED",
826 "name": "string",
827 "validTo": "2019-08-24",
828 "erpSystemId": 0,
829 "erpSystemDisplayId": "string"
830 },
831 "functionalArea": {
832 "id": 0,
833 "displayId": "string",
834 "status": "CREATED",
835 "name": "string",
836 "erpSystemId": 0
837 },
838 "businessArea": {
839 "id": 0,
840 "displayId": "string",
841 "status": "CREATED",
842 "name": "string",
843 "erpSystemId": 0
844 },
845 "segment": {
846 "id": 0,
847 "displayId": "string",
848 "status": "CREATED",
849 "name": "string",
850 "erpSystemId": 0
851 },
852 "network": {
853 "id": 0,
854 "displayId": "string",
855 "status": "CREATED",
856 "name": "string",
857 "erpSystemId": 0
858 },
859 "internalOrderType": {
860 "id": 0,
861 "displayId": "string",
862 "status": "CREATED",
863 "name": "string",
864 "erpSystemId": 0
865 },
866 "internalOrder": {
867 "id": 0,
868 "displayId": "string",
869 "status": "CREATED",
870 "name": "string",
871 "erpSystemId": 0,
872 "internalOrderTypeId": 0
873 },
874 "additionalCurrencies": [
875 {
876 "id": 0,
877 "amount": 0,
878 "currency": {},
879 "conversionRate": 0,
880 "conversionDate": "2019-08-24",
881 "translationDateType": "DOCUMENT_DATE",
882 "amountType": "NET_AMOUNT",
883 "currencyDefinitionType": "CONTRACT_CURRENCY",
884 "invoiceEntryId": 0,
885 "invoiceEntryDisplayId": "string"
886 }
887 ],
888 "scheduledPaymentMatches": [
889 {
890 "id": 0,
891 "fromId": 0,
892 "toId": 0,
893 "amount": 0
894 }
895 ],
896 "goodsReceiptLineItemLinks": [
897 {
898 "id": 0,
899 "fromId": 0,
900 "toId": 0,
901 "linkedQuantity": 0
902 }
903 ],
904 "invoiceId": 0,
905 "invoiceDisplayId": "string",
906 "invoiceState": "INV_DRAFT",
907 "vendorPaymentId": 0,
908 "purchaseOrderLineItemId": 0,
909 "netAmount": 0,
910 "allowsSystemGenerateNewId": true,
911 "numberRangeIdentifierValue": "string",
912 "numberRangeIdentifierType": {
913 "name": "string"
914 },
915 "numberRangeType": {
916 "name": "string"
917 }
918 }
919 ],
920 "workspaceId": 0,
921 "workspaceDisplayId": "string",
922 "workspaceName": "string",
923 "workspaceState": "INV_DRAFT",
924 "remainingNetAmount": 0,
925 "remainingTaxAmount": 0,
926 "remainingTotalAmount": 0,
927 "pendingPaymentCount": 0,
928 "allPaymentsPosted": true,
929 "approvalInfo": {
930 "approverUsername": "string",
931 "approvedAt": "2019-08-24T14:15:22Z"
932 },
933 "rejectionReason": "string",
934 "allowsSystemGenerateNewId": true,
935 "numberRangeIdentifierValue": "string",
936 "numberRangeIdentifierType": {
937 "name": "string"
938 },
939 "numberRangeType": {
940 "name": "string"
941 }
942 }
943 ],
944 "rejectionReason": "string",
945 "allowsSystemGenerateNewId": true,
946 "numberRangeIdentifierValue": "string",
947 "numberRangeIdentifierType": {
948 "name": "string"
949 },
950 "numberRangeType": {
951 "name": "string"
952 }
953 }
954 ],
955 "approvalInfo": {
956 "approverUsername": "string",
957 "approvedAt": "2019-08-24T14:15:22Z"
958 },
959 "rejectionReason": "string",
960 "allowsSystemGenerateNewId": true,
961 "numberRangeIdentifierValue": "string",
962 "numberRangeIdentifierType": {
963 "name": "string"
964 },
965 "numberRangeType": {
966 "name": "string"
967 }
968 }
969]
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 "shippingAddress": "string",
19 "state": "INV_DRAFT",
20 "notes": "string",
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 "totalAmount": 0,
41 "purchaseRequisitionItems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "quantity": 0,
46 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
73 "purchaseRequisitionDisplayId": "string",
74 "purchaseOrderLineItems": [
75 {
76 "id": 0,
77 "displayId": "string",
78 "quantity": 0,
79 "allocatedQuantity": 0,
80 "receivedQuantity": 0,
81 "unitPrice": 0,
82 "description": "string",
83 "expenseCategory": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "expenseCategoryType": "PAYMENT"
89 },
90 "costCenter": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "profitCenter": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "validTo": "2019-08-24",
103 "erpSystemId": 0,
104 "erpSystemDisplayId": "string"
105 },
106 "taxJurisdiction": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0,
112 "schema": "string",
113 "countryDisplayId": "string"
114 },
115 "taxCode": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0
121 },
122 "taxLineItems": [
123 {
124 "id": 0,
125 "taxRate": 0.1,
126 "taxAmount": 0,
127 "taxType": "string",
128 "purchaseOrderLineItemId": 0
129 }
130 ],
131 "purchaseOrderId": 0,
132 "purchaseOrderDisplayId": "string",
133 "purchaseOrderState": "INV_DRAFT",
134 "invoiceLineItems": [
135 {
136 "id": 0,
137 "displayId": "string",
138 "expenseCategory": {
139 "id": 0,
140 "displayId": "string",
141 "status": "CREATED",
142 "name": "string",
143 "expenseCategoryType": "PAYMENT"
144 },
145 "description": "string",
146 "unitOfMeasure": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "quantity": 0,
154 "unitPrice": 0,
155 "taxJurisdiction": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0,
161 "schema": "string",
162 "countryDisplayId": "string"
163 },
164 "taxCode": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "taxExpenseAccount": {
172 "id": 0,
173 "displayId": "string",
174 "generalLedgerAccountName": "string",
175 "generalLedgerAccountCode": "string",
176 "openItemManagement": true,
177 "accountCategory": "BALANCESHEET",
178 "shortName": "string",
179 "longName": "string"
180 },
181 "taxLineItems": [
182 {}
183 ],
184 "workBreakdownStructure": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "costCenter": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "profitCenter": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "validTo": "2019-08-24",
204 "erpSystemId": 0,
205 "erpSystemDisplayId": "string"
206 },
207 "functionalArea": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "businessArea": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "segment": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0
227 },
228 "network": {
229 "id": 0,
230 "displayId": "string",
231 "status": "CREATED",
232 "name": "string",
233 "erpSystemId": 0
234 },
235 "internalOrderType": {
236 "id": 0,
237 "displayId": "string",
238 "status": "CREATED",
239 "name": "string",
240 "erpSystemId": 0
241 },
242 "internalOrder": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "erpSystemId": 0,
248 "internalOrderTypeId": 0
249 },
250 "additionalCurrencies": [
251 {}
252 ],
253 "scheduledPaymentMatches": [
254 {}
255 ],
256 "goodsReceiptLineItemLinks": [
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 ],
296 "availableQuantity": 0,
297 "allowsSystemGenerateNewId": true,
298 "numberRangeIdentifierValue": "string",
299 "numberRangeIdentifierType": {
300 "name": "string"
301 },
302 "numberRangeType": {
303 "name": "string"
304 }
305 }
306 ],
307 "vendorPaymentId": 0,
308 "purchaseRequisitionLineItemId": 0,
309 "purchaseRequisitionDisplayId": "string",
310 "purchaseRequisitionLineItemAvailableQuantity": 0,
311 "remainingQuantity": 0,
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "availableQuantity": 0,
324 "allowsSystemGenerateNewId": true,
325 "numberRangeIdentifierValue": "string",
326 "numberRangeIdentifierType": {
327 "name": "string"
328 },
329 "numberRangeType": {
330 "name": "string"
331 }
332 }
333 ],
334 "purchaseOrders": [
335 {
336 "id": 0,
337 "displayId": "string",
338 "state": "INV_DRAFT",
339 "issueDate": "2019-08-24",
340 "expectedDeliveryDate": "2019-08-24",
341 "name": "string",
342 "shippingAddress": "string",
343 "notes": "string",
344 "netAmount": 0,
345 "taxAmount": 0,
346 "externalPurchaseOrderDisplayId": "string",
347 "vendor": {
348 "id": 0,
349 "displayId": "string",
350 "status": "CREATED",
351 "name": "string",
352 "erpSystemDisplayId": "string"
353 },
354 "currency": {
355 "id": 0,
356 "displayId": "string",
357 "status": "CREATED",
358 "name": "string",
359 "decimalPoints": 0
360 },
361 "company": {
362 "id": 0,
363 "displayId": "string",
364 "status": "CREATED",
365 "erpSystemId": 0,
366 "erpSystemDisplayId": "string",
367 "countryId": 0,
368 "countryDisplayId": "string",
369 "name": "string",
370 "postingPeriodVariantId": 0,
371 "fiscalVariantId": 0
372 },
373 "purchaseOrderLineItems": [
374 {
375 "id": 0,
376 "displayId": "string",
377 "quantity": 0,
378 "allocatedQuantity": 0,
379 "receivedQuantity": 0,
380 "unitPrice": 0,
381 "description": "string",
382 "expenseCategory": {
383 "id": 0,
384 "displayId": "string",
385 "status": "CREATED",
386 "name": "string",
387 "expenseCategoryType": "PAYMENT"
388 },
389 "costCenter": {
390 "id": 0,
391 "displayId": "string",
392 "status": "CREATED",
393 "name": "string",
394 "erpSystemId": 0
395 },
396 "profitCenter": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "validTo": "2019-08-24",
402 "erpSystemId": 0,
403 "erpSystemDisplayId": "string"
404 },
405 "taxJurisdiction": {
406 "id": 0,
407 "displayId": "string",
408 "status": "CREATED",
409 "name": "string",
410 "erpSystemId": 0,
411 "schema": "string",
412 "countryDisplayId": "string"
413 },
414 "taxCode": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "erpSystemId": 0
420 },
421 "taxLineItems": [
422 {
423 "id": 0,
424 "taxRate": 0.1,
425 "taxAmount": 0,
426 "taxType": "string",
427 "purchaseOrderLineItemId": 0
428 }
429 ],
430 "purchaseOrderId": 0,
431 "purchaseOrderDisplayId": "string",
432 "purchaseOrderState": "INV_DRAFT",
433 "invoiceLineItems": [
434 {
435 "id": 0,
436 "displayId": "string",
437 "expenseCategory": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "expenseCategoryType": "PAYMENT"
443 },
444 "description": "string",
445 "unitOfMeasure": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "quantity": 0,
453 "unitPrice": 0,
454 "taxJurisdiction": {
455 "id": 0,
456 "displayId": "string",
457 "status": "CREATED",
458 "name": "string",
459 "erpSystemId": 0,
460 "schema": "string",
461 "countryDisplayId": "string"
462 },
463 "taxCode": {
464 "id": 0,
465 "displayId": "string",
466 "status": "CREATED",
467 "name": "string",
468 "erpSystemId": 0
469 },
470 "taxExpenseAccount": {
471 "id": 0,
472 "displayId": "string",
473 "generalLedgerAccountName": "string",
474 "generalLedgerAccountCode": "string",
475 "openItemManagement": true,
476 "accountCategory": "BALANCESHEET",
477 "shortName": "string",
478 "longName": "string"
479 },
480 "taxLineItems": [
481 {}
482 ],
483 "workBreakdownStructure": {
484 "id": 0,
485 "displayId": "string",
486 "status": "CREATED",
487 "name": "string",
488 "erpSystemId": 0
489 },
490 "costCenter": {
491 "id": 0,
492 "displayId": "string",
493 "status": "CREATED",
494 "name": "string",
495 "erpSystemId": 0
496 },
497 "profitCenter": {
498 "id": 0,
499 "displayId": "string",
500 "status": "CREATED",
501 "name": "string",
502 "validTo": "2019-08-24",
503 "erpSystemId": 0,
504 "erpSystemDisplayId": "string"
505 },
506 "functionalArea": {
507 "id": 0,
508 "displayId": "string",
509 "status": "CREATED",
510 "name": "string",
511 "erpSystemId": 0
512 },
513 "businessArea": {
514 "id": 0,
515 "displayId": "string",
516 "status": "CREATED",
517 "name": "string",
518 "erpSystemId": 0
519 },
520 "segment": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "network": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "internalOrderType": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "erpSystemId": 0
540 },
541 "internalOrder": {
542 "id": 0,
543 "displayId": "string",
544 "status": "CREATED",
545 "name": "string",
546 "erpSystemId": 0,
547 "internalOrderTypeId": 0
548 },
549 "additionalCurrencies": [
550 {}
551 ],
552 "scheduledPaymentMatches": [
553 {}
554 ],
555 "goodsReceiptLineItemLinks": [
556 {}
557 ],
558 "invoiceId": 0,
559 "invoiceDisplayId": "string",
560 "invoiceState": "INV_DRAFT",
561 "vendorPaymentId": 0,
562 "purchaseOrderLineItemId": 0,
563 "netAmount": 0,
564 "allowsSystemGenerateNewId": true,
565 "numberRangeIdentifierValue": "string",
566 "numberRangeIdentifierType": {
567 "name": "string"
568 },
569 "numberRangeType": {
570 "name": "string"
571 }
572 }
573 ],
574 "goodsReceiptLineItems": [
575 {
576 "id": 0,
577 "displayId": "string",
578 "quantity": 0,
579 "invoicedQuantity": 0,
580 "description": "string",
581 "expenseCategory": {
582 "id": 0,
583 "displayId": "string",
584 "status": "CREATED",
585 "name": "string",
586 "expenseCategoryType": "PAYMENT"
587 },
588 "goodsReceiptId": 0,
589 "goodsReceiptDisplayId": "string",
590 "goodsReceiptState": "INV_DRAFT",
591 "purchaseOrderLineItemId": 0,
592 "invoiceLineItemLinks": [
593 {}
594 ],
595 "availableQuantity": 0,
596 "allowsSystemGenerateNewId": true,
597 "numberRangeIdentifierValue": "string",
598 "numberRangeIdentifierType": {
599 "name": "string"
600 },
601 "numberRangeType": {
602 "name": "string"
603 }
604 }
605 ],
606 "vendorPaymentId": 0,
607 "purchaseRequisitionLineItemId": 0,
608 "purchaseRequisitionDisplayId": "string",
609 "purchaseRequisitionLineItemAvailableQuantity": 0,
610 "remainingQuantity": 0,
611 "availableQuantity": 0,
612 "allowsSystemGenerateNewId": true,
613 "numberRangeIdentifierValue": "string",
614 "numberRangeIdentifierType": {
615 "name": "string"
616 },
617 "numberRangeType": {
618 "name": "string"
619 }
620 }
621 ],
622 "purchaseRequisitionIds": [
623 0
624 ],
625 "purchaseRequisitionDisplayIds": [
626 "string"
627 ],
628 "invoices": [
629 {
630 "id": 0,
631 "displayId": "string",
632 "name": "string",
633 "invoiceType": "VENDOR_INV",
634 "state": "INV_DRAFT",
635 "externalDocumentNumber": "string",
636 "purchaseOrderReference": "string",
637 "invoiceDate": "2019-08-24",
638 "dueDate": "2019-08-24",
639 "notes": "string",
640 "billingPeriodFromDate": "2019-08-24",
641 "billingPeriodToDate": "2019-08-24",
642 "currency": {
643 "id": 0,
644 "displayId": "string",
645 "status": "CREATED",
646 "name": "string",
647 "decimalPoints": 0
648 },
649 "vendor": {
650 "id": 0,
651 "displayId": "string",
652 "status": "CREATED",
653 "name": "string",
654 "erpSystemDisplayId": "string"
655 },
656 "company": {
657 "id": 0,
658 "displayId": "string",
659 "status": "CREATED",
660 "erpSystemId": 0,
661 "erpSystemDisplayId": "string",
662 "countryId": 0,
663 "countryDisplayId": "string",
664 "name": "string",
665 "postingPeriodVariantId": 0,
666 "fiscalVariantId": 0
667 },
668 "netAmount": 0,
669 "taxAmount": 0,
670 "totalAmount": 0,
671 "netAmountBalance": 0,
672 "taxAmountBalance": 0,
673 "paymentTerm": {
674 "id": 0,
675 "displayId": "string",
676 "status": "CREATED",
677 "name": "string"
678 },
679 "paymentMethod": {
680 "id": 0,
681 "displayId": "string",
682 "status": "CREATED",
683 "name": "string",
684 "type": "string"
685 },
686 "paymentBlock": {
687 "id": 0,
688 "displayId": "string",
689 "status": "CREATED",
690 "name": "string"
691 },
692 "defaultCostCenter": {
693 "id": 0,
694 "displayId": "string",
695 "status": "CREATED",
696 "name": "string",
697 "erpSystemId": 0
698 },
699 "defaultProfitCenter": {
700 "id": 0,
701 "displayId": "string",
702 "status": "CREATED",
703 "name": "string",
704 "validTo": "2019-08-24",
705 "erpSystemId": 0,
706 "erpSystemDisplayId": "string"
707 },
708 "invoiceLineItems": [
709 {
710 "id": 0,
711 "displayId": "string",
712 "expenseCategory": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "expenseCategoryType": "PAYMENT"
718 },
719 "description": "string",
720 "unitOfMeasure": {
721 "id": 0,
722 "displayId": "string",
723 "status": "CREATED",
724 "name": "string",
725 "erpSystemId": 0
726 },
727 "quantity": 0,
728 "unitPrice": 0,
729 "taxJurisdiction": {
730 "id": 0,
731 "displayId": "string",
732 "status": "CREATED",
733 "name": "string",
734 "erpSystemId": 0,
735 "schema": "string",
736 "countryDisplayId": "string"
737 },
738 "taxCode": {
739 "id": 0,
740 "displayId": "string",
741 "status": "CREATED",
742 "name": "string",
743 "erpSystemId": 0
744 },
745 "taxExpenseAccount": {
746 "id": 0,
747 "displayId": "string",
748 "generalLedgerAccountName": "string",
749 "generalLedgerAccountCode": "string",
750 "openItemManagement": true,
751 "accountCategory": "BALANCESHEET",
752 "shortName": "string",
753 "longName": "string"
754 },
755 "taxLineItems": [
756 {}
757 ],
758 "workBreakdownStructure": {
759 "id": 0,
760 "displayId": "string",
761 "status": "CREATED",
762 "name": "string",
763 "erpSystemId": 0
764 },
765 "costCenter": {
766 "id": 0,
767 "displayId": "string",
768 "status": "CREATED",
769 "name": "string",
770 "erpSystemId": 0
771 },
772 "profitCenter": {
773 "id": 0,
774 "displayId": "string",
775 "status": "CREATED",
776 "name": "string",
777 "validTo": "2019-08-24",
778 "erpSystemId": 0,
779 "erpSystemDisplayId": "string"
780 },
781 "functionalArea": {
782 "id": 0,
783 "displayId": "string",
784 "status": "CREATED",
785 "name": "string",
786 "erpSystemId": 0
787 },
788 "businessArea": {
789 "id": 0,
790 "displayId": "string",
791 "status": "CREATED",
792 "name": "string",
793 "erpSystemId": 0
794 },
795 "segment": {
796 "id": 0,
797 "displayId": "string",
798 "status": "CREATED",
799 "name": "string",
800 "erpSystemId": 0
801 },
802 "network": {
803 "id": 0,
804 "displayId": "string",
805 "status": "CREATED",
806 "name": "string",
807 "erpSystemId": 0
808 },
809 "internalOrderType": {
810 "id": 0,
811 "displayId": "string",
812 "status": "CREATED",
813 "name": "string",
814 "erpSystemId": 0
815 },
816 "internalOrder": {
817 "id": 0,
818 "displayId": "string",
819 "status": "CREATED",
820 "name": "string",
821 "erpSystemId": 0,
822 "internalOrderTypeId": 0
823 },
824 "additionalCurrencies": [
825 {}
826 ],
827 "scheduledPaymentMatches": [
828 {}
829 ],
830 "goodsReceiptLineItemLinks": [
831 {}
832 ],
833 "invoiceId": 0,
834 "invoiceDisplayId": "string",
835 "invoiceState": "INV_DRAFT",
836 "vendorPaymentId": 0,
837 "purchaseOrderLineItemId": 0,
838 "netAmount": 0,
839 "allowsSystemGenerateNewId": true,
840 "numberRangeIdentifierValue": "string",
841 "numberRangeIdentifierType": {
842 "name": "string"
843 },
844 "numberRangeType": {
845 "name": "string"
846 }
847 }
848 ],
849 "workspaceId": 0,
850 "workspaceDisplayId": "string",
851 "workspaceName": "string",
852 "workspaceState": "INV_DRAFT",
853 "remainingNetAmount": 0,
854 "remainingTaxAmount": 0,
855 "remainingTotalAmount": 0,
856 "pendingPaymentCount": 0,
857 "allPaymentsPosted": true,
858 "approvalInfo": {
859 "approverUsername": "string",
860 "approvedAt": "2019-08-24T14:15:22Z"
861 },
862 "rejectionReason": "string",
863 "allowsSystemGenerateNewId": true,
864 "numberRangeIdentifierValue": "string",
865 "numberRangeIdentifierType": {
866 "name": "string"
867 },
868 "numberRangeType": {
869 "name": "string"
870 }
871 }
872 ],
873 "rejectionReason": "string",
874 "allowsSystemGenerateNewId": true,
875 "numberRangeIdentifierValue": "string",
876 "numberRangeIdentifierType": {
877 "name": "string"
878 },
879 "numberRangeType": {
880 "name": "string"
881 }
882 }
883 ],
884 "approvalInfo": {
885 "approverUsername": "string",
886 "approvedAt": "2019-08-24T14:15:22Z"
887 },
888 "rejectionReason": "string",
889 "allowsSystemGenerateNewId": true,
890 "numberRangeIdentifierValue": "string",
891 "numberRangeIdentifierType": {
892 "name": "string"
893 },
894 "numberRangeType": {
895 "name": "string"
896 }
897 }
898 ]
899}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/purchase-requisition/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 requisition objects, each including item details, quantities, and associated cost information for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "shippingAddress": "string",
6 "state": "INV_DRAFT",
7 "notes": "string",
8 "currency": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string",
13 "decimalPoints": 0
14 },
15 "company": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "erpSystemId": 0,
20 "erpSystemDisplayId": "string",
21 "countryId": 0,
22 "countryDisplayId": "string",
23 "name": "string",
24 "postingPeriodVariantId": 0,
25 "fiscalVariantId": 0
26 },
27 "totalAmount": 0,
28 "purchaseRequisitionItems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "quantity": 0,
33 "allocatedQuantity": 0,
34 "unitPrice": 0,
35 "description": "string",
36 "expenseCategory": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "expenseCategoryType": "PAYMENT"
42 },
43 "costCenter": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "erpSystemId": 0
49 },
50 "profitCenter": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "validTo": "2019-08-24",
56 "erpSystemId": 0,
57 "erpSystemDisplayId": "string"
58 },
59 "purchaseRequisitionId": 0,
60 "purchaseRequisitionDisplayId": "string",
61 "purchaseOrderLineItems": [
62 {
63 "id": 0,
64 "displayId": "string",
65 "quantity": 0,
66 "allocatedQuantity": 0,
67 "receivedQuantity": 0,
68 "unitPrice": 0,
69 "description": "string",
70 "expenseCategory": {
71 "id": 0,
72 "displayId": "string",
73 "status": "CREATED",
74 "name": "string",
75 "expenseCategoryType": "PAYMENT"
76 },
77 "costCenter": {
78 "id": 0,
79 "displayId": "string",
80 "status": "CREATED",
81 "name": "string",
82 "erpSystemId": 0
83 },
84 "profitCenter": {
85 "id": 0,
86 "displayId": "string",
87 "status": "CREATED",
88 "name": "string",
89 "validTo": "2019-08-24",
90 "erpSystemId": 0,
91 "erpSystemDisplayId": "string"
92 },
93 "taxJurisdiction": {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "erpSystemId": 0,
99 "schema": "string",
100 "countryDisplayId": "string"
101 },
102 "taxCode": {
103 "id": 0,
104 "displayId": "string",
105 "status": "CREATED",
106 "name": "string",
107 "erpSystemId": 0
108 },
109 "taxLineItems": [
110 {
111 "id": 0,
112 "taxRate": 0.1,
113 "taxAmount": 0,
114 "taxType": "string",
115 "purchaseOrderLineItemId": 0
116 }
117 ],
118 "purchaseOrderId": 0,
119 "purchaseOrderDisplayId": "string",
120 "purchaseOrderState": "INV_DRAFT",
121 "invoiceLineItems": [
122 {
123 "id": 0,
124 "displayId": "string",
125 "expenseCategory": {
126 "id": 0,
127 "displayId": "string",
128 "status": "CREATED",
129 "name": "string",
130 "expenseCategoryType": "PAYMENT"
131 },
132 "description": "string",
133 "unitOfMeasure": {
134 "id": 0,
135 "displayId": "string",
136 "status": "CREATED",
137 "name": "string",
138 "erpSystemId": 0
139 },
140 "quantity": 0,
141 "unitPrice": 0,
142 "taxJurisdiction": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "erpSystemId": 0,
148 "schema": "string",
149 "countryDisplayId": "string"
150 },
151 "taxCode": {
152 "id": 0,
153 "displayId": "string",
154 "status": "CREATED",
155 "name": "string",
156 "erpSystemId": 0
157 },
158 "taxExpenseAccount": {
159 "id": 0,
160 "displayId": "string",
161 "generalLedgerAccountName": "string",
162 "generalLedgerAccountCode": "string",
163 "openItemManagement": true,
164 "accountCategory": "BALANCESHEET",
165 "shortName": "string",
166 "longName": "string"
167 },
168 "taxLineItems": [
169 {
170 "id": 0,
171 "taxRate": 0.1,
172 "taxAmount": 0,
173 "taxType": "string",
174 "invoiceLineItemId": 0
175 }
176 ],
177 "workBreakdownStructure": {
178 "id": 0,
179 "displayId": "string",
180 "status": "CREATED",
181 "name": "string",
182 "erpSystemId": 0
183 },
184 "costCenter": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "profitCenter": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "validTo": "2019-08-24",
197 "erpSystemId": 0,
198 "erpSystemDisplayId": "string"
199 },
200 "functionalArea": {
201 "id": 0,
202 "displayId": "string",
203 "status": "CREATED",
204 "name": "string",
205 "erpSystemId": 0
206 },
207 "businessArea": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "segment": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "network": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0
227 },
228 "internalOrderType": {
229 "id": 0,
230 "displayId": "string",
231 "status": "CREATED",
232 "name": "string",
233 "erpSystemId": 0
234 },
235 "internalOrder": {
236 "id": 0,
237 "displayId": "string",
238 "status": "CREATED",
239 "name": "string",
240 "erpSystemId": 0,
241 "internalOrderTypeId": 0
242 },
243 "additionalCurrencies": [
244 {
245 "id": 0,
246 "amount": 0,
247 "currency": {},
248 "conversionRate": 0,
249 "conversionDate": "2019-08-24",
250 "translationDateType": "DOCUMENT_DATE",
251 "amountType": "NET_AMOUNT",
252 "currencyDefinitionType": "CONTRACT_CURRENCY",
253 "invoiceEntryId": 0,
254 "invoiceEntryDisplayId": "string"
255 }
256 ],
257 "scheduledPaymentMatches": [
258 {
259 "id": 0,
260 "fromId": 0,
261 "toId": 0,
262 "amount": 0
263 }
264 ],
265 "goodsReceiptLineItemLinks": [
266 {
267 "id": 0,
268 "fromId": 0,
269 "toId": 0,
270 "linkedQuantity": 0
271 }
272 ],
273 "invoiceId": 0,
274 "invoiceDisplayId": "string",
275 "invoiceState": "INV_DRAFT",
276 "vendorPaymentId": 0,
277 "purchaseOrderLineItemId": 0,
278 "netAmount": 0,
279 "allowsSystemGenerateNewId": true,
280 "numberRangeIdentifierValue": "string",
281 "numberRangeIdentifierType": {
282 "name": "string"
283 },
284 "numberRangeType": {
285 "name": "string"
286 }
287 }
288 ],
289 "goodsReceiptLineItems": [
290 {
291 "id": 0,
292 "displayId": "string",
293 "quantity": 0,
294 "invoicedQuantity": 0,
295 "description": "string",
296 "expenseCategory": {
297 "id": 0,
298 "displayId": "string",
299 "status": "CREATED",
300 "name": "string",
301 "expenseCategoryType": "PAYMENT"
302 },
303 "goodsReceiptId": 0,
304 "goodsReceiptDisplayId": "string",
305 "goodsReceiptState": "INV_DRAFT",
306 "purchaseOrderLineItemId": 0,
307 "invoiceLineItemLinks": [
308 {
309 "id": 0,
310 "fromId": 0,
311 "toId": 0,
312 "linkedQuantity": 0
313 }
314 ],
315 "allowsSystemGenerateNewId": true,
316 "numberRangeIdentifierValue": "string",
317 "numberRangeIdentifierType": {
318 "name": "string"
319 },
320 "numberRangeType": {
321 "name": "string"
322 }
323 }
324 ],
325 "vendorPaymentId": 0,
326 "purchaseRequisitionLineItemId": 0,
327 "purchaseRequisitionDisplayId": "string",
328 "purchaseRequisitionLineItemAvailableQuantity": 0,
329 "allowsSystemGenerateNewId": true,
330 "numberRangeIdentifierValue": "string",
331 "numberRangeIdentifierType": {
332 "name": "string"
333 },
334 "numberRangeType": {
335 "name": "string"
336 }
337 }
338 ],
339 "allowsSystemGenerateNewId": true,
340 "numberRangeIdentifierValue": "string",
341 "numberRangeIdentifierType": {
342 "name": "string"
343 },
344 "numberRangeType": {
345 "name": "string"
346 }
347 }
348 ],
349 "purchaseOrders": [
350 {
351 "id": 0,
352 "displayId": "string",
353 "state": "INV_DRAFT",
354 "issueDate": "2019-08-24",
355 "expectedDeliveryDate": "2019-08-24",
356 "name": "string",
357 "shippingAddress": "string",
358 "notes": "string",
359 "netAmount": 0,
360 "taxAmount": 0,
361 "externalPurchaseOrderDisplayId": "string",
362 "vendor": {
363 "id": 0,
364 "displayId": "string",
365 "status": "CREATED",
366 "name": "string",
367 "erpSystemDisplayId": "string"
368 },
369 "currency": {
370 "id": 0,
371 "displayId": "string",
372 "status": "CREATED",
373 "name": "string",
374 "decimalPoints": 0
375 },
376 "company": {
377 "id": 0,
378 "displayId": "string",
379 "status": "CREATED",
380 "erpSystemId": 0,
381 "erpSystemDisplayId": "string",
382 "countryId": 0,
383 "countryDisplayId": "string",
384 "name": "string",
385 "postingPeriodVariantId": 0,
386 "fiscalVariantId": 0
387 },
388 "purchaseOrderLineItems": [
389 {
390 "id": 0,
391 "displayId": "string",
392 "quantity": 0,
393 "allocatedQuantity": 0,
394 "receivedQuantity": 0,
395 "unitPrice": 0,
396 "description": "string",
397 "expenseCategory": {
398 "id": 0,
399 "displayId": "string",
400 "status": "CREATED",
401 "name": "string",
402 "expenseCategoryType": "PAYMENT"
403 },
404 "costCenter": {
405 "id": 0,
406 "displayId": "string",
407 "status": "CREATED",
408 "name": "string",
409 "erpSystemId": 0
410 },
411 "profitCenter": {
412 "id": 0,
413 "displayId": "string",
414 "status": "CREATED",
415 "name": "string",
416 "validTo": "2019-08-24",
417 "erpSystemId": 0,
418 "erpSystemDisplayId": "string"
419 },
420 "taxJurisdiction": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0,
426 "schema": "string",
427 "countryDisplayId": "string"
428 },
429 "taxCode": {
430 "id": 0,
431 "displayId": "string",
432 "status": "CREATED",
433 "name": "string",
434 "erpSystemId": 0
435 },
436 "taxLineItems": [
437 {
438 "id": 0,
439 "taxRate": 0.1,
440 "taxAmount": 0,
441 "taxType": "string",
442 "purchaseOrderLineItemId": 0
443 }
444 ],
445 "purchaseOrderId": 0,
446 "purchaseOrderDisplayId": "string",
447 "purchaseOrderState": "INV_DRAFT",
448 "invoiceLineItems": [
449 {
450 "id": 0,
451 "displayId": "string",
452 "expenseCategory": {
453 "id": 0,
454 "displayId": "string",
455 "status": "CREATED",
456 "name": "string",
457 "expenseCategoryType": "PAYMENT"
458 },
459 "description": "string",
460 "unitOfMeasure": {
461 "id": 0,
462 "displayId": "string",
463 "status": "CREATED",
464 "name": "string",
465 "erpSystemId": 0
466 },
467 "quantity": 0,
468 "unitPrice": 0,
469 "taxJurisdiction": {
470 "id": 0,
471 "displayId": "string",
472 "status": "CREATED",
473 "name": "string",
474 "erpSystemId": 0,
475 "schema": "string",
476 "countryDisplayId": "string"
477 },
478 "taxCode": {
479 "id": 0,
480 "displayId": "string",
481 "status": "CREATED",
482 "name": "string",
483 "erpSystemId": 0
484 },
485 "taxExpenseAccount": {
486 "id": 0,
487 "displayId": "string",
488 "generalLedgerAccountName": "string",
489 "generalLedgerAccountCode": "string",
490 "openItemManagement": true,
491 "accountCategory": "BALANCESHEET",
492 "shortName": "string",
493 "longName": "string"
494 },
495 "taxLineItems": [
496 {
497 "id": 0,
498 "taxRate": 0.1,
499 "taxAmount": 0,
500 "taxType": "string",
501 "invoiceLineItemId": 0
502 }
503 ],
504 "workBreakdownStructure": {
505 "id": 0,
506 "displayId": "string",
507 "status": "CREATED",
508 "name": "string",
509 "erpSystemId": 0
510 },
511 "costCenter": {
512 "id": 0,
513 "displayId": "string",
514 "status": "CREATED",
515 "name": "string",
516 "erpSystemId": 0
517 },
518 "profitCenter": {
519 "id": 0,
520 "displayId": "string",
521 "status": "CREATED",
522 "name": "string",
523 "validTo": "2019-08-24",
524 "erpSystemId": 0,
525 "erpSystemDisplayId": "string"
526 },
527 "functionalArea": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "businessArea": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "erpSystemId": 0
540 },
541 "segment": {
542 "id": 0,
543 "displayId": "string",
544 "status": "CREATED",
545 "name": "string",
546 "erpSystemId": 0
547 },
548 "network": {
549 "id": 0,
550 "displayId": "string",
551 "status": "CREATED",
552 "name": "string",
553 "erpSystemId": 0
554 },
555 "internalOrderType": {
556 "id": 0,
557 "displayId": "string",
558 "status": "CREATED",
559 "name": "string",
560 "erpSystemId": 0
561 },
562 "internalOrder": {
563 "id": 0,
564 "displayId": "string",
565 "status": "CREATED",
566 "name": "string",
567 "erpSystemId": 0,
568 "internalOrderTypeId": 0
569 },
570 "additionalCurrencies": [
571 {
572 "id": 0,
573 "amount": 0,
574 "currency": {},
575 "conversionRate": 0,
576 "conversionDate": "2019-08-24",
577 "translationDateType": "DOCUMENT_DATE",
578 "amountType": "NET_AMOUNT",
579 "currencyDefinitionType": "CONTRACT_CURRENCY",
580 "invoiceEntryId": 0,
581 "invoiceEntryDisplayId": "string"
582 }
583 ],
584 "scheduledPaymentMatches": [
585 {
586 "id": 0,
587 "fromId": 0,
588 "toId": 0,
589 "amount": 0
590 }
591 ],
592 "goodsReceiptLineItemLinks": [
593 {
594 "id": 0,
595 "fromId": 0,
596 "toId": 0,
597 "linkedQuantity": 0
598 }
599 ],
600 "invoiceId": 0,
601 "invoiceDisplayId": "string",
602 "invoiceState": "INV_DRAFT",
603 "vendorPaymentId": 0,
604 "purchaseOrderLineItemId": 0,
605 "netAmount": 0,
606 "allowsSystemGenerateNewId": true,
607 "numberRangeIdentifierValue": "string",
608 "numberRangeIdentifierType": {
609 "name": "string"
610 },
611 "numberRangeType": {
612 "name": "string"
613 }
614 }
615 ],
616 "goodsReceiptLineItems": [
617 {
618 "id": 0,
619 "displayId": "string",
620 "quantity": 0,
621 "invoicedQuantity": 0,
622 "description": "string",
623 "expenseCategory": {
624 "id": 0,
625 "displayId": "string",
626 "status": "CREATED",
627 "name": "string",
628 "expenseCategoryType": "PAYMENT"
629 },
630 "goodsReceiptId": 0,
631 "goodsReceiptDisplayId": "string",
632 "goodsReceiptState": "INV_DRAFT",
633 "purchaseOrderLineItemId": 0,
634 "invoiceLineItemLinks": [
635 {
636 "id": 0,
637 "fromId": 0,
638 "toId": 0,
639 "linkedQuantity": 0
640 }
641 ],
642 "allowsSystemGenerateNewId": true,
643 "numberRangeIdentifierValue": "string",
644 "numberRangeIdentifierType": {
645 "name": "string"
646 },
647 "numberRangeType": {
648 "name": "string"
649 }
650 }
651 ],
652 "vendorPaymentId": 0,
653 "purchaseRequisitionLineItemId": 0,
654 "purchaseRequisitionDisplayId": "string",
655 "purchaseRequisitionLineItemAvailableQuantity": 0,
656 "allowsSystemGenerateNewId": true,
657 "numberRangeIdentifierValue": "string",
658 "numberRangeIdentifierType": {
659 "name": "string"
660 },
661 "numberRangeType": {
662 "name": "string"
663 }
664 }
665 ],
666 "purchaseRequisitionIds": [
667 0
668 ],
669 "purchaseRequisitionDisplayIds": [
670 "string"
671 ],
672 "invoices": [
673 {
674 "id": 0,
675 "displayId": "string",
676 "name": "string",
677 "invoiceType": "VENDOR_INV",
678 "state": "INV_DRAFT",
679 "externalDocumentNumber": "string",
680 "purchaseOrderReference": "string",
681 "invoiceDate": "2019-08-24",
682 "dueDate": "2019-08-24",
683 "notes": "string",
684 "billingPeriodFromDate": "2019-08-24",
685 "billingPeriodToDate": "2019-08-24",
686 "currency": {
687 "id": 0,
688 "displayId": "string",
689 "status": "CREATED",
690 "name": "string",
691 "decimalPoints": 0
692 },
693 "vendor": {
694 "id": 0,
695 "displayId": "string",
696 "status": "CREATED",
697 "name": "string",
698 "erpSystemDisplayId": "string"
699 },
700 "company": {
701 "id": 0,
702 "displayId": "string",
703 "status": "CREATED",
704 "erpSystemId": 0,
705 "erpSystemDisplayId": "string",
706 "countryId": 0,
707 "countryDisplayId": "string",
708 "name": "string",
709 "postingPeriodVariantId": 0,
710 "fiscalVariantId": 0
711 },
712 "netAmount": 0,
713 "taxAmount": 0,
714 "totalAmount": 0,
715 "netAmountBalance": 0,
716 "taxAmountBalance": 0,
717 "paymentTerm": {
718 "id": 0,
719 "displayId": "string",
720 "status": "CREATED",
721 "name": "string"
722 },
723 "paymentMethod": {
724 "id": 0,
725 "displayId": "string",
726 "status": "CREATED",
727 "name": "string",
728 "type": "string"
729 },
730 "paymentBlock": {
731 "id": 0,
732 "displayId": "string",
733 "status": "CREATED",
734 "name": "string"
735 },
736 "defaultCostCenter": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string",
741 "erpSystemId": 0
742 },
743 "defaultProfitCenter": {
744 "id": 0,
745 "displayId": "string",
746 "status": "CREATED",
747 "name": "string",
748 "validTo": "2019-08-24",
749 "erpSystemId": 0,
750 "erpSystemDisplayId": "string"
751 },
752 "invoiceLineItems": [
753 {
754 "id": 0,
755 "displayId": "string",
756 "expenseCategory": {
757 "id": 0,
758 "displayId": "string",
759 "status": "CREATED",
760 "name": "string",
761 "expenseCategoryType": "PAYMENT"
762 },
763 "description": "string",
764 "unitOfMeasure": {
765 "id": 0,
766 "displayId": "string",
767 "status": "CREATED",
768 "name": "string",
769 "erpSystemId": 0
770 },
771 "quantity": 0,
772 "unitPrice": 0,
773 "taxJurisdiction": {
774 "id": 0,
775 "displayId": "string",
776 "status": "CREATED",
777 "name": "string",
778 "erpSystemId": 0,
779 "schema": "string",
780 "countryDisplayId": "string"
781 },
782 "taxCode": {
783 "id": 0,
784 "displayId": "string",
785 "status": "CREATED",
786 "name": "string",
787 "erpSystemId": 0
788 },
789 "taxExpenseAccount": {
790 "id": 0,
791 "displayId": "string",
792 "generalLedgerAccountName": "string",
793 "generalLedgerAccountCode": "string",
794 "openItemManagement": true,
795 "accountCategory": "BALANCESHEET",
796 "shortName": "string",
797 "longName": "string"
798 },
799 "taxLineItems": [
800 {
801 "id": 0,
802 "taxRate": 0.1,
803 "taxAmount": 0,
804 "taxType": "string",
805 "invoiceLineItemId": 0
806 }
807 ],
808 "workBreakdownStructure": {
809 "id": 0,
810 "displayId": "string",
811 "status": "CREATED",
812 "name": "string",
813 "erpSystemId": 0
814 },
815 "costCenter": {
816 "id": 0,
817 "displayId": "string",
818 "status": "CREATED",
819 "name": "string",
820 "erpSystemId": 0
821 },
822 "profitCenter": {
823 "id": 0,
824 "displayId": "string",
825 "status": "CREATED",
826 "name": "string",
827 "validTo": "2019-08-24",
828 "erpSystemId": 0,
829 "erpSystemDisplayId": "string"
830 },
831 "functionalArea": {
832 "id": 0,
833 "displayId": "string",
834 "status": "CREATED",
835 "name": "string",
836 "erpSystemId": 0
837 },
838 "businessArea": {
839 "id": 0,
840 "displayId": "string",
841 "status": "CREATED",
842 "name": "string",
843 "erpSystemId": 0
844 },
845 "segment": {
846 "id": 0,
847 "displayId": "string",
848 "status": "CREATED",
849 "name": "string",
850 "erpSystemId": 0
851 },
852 "network": {
853 "id": 0,
854 "displayId": "string",
855 "status": "CREATED",
856 "name": "string",
857 "erpSystemId": 0
858 },
859 "internalOrderType": {
860 "id": 0,
861 "displayId": "string",
862 "status": "CREATED",
863 "name": "string",
864 "erpSystemId": 0
865 },
866 "internalOrder": {
867 "id": 0,
868 "displayId": "string",
869 "status": "CREATED",
870 "name": "string",
871 "erpSystemId": 0,
872 "internalOrderTypeId": 0
873 },
874 "additionalCurrencies": [
875 {
876 "id": 0,
877 "amount": 0,
878 "currency": {},
879 "conversionRate": 0,
880 "conversionDate": "2019-08-24",
881 "translationDateType": "DOCUMENT_DATE",
882 "amountType": "NET_AMOUNT",
883 "currencyDefinitionType": "CONTRACT_CURRENCY",
884 "invoiceEntryId": 0,
885 "invoiceEntryDisplayId": "string"
886 }
887 ],
888 "scheduledPaymentMatches": [
889 {
890 "id": 0,
891 "fromId": 0,
892 "toId": 0,
893 "amount": 0
894 }
895 ],
896 "goodsReceiptLineItemLinks": [
897 {
898 "id": 0,
899 "fromId": 0,
900 "toId": 0,
901 "linkedQuantity": 0
902 }
903 ],
904 "invoiceId": 0,
905 "invoiceDisplayId": "string",
906 "invoiceState": "INV_DRAFT",
907 "vendorPaymentId": 0,
908 "purchaseOrderLineItemId": 0,
909 "netAmount": 0,
910 "allowsSystemGenerateNewId": true,
911 "numberRangeIdentifierValue": "string",
912 "numberRangeIdentifierType": {
913 "name": "string"
914 },
915 "numberRangeType": {
916 "name": "string"
917 }
918 }
919 ],
920 "workspaceId": 0,
921 "workspaceDisplayId": "string",
922 "workspaceName": "string",
923 "workspaceState": "INV_DRAFT",
924 "remainingNetAmount": 0,
925 "remainingTaxAmount": 0,
926 "remainingTotalAmount": 0,
927 "pendingPaymentCount": 0,
928 "allPaymentsPosted": true,
929 "approvalInfo": {
930 "approverUsername": "string",
931 "approvedAt": "2019-08-24T14:15:22Z"
932 },
933 "rejectionReason": "string",
934 "allowsSystemGenerateNewId": true,
935 "numberRangeIdentifierValue": "string",
936 "numberRangeIdentifierType": {
937 "name": "string"
938 },
939 "numberRangeType": {
940 "name": "string"
941 }
942 }
943 ],
944 "rejectionReason": "string",
945 "allowsSystemGenerateNewId": true,
946 "numberRangeIdentifierValue": "string",
947 "numberRangeIdentifierType": {
948 "name": "string"
949 },
950 "numberRangeType": {
951 "name": "string"
952 }
953 }
954 ],
955 "approvalInfo": {
956 "approverUsername": "string",
957 "approvedAt": "2019-08-24T14:15:22Z"
958 },
959 "rejectionReason": "string",
960 "allowsSystemGenerateNewId": true,
961 "numberRangeIdentifierValue": "string",
962 "numberRangeIdentifierType": {
963 "name": "string"
964 },
965 "numberRangeType": {
966 "name": "string"
967 }
968 }
969]
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 "shippingAddress": "string",
19 "state": "INV_DRAFT",
20 "notes": "string",
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 "totalAmount": 0,
41 "purchaseRequisitionItems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "quantity": 0,
46 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
73 "purchaseRequisitionDisplayId": "string",
74 "purchaseOrderLineItems": [
75 {
76 "id": 0,
77 "displayId": "string",
78 "quantity": 0,
79 "allocatedQuantity": 0,
80 "receivedQuantity": 0,
81 "unitPrice": 0,
82 "description": "string",
83 "expenseCategory": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "expenseCategoryType": "PAYMENT"
89 },
90 "costCenter": {
91 "id": 0,
92 "displayId": "string",
93 "status": "CREATED",
94 "name": "string",
95 "erpSystemId": 0
96 },
97 "profitCenter": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "validTo": "2019-08-24",
103 "erpSystemId": 0,
104 "erpSystemDisplayId": "string"
105 },
106 "taxJurisdiction": {
107 "id": 0,
108 "displayId": "string",
109 "status": "CREATED",
110 "name": "string",
111 "erpSystemId": 0,
112 "schema": "string",
113 "countryDisplayId": "string"
114 },
115 "taxCode": {
116 "id": 0,
117 "displayId": "string",
118 "status": "CREATED",
119 "name": "string",
120 "erpSystemId": 0
121 },
122 "taxLineItems": [
123 {
124 "id": 0,
125 "taxRate": 0.1,
126 "taxAmount": 0,
127 "taxType": "string",
128 "purchaseOrderLineItemId": 0
129 }
130 ],
131 "purchaseOrderId": 0,
132 "purchaseOrderDisplayId": "string",
133 "purchaseOrderState": "INV_DRAFT",
134 "invoiceLineItems": [
135 {
136 "id": 0,
137 "displayId": "string",
138 "expenseCategory": {
139 "id": 0,
140 "displayId": "string",
141 "status": "CREATED",
142 "name": "string",
143 "expenseCategoryType": "PAYMENT"
144 },
145 "description": "string",
146 "unitOfMeasure": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "quantity": 0,
154 "unitPrice": 0,
155 "taxJurisdiction": {
156 "id": 0,
157 "displayId": "string",
158 "status": "CREATED",
159 "name": "string",
160 "erpSystemId": 0,
161 "schema": "string",
162 "countryDisplayId": "string"
163 },
164 "taxCode": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "taxExpenseAccount": {
172 "id": 0,
173 "displayId": "string",
174 "generalLedgerAccountName": "string",
175 "generalLedgerAccountCode": "string",
176 "openItemManagement": true,
177 "accountCategory": "BALANCESHEET",
178 "shortName": "string",
179 "longName": "string"
180 },
181 "taxLineItems": [
182 {}
183 ],
184 "workBreakdownStructure": {
185 "id": 0,
186 "displayId": "string",
187 "status": "CREATED",
188 "name": "string",
189 "erpSystemId": 0
190 },
191 "costCenter": {
192 "id": 0,
193 "displayId": "string",
194 "status": "CREATED",
195 "name": "string",
196 "erpSystemId": 0
197 },
198 "profitCenter": {
199 "id": 0,
200 "displayId": "string",
201 "status": "CREATED",
202 "name": "string",
203 "validTo": "2019-08-24",
204 "erpSystemId": 0,
205 "erpSystemDisplayId": "string"
206 },
207 "functionalArea": {
208 "id": 0,
209 "displayId": "string",
210 "status": "CREATED",
211 "name": "string",
212 "erpSystemId": 0
213 },
214 "businessArea": {
215 "id": 0,
216 "displayId": "string",
217 "status": "CREATED",
218 "name": "string",
219 "erpSystemId": 0
220 },
221 "segment": {
222 "id": 0,
223 "displayId": "string",
224 "status": "CREATED",
225 "name": "string",
226 "erpSystemId": 0
227 },
228 "network": {
229 "id": 0,
230 "displayId": "string",
231 "status": "CREATED",
232 "name": "string",
233 "erpSystemId": 0
234 },
235 "internalOrderType": {
236 "id": 0,
237 "displayId": "string",
238 "status": "CREATED",
239 "name": "string",
240 "erpSystemId": 0
241 },
242 "internalOrder": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "erpSystemId": 0,
248 "internalOrderTypeId": 0
249 },
250 "additionalCurrencies": [
251 {}
252 ],
253 "scheduledPaymentMatches": [
254 {}
255 ],
256 "goodsReceiptLineItemLinks": [
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 ],
296 "availableQuantity": 0,
297 "allowsSystemGenerateNewId": true,
298 "numberRangeIdentifierValue": "string",
299 "numberRangeIdentifierType": {
300 "name": "string"
301 },
302 "numberRangeType": {
303 "name": "string"
304 }
305 }
306 ],
307 "vendorPaymentId": 0,
308 "purchaseRequisitionLineItemId": 0,
309 "purchaseRequisitionDisplayId": "string",
310 "purchaseRequisitionLineItemAvailableQuantity": 0,
311 "remainingQuantity": 0,
312 "availableQuantity": 0,
313 "allowsSystemGenerateNewId": true,
314 "numberRangeIdentifierValue": "string",
315 "numberRangeIdentifierType": {
316 "name": "string"
317 },
318 "numberRangeType": {
319 "name": "string"
320 }
321 }
322 ],
323 "availableQuantity": 0,
324 "allowsSystemGenerateNewId": true,
325 "numberRangeIdentifierValue": "string",
326 "numberRangeIdentifierType": {
327 "name": "string"
328 },
329 "numberRangeType": {
330 "name": "string"
331 }
332 }
333 ],
334 "purchaseOrders": [
335 {
336 "id": 0,
337 "displayId": "string",
338 "state": "INV_DRAFT",
339 "issueDate": "2019-08-24",
340 "expectedDeliveryDate": "2019-08-24",
341 "name": "string",
342 "shippingAddress": "string",
343 "notes": "string",
344 "netAmount": 0,
345 "taxAmount": 0,
346 "externalPurchaseOrderDisplayId": "string",
347 "vendor": {
348 "id": 0,
349 "displayId": "string",
350 "status": "CREATED",
351 "name": "string",
352 "erpSystemDisplayId": "string"
353 },
354 "currency": {
355 "id": 0,
356 "displayId": "string",
357 "status": "CREATED",
358 "name": "string",
359 "decimalPoints": 0
360 },
361 "company": {
362 "id": 0,
363 "displayId": "string",
364 "status": "CREATED",
365 "erpSystemId": 0,
366 "erpSystemDisplayId": "string",
367 "countryId": 0,
368 "countryDisplayId": "string",
369 "name": "string",
370 "postingPeriodVariantId": 0,
371 "fiscalVariantId": 0
372 },
373 "purchaseOrderLineItems": [
374 {
375 "id": 0,
376 "displayId": "string",
377 "quantity": 0,
378 "allocatedQuantity": 0,
379 "receivedQuantity": 0,
380 "unitPrice": 0,
381 "description": "string",
382 "expenseCategory": {
383 "id": 0,
384 "displayId": "string",
385 "status": "CREATED",
386 "name": "string",
387 "expenseCategoryType": "PAYMENT"
388 },
389 "costCenter": {
390 "id": 0,
391 "displayId": "string",
392 "status": "CREATED",
393 "name": "string",
394 "erpSystemId": 0
395 },
396 "profitCenter": {
397 "id": 0,
398 "displayId": "string",
399 "status": "CREATED",
400 "name": "string",
401 "validTo": "2019-08-24",
402 "erpSystemId": 0,
403 "erpSystemDisplayId": "string"
404 },
405 "taxJurisdiction": {
406 "id": 0,
407 "displayId": "string",
408 "status": "CREATED",
409 "name": "string",
410 "erpSystemId": 0,
411 "schema": "string",
412 "countryDisplayId": "string"
413 },
414 "taxCode": {
415 "id": 0,
416 "displayId": "string",
417 "status": "CREATED",
418 "name": "string",
419 "erpSystemId": 0
420 },
421 "taxLineItems": [
422 {
423 "id": 0,
424 "taxRate": 0.1,
425 "taxAmount": 0,
426 "taxType": "string",
427 "purchaseOrderLineItemId": 0
428 }
429 ],
430 "purchaseOrderId": 0,
431 "purchaseOrderDisplayId": "string",
432 "purchaseOrderState": "INV_DRAFT",
433 "invoiceLineItems": [
434 {
435 "id": 0,
436 "displayId": "string",
437 "expenseCategory": {
438 "id": 0,
439 "displayId": "string",
440 "status": "CREATED",
441 "name": "string",
442 "expenseCategoryType": "PAYMENT"
443 },
444 "description": "string",
445 "unitOfMeasure": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "quantity": 0,
453 "unitPrice": 0,
454 "taxJurisdiction": {
455 "id": 0,
456 "displayId": "string",
457 "status": "CREATED",
458 "name": "string",
459 "erpSystemId": 0,
460 "schema": "string",
461 "countryDisplayId": "string"
462 },
463 "taxCode": {
464 "id": 0,
465 "displayId": "string",
466 "status": "CREATED",
467 "name": "string",
468 "erpSystemId": 0
469 },
470 "taxExpenseAccount": {
471 "id": 0,
472 "displayId": "string",
473 "generalLedgerAccountName": "string",
474 "generalLedgerAccountCode": "string",
475 "openItemManagement": true,
476 "accountCategory": "BALANCESHEET",
477 "shortName": "string",
478 "longName": "string"
479 },
480 "taxLineItems": [
481 {}
482 ],
483 "workBreakdownStructure": {
484 "id": 0,
485 "displayId": "string",
486 "status": "CREATED",
487 "name": "string",
488 "erpSystemId": 0
489 },
490 "costCenter": {
491 "id": 0,
492 "displayId": "string",
493 "status": "CREATED",
494 "name": "string",
495 "erpSystemId": 0
496 },
497 "profitCenter": {
498 "id": 0,
499 "displayId": "string",
500 "status": "CREATED",
501 "name": "string",
502 "validTo": "2019-08-24",
503 "erpSystemId": 0,
504 "erpSystemDisplayId": "string"
505 },
506 "functionalArea": {
507 "id": 0,
508 "displayId": "string",
509 "status": "CREATED",
510 "name": "string",
511 "erpSystemId": 0
512 },
513 "businessArea": {
514 "id": 0,
515 "displayId": "string",
516 "status": "CREATED",
517 "name": "string",
518 "erpSystemId": 0
519 },
520 "segment": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "network": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "internalOrderType": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "erpSystemId": 0
540 },
541 "internalOrder": {
542 "id": 0,
543 "displayId": "string",
544 "status": "CREATED",
545 "name": "string",
546 "erpSystemId": 0,
547 "internalOrderTypeId": 0
548 },
549 "additionalCurrencies": [
550 {}
551 ],
552 "scheduledPaymentMatches": [
553 {}
554 ],
555 "goodsReceiptLineItemLinks": [
556 {}
557 ],
558 "invoiceId": 0,
559 "invoiceDisplayId": "string",
560 "invoiceState": "INV_DRAFT",
561 "vendorPaymentId": 0,
562 "purchaseOrderLineItemId": 0,
563 "netAmount": 0,
564 "allowsSystemGenerateNewId": true,
565 "numberRangeIdentifierValue": "string",
566 "numberRangeIdentifierType": {
567 "name": "string"
568 },
569 "numberRangeType": {
570 "name": "string"
571 }
572 }
573 ],
574 "goodsReceiptLineItems": [
575 {
576 "id": 0,
577 "displayId": "string",
578 "quantity": 0,
579 "invoicedQuantity": 0,
580 "description": "string",
581 "expenseCategory": {
582 "id": 0,
583 "displayId": "string",
584 "status": "CREATED",
585 "name": "string",
586 "expenseCategoryType": "PAYMENT"
587 },
588 "goodsReceiptId": 0,
589 "goodsReceiptDisplayId": "string",
590 "goodsReceiptState": "INV_DRAFT",
591 "purchaseOrderLineItemId": 0,
592 "invoiceLineItemLinks": [
593 {}
594 ],
595 "availableQuantity": 0,
596 "allowsSystemGenerateNewId": true,
597 "numberRangeIdentifierValue": "string",
598 "numberRangeIdentifierType": {
599 "name": "string"
600 },
601 "numberRangeType": {
602 "name": "string"
603 }
604 }
605 ],
606 "vendorPaymentId": 0,
607 "purchaseRequisitionLineItemId": 0,
608 "purchaseRequisitionDisplayId": "string",
609 "purchaseRequisitionLineItemAvailableQuantity": 0,
610 "remainingQuantity": 0,
611 "availableQuantity": 0,
612 "allowsSystemGenerateNewId": true,
613 "numberRangeIdentifierValue": "string",
614 "numberRangeIdentifierType": {
615 "name": "string"
616 },
617 "numberRangeType": {
618 "name": "string"
619 }
620 }
621 ],
622 "purchaseRequisitionIds": [
623 0
624 ],
625 "purchaseRequisitionDisplayIds": [
626 "string"
627 ],
628 "invoices": [
629 {
630 "id": 0,
631 "displayId": "string",
632 "name": "string",
633 "invoiceType": "VENDOR_INV",
634 "state": "INV_DRAFT",
635 "externalDocumentNumber": "string",
636 "purchaseOrderReference": "string",
637 "invoiceDate": "2019-08-24",
638 "dueDate": "2019-08-24",
639 "notes": "string",
640 "billingPeriodFromDate": "2019-08-24",
641 "billingPeriodToDate": "2019-08-24",
642 "currency": {
643 "id": 0,
644 "displayId": "string",
645 "status": "CREATED",
646 "name": "string",
647 "decimalPoints": 0
648 },
649 "vendor": {
650 "id": 0,
651 "displayId": "string",
652 "status": "CREATED",
653 "name": "string",
654 "erpSystemDisplayId": "string"
655 },
656 "company": {
657 "id": 0,
658 "displayId": "string",
659 "status": "CREATED",
660 "erpSystemId": 0,
661 "erpSystemDisplayId": "string",
662 "countryId": 0,
663 "countryDisplayId": "string",
664 "name": "string",
665 "postingPeriodVariantId": 0,
666 "fiscalVariantId": 0
667 },
668 "netAmount": 0,
669 "taxAmount": 0,
670 "totalAmount": 0,
671 "netAmountBalance": 0,
672 "taxAmountBalance": 0,
673 "paymentTerm": {
674 "id": 0,
675 "displayId": "string",
676 "status": "CREATED",
677 "name": "string"
678 },
679 "paymentMethod": {
680 "id": 0,
681 "displayId": "string",
682 "status": "CREATED",
683 "name": "string",
684 "type": "string"
685 },
686 "paymentBlock": {
687 "id": 0,
688 "displayId": "string",
689 "status": "CREATED",
690 "name": "string"
691 },
692 "defaultCostCenter": {
693 "id": 0,
694 "displayId": "string",
695 "status": "CREATED",
696 "name": "string",
697 "erpSystemId": 0
698 },
699 "defaultProfitCenter": {
700 "id": 0,
701 "displayId": "string",
702 "status": "CREATED",
703 "name": "string",
704 "validTo": "2019-08-24",
705 "erpSystemId": 0,
706 "erpSystemDisplayId": "string"
707 },
708 "invoiceLineItems": [
709 {
710 "id": 0,
711 "displayId": "string",
712 "expenseCategory": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "expenseCategoryType": "PAYMENT"
718 },
719 "description": "string",
720 "unitOfMeasure": {
721 "id": 0,
722 "displayId": "string",
723 "status": "CREATED",
724 "name": "string",
725 "erpSystemId": 0
726 },
727 "quantity": 0,
728 "unitPrice": 0,
729 "taxJurisdiction": {
730 "id": 0,
731 "displayId": "string",
732 "status": "CREATED",
733 "name": "string",
734 "erpSystemId": 0,
735 "schema": "string",
736 "countryDisplayId": "string"
737 },
738 "taxCode": {
739 "id": 0,
740 "displayId": "string",
741 "status": "CREATED",
742 "name": "string",
743 "erpSystemId": 0
744 },
745 "taxExpenseAccount": {
746 "id": 0,
747 "displayId": "string",
748 "generalLedgerAccountName": "string",
749 "generalLedgerAccountCode": "string",
750 "openItemManagement": true,
751 "accountCategory": "BALANCESHEET",
752 "shortName": "string",
753 "longName": "string"
754 },
755 "taxLineItems": [
756 {}
757 ],
758 "workBreakdownStructure": {
759 "id": 0,
760 "displayId": "string",
761 "status": "CREATED",
762 "name": "string",
763 "erpSystemId": 0
764 },
765 "costCenter": {
766 "id": 0,
767 "displayId": "string",
768 "status": "CREATED",
769 "name": "string",
770 "erpSystemId": 0
771 },
772 "profitCenter": {
773 "id": 0,
774 "displayId": "string",
775 "status": "CREATED",
776 "name": "string",
777 "validTo": "2019-08-24",
778 "erpSystemId": 0,
779 "erpSystemDisplayId": "string"
780 },
781 "functionalArea": {
782 "id": 0,
783 "displayId": "string",
784 "status": "CREATED",
785 "name": "string",
786 "erpSystemId": 0
787 },
788 "businessArea": {
789 "id": 0,
790 "displayId": "string",
791 "status": "CREATED",
792 "name": "string",
793 "erpSystemId": 0
794 },
795 "segment": {
796 "id": 0,
797 "displayId": "string",
798 "status": "CREATED",
799 "name": "string",
800 "erpSystemId": 0
801 },
802 "network": {
803 "id": 0,
804 "displayId": "string",
805 "status": "CREATED",
806 "name": "string",
807 "erpSystemId": 0
808 },
809 "internalOrderType": {
810 "id": 0,
811 "displayId": "string",
812 "status": "CREATED",
813 "name": "string",
814 "erpSystemId": 0
815 },
816 "internalOrder": {
817 "id": 0,
818 "displayId": "string",
819 "status": "CREATED",
820 "name": "string",
821 "erpSystemId": 0,
822 "internalOrderTypeId": 0
823 },
824 "additionalCurrencies": [
825 {}
826 ],
827 "scheduledPaymentMatches": [
828 {}
829 ],
830 "goodsReceiptLineItemLinks": [
831 {}
832 ],
833 "invoiceId": 0,
834 "invoiceDisplayId": "string",
835 "invoiceState": "INV_DRAFT",
836 "vendorPaymentId": 0,
837 "purchaseOrderLineItemId": 0,
838 "netAmount": 0,
839 "allowsSystemGenerateNewId": true,
840 "numberRangeIdentifierValue": "string",
841 "numberRangeIdentifierType": {
842 "name": "string"
843 },
844 "numberRangeType": {
845 "name": "string"
846 }
847 }
848 ],
849 "workspaceId": 0,
850 "workspaceDisplayId": "string",
851 "workspaceName": "string",
852 "workspaceState": "INV_DRAFT",
853 "remainingNetAmount": 0,
854 "remainingTaxAmount": 0,
855 "remainingTotalAmount": 0,
856 "pendingPaymentCount": 0,
857 "allPaymentsPosted": true,
858 "approvalInfo": {
859 "approverUsername": "string",
860 "approvedAt": "2019-08-24T14:15:22Z"
861 },
862 "rejectionReason": "string",
863 "allowsSystemGenerateNewId": true,
864 "numberRangeIdentifierValue": "string",
865 "numberRangeIdentifierType": {
866 "name": "string"
867 },
868 "numberRangeType": {
869 "name": "string"
870 }
871 }
872 ],
873 "rejectionReason": "string",
874 "allowsSystemGenerateNewId": true,
875 "numberRangeIdentifierValue": "string",
876 "numberRangeIdentifierType": {
877 "name": "string"
878 },
879 "numberRangeType": {
880 "name": "string"
881 }
882 }
883 ],
884 "approvalInfo": {
885 "approverUsername": "string",
886 "approvedAt": "2019-08-24T14:15:22Z"
887 },
888 "rejectionReason": "string",
889 "allowsSystemGenerateNewId": true,
890 "numberRangeIdentifierValue": "string",
891 "numberRangeIdentifierType": {
892 "name": "string"
893 },
894 "numberRangeType": {
895 "name": "string"
896 }
897 }
898 ]
899}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/purchase-requisition/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 requisition IDs to be deleted in bulk from the system. |
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}
Purchase Requisition - Remove From Favorite¶
HTTP Request
POST /api/v1/purchase-requisition/{purchaseRequisitionId}/remove-from-favorite
📋 Description: Removes the specified purchase requisition from the user’s list of favorites, streamlining the management of preferred procurement items.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseRequisitionId |
path |
integer(int64) |
true |
Unique identifier for the purchase requisition |
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}
Purchase Requisition - Add To Favorite¶
HTTP Request
POST /api/v1/purchase-requisition/{purchaseRequisitionId}/add-to-favorite
📋 Description: Adds a specified purchase requisition to the user’s list of favorites, enabling quick access and streamlined management of frequently referenced requisitions. This operation enhances user efficiency in procurement processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseRequisitionId |
path |
integer(int64) |
true |
Unique identifier for the purchase requisition |
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-requisition/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 search criteria and filters for retrieving purchase requisition records based on specified parameters. |
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 "shippingAddressLike": "string",
20 "stateEqual": "INV_DRAFT",
21 "stateIn": [
22 "INV_DRAFT"
23 ],
24 "notesLike": "string",
25 "currencyIdEqual": 0,
26 "companyIdEqual": 0,
27 "companyIdIn": [
28 0
29 ]
30}
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 "shippingAddress": "string",
23 "state": "INV_DRAFT",
24 "notes": "string",
25 "currency": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "decimalPoints": 0
31 },
32 "company": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "erpSystemId": 0,
37 "erpSystemDisplayId": "string",
38 "countryId": 0,
39 "countryDisplayId": "string",
40 "name": "string",
41 "postingPeriodVariantId": 0,
42 "fiscalVariantId": 0
43 },
44 "totalAmount": 0,
45 "purchaseRequisitionItems": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "quantity": 0,
50 "allocatedQuantity": 0,
51 "unitPrice": 0,
52 "description": "string",
53 "expenseCategory": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "expenseCategoryType": "PAYMENT"
59 },
60 "costCenter": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "erpSystemId": 0
66 },
67 "profitCenter": {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "validTo": "2019-08-24",
73 "erpSystemId": 0,
74 "erpSystemDisplayId": "string"
75 },
76 "purchaseRequisitionId": 0,
77 "purchaseRequisitionDisplayId": "string",
78 "purchaseOrderLineItems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "quantity": 0,
83 "allocatedQuantity": 0,
84 "receivedQuantity": 0,
85 "unitPrice": 0,
86 "description": "string",
87 "expenseCategory": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "expenseCategoryType": "PAYMENT"
93 },
94 "costCenter": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "profitCenter": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "validTo": "2019-08-24",
107 "erpSystemId": 0,
108 "erpSystemDisplayId": "string"
109 },
110 "taxJurisdiction": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "erpSystemId": 0,
116 "schema": "string",
117 "countryDisplayId": "string"
118 },
119 "taxCode": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "erpSystemId": 0
125 },
126 "taxLineItems": [
127 {
128 "id": 0,
129 "taxRate": 0.1,
130 "taxAmount": 0,
131 "taxType": "string",
132 "purchaseOrderLineItemId": 0
133 }
134 ],
135 "purchaseOrderId": 0,
136 "purchaseOrderDisplayId": "string",
137 "purchaseOrderState": "INV_DRAFT",
138 "invoiceLineItems": [
139 {
140 "id": 0,
141 "displayId": "string",
142 "expenseCategory": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "expenseCategoryType": "PAYMENT"
148 },
149 "description": "string",
150 "unitOfMeasure": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "quantity": 0,
158 "unitPrice": 0,
159 "taxJurisdiction": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0,
165 "schema": "string",
166 "countryDisplayId": "string"
167 },
168 "taxCode": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "taxExpenseAccount": {
176 "id": 0,
177 "displayId": "string",
178 "generalLedgerAccountName": "string",
179 "generalLedgerAccountCode": "string",
180 "openItemManagement": true,
181 "accountCategory": "BALANCESHEET",
182 "shortName": "string",
183 "longName": "string"
184 },
185 "taxLineItems": [
186 {}
187 ],
188 "workBreakdownStructure": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "erpSystemId": 0
194 },
195 "costCenter": {
196 "id": 0,
197 "displayId": "string",
198 "status": "CREATED",
199 "name": "string",
200 "erpSystemId": 0
201 },
202 "profitCenter": {
203 "id": 0,
204 "displayId": "string",
205 "status": "CREATED",
206 "name": "string",
207 "validTo": "2019-08-24",
208 "erpSystemId": 0,
209 "erpSystemDisplayId": "string"
210 },
211 "functionalArea": {
212 "id": 0,
213 "displayId": "string",
214 "status": "CREATED",
215 "name": "string",
216 "erpSystemId": 0
217 },
218 "businessArea": {
219 "id": 0,
220 "displayId": "string",
221 "status": "CREATED",
222 "name": "string",
223 "erpSystemId": 0
224 },
225 "segment": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "erpSystemId": 0
231 },
232 "network": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "erpSystemId": 0
238 },
239 "internalOrderType": {
240 "id": 0,
241 "displayId": "string",
242 "status": "CREATED",
243 "name": "string",
244 "erpSystemId": 0
245 },
246 "internalOrder": {
247 "id": 0,
248 "displayId": "string",
249 "status": "CREATED",
250 "name": "string",
251 "erpSystemId": 0,
252 "internalOrderTypeId": 0
253 },
254 "additionalCurrencies": [
255 {}
256 ],
257 "scheduledPaymentMatches": [
258 {}
259 ],
260 "goodsReceiptLineItemLinks": [
261 {}
262 ],
263 "invoiceId": 0,
264 "invoiceDisplayId": "string",
265 "invoiceState": "INV_DRAFT",
266 "vendorPaymentId": 0,
267 "purchaseOrderLineItemId": 0,
268 "netAmount": 0,
269 "allowsSystemGenerateNewId": true,
270 "numberRangeIdentifierValue": "string",
271 "numberRangeIdentifierType": {
272 "name": "string"
273 },
274 "numberRangeType": {
275 "name": "string"
276 }
277 }
278 ],
279 "goodsReceiptLineItems": [
280 {
281 "id": 0,
282 "displayId": "string",
283 "quantity": 0,
284 "invoicedQuantity": 0,
285 "description": "string",
286 "expenseCategory": {
287 "id": 0,
288 "displayId": "string",
289 "status": "CREATED",
290 "name": "string",
291 "expenseCategoryType": "PAYMENT"
292 },
293 "goodsReceiptId": 0,
294 "goodsReceiptDisplayId": "string",
295 "goodsReceiptState": "INV_DRAFT",
296 "purchaseOrderLineItemId": 0,
297 "invoiceLineItemLinks": [
298 {}
299 ],
300 "availableQuantity": 0,
301 "allowsSystemGenerateNewId": true,
302 "numberRangeIdentifierValue": "string",
303 "numberRangeIdentifierType": {
304 "name": "string"
305 },
306 "numberRangeType": {
307 "name": "string"
308 }
309 }
310 ],
311 "vendorPaymentId": 0,
312 "purchaseRequisitionLineItemId": 0,
313 "purchaseRequisitionDisplayId": "string",
314 "purchaseRequisitionLineItemAvailableQuantity": 0,
315 "remainingQuantity": 0,
316 "availableQuantity": 0,
317 "allowsSystemGenerateNewId": true,
318 "numberRangeIdentifierValue": "string",
319 "numberRangeIdentifierType": {
320 "name": "string"
321 },
322 "numberRangeType": {
323 "name": "string"
324 }
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "purchaseOrders": [
339 {
340 "id": 0,
341 "displayId": "string",
342 "state": "INV_DRAFT",
343 "issueDate": "2019-08-24",
344 "expectedDeliveryDate": "2019-08-24",
345 "name": "string",
346 "shippingAddress": "string",
347 "notes": "string",
348 "netAmount": 0,
349 "taxAmount": 0,
350 "externalPurchaseOrderDisplayId": "string",
351 "vendor": {
352 "id": 0,
353 "displayId": "string",
354 "status": "CREATED",
355 "name": "string",
356 "erpSystemDisplayId": "string"
357 },
358 "currency": {
359 "id": 0,
360 "displayId": "string",
361 "status": "CREATED",
362 "name": "string",
363 "decimalPoints": 0
364 },
365 "company": {
366 "id": 0,
367 "displayId": "string",
368 "status": "CREATED",
369 "erpSystemId": 0,
370 "erpSystemDisplayId": "string",
371 "countryId": 0,
372 "countryDisplayId": "string",
373 "name": "string",
374 "postingPeriodVariantId": 0,
375 "fiscalVariantId": 0
376 },
377 "purchaseOrderLineItems": [
378 {
379 "id": 0,
380 "displayId": "string",
381 "quantity": 0,
382 "allocatedQuantity": 0,
383 "receivedQuantity": 0,
384 "unitPrice": 0,
385 "description": "string",
386 "expenseCategory": {
387 "id": 0,
388 "displayId": "string",
389 "status": "CREATED",
390 "name": "string",
391 "expenseCategoryType": "PAYMENT"
392 },
393 "costCenter": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string",
398 "erpSystemId": 0
399 },
400 "profitCenter": {
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 "taxJurisdiction": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0,
415 "schema": "string",
416 "countryDisplayId": "string"
417 },
418 "taxCode": {
419 "id": 0,
420 "displayId": "string",
421 "status": "CREATED",
422 "name": "string",
423 "erpSystemId": 0
424 },
425 "taxLineItems": [
426 {
427 "id": 0,
428 "taxRate": 0.1,
429 "taxAmount": 0,
430 "taxType": "string",
431 "purchaseOrderLineItemId": 0
432 }
433 ],
434 "purchaseOrderId": 0,
435 "purchaseOrderDisplayId": "string",
436 "purchaseOrderState": "INV_DRAFT",
437 "invoiceLineItems": [
438 {
439 "id": 0,
440 "displayId": "string",
441 "expenseCategory": {
442 "id": 0,
443 "displayId": "string",
444 "status": "CREATED",
445 "name": "string",
446 "expenseCategoryType": "PAYMENT"
447 },
448 "description": "string",
449 "unitOfMeasure": {
450 "id": 0,
451 "displayId": "string",
452 "status": "CREATED",
453 "name": "string",
454 "erpSystemId": 0
455 },
456 "quantity": 0,
457 "unitPrice": 0,
458 "taxJurisdiction": {
459 "id": 0,
460 "displayId": "string",
461 "status": "CREATED",
462 "name": "string",
463 "erpSystemId": 0,
464 "schema": "string",
465 "countryDisplayId": "string"
466 },
467 "taxCode": {
468 "id": 0,
469 "displayId": "string",
470 "status": "CREATED",
471 "name": "string",
472 "erpSystemId": 0
473 },
474 "taxExpenseAccount": {
475 "id": 0,
476 "displayId": "string",
477 "generalLedgerAccountName": "string",
478 "generalLedgerAccountCode": "string",
479 "openItemManagement": true,
480 "accountCategory": "BALANCESHEET",
481 "shortName": "string",
482 "longName": "string"
483 },
484 "taxLineItems": [
485 {}
486 ],
487 "workBreakdownStructure": {
488 "id": 0,
489 "displayId": "string",
490 "status": "CREATED",
491 "name": "string",
492 "erpSystemId": 0
493 },
494 "costCenter": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "profitCenter": {
502 "id": 0,
503 "displayId": "string",
504 "status": "CREATED",
505 "name": "string",
506 "validTo": "2019-08-24",
507 "erpSystemId": 0,
508 "erpSystemDisplayId": "string"
509 },
510 "functionalArea": {
511 "id": 0,
512 "displayId": "string",
513 "status": "CREATED",
514 "name": "string",
515 "erpSystemId": 0
516 },
517 "businessArea": {
518 "id": 0,
519 "displayId": "string",
520 "status": "CREATED",
521 "name": "string",
522 "erpSystemId": 0
523 },
524 "segment": {
525 "id": 0,
526 "displayId": "string",
527 "status": "CREATED",
528 "name": "string",
529 "erpSystemId": 0
530 },
531 "network": {
532 "id": 0,
533 "displayId": "string",
534 "status": "CREATED",
535 "name": "string",
536 "erpSystemId": 0
537 },
538 "internalOrderType": {
539 "id": 0,
540 "displayId": "string",
541 "status": "CREATED",
542 "name": "string",
543 "erpSystemId": 0
544 },
545 "internalOrder": {
546 "id": 0,
547 "displayId": "string",
548 "status": "CREATED",
549 "name": "string",
550 "erpSystemId": 0,
551 "internalOrderTypeId": 0
552 },
553 "additionalCurrencies": [
554 {}
555 ],
556 "scheduledPaymentMatches": [
557 {}
558 ],
559 "goodsReceiptLineItemLinks": [
560 {}
561 ],
562 "invoiceId": 0,
563 "invoiceDisplayId": "string",
564 "invoiceState": "INV_DRAFT",
565 "vendorPaymentId": 0,
566 "purchaseOrderLineItemId": 0,
567 "netAmount": 0,
568 "allowsSystemGenerateNewId": true,
569 "numberRangeIdentifierValue": "string",
570 "numberRangeIdentifierType": {
571 "name": "string"
572 },
573 "numberRangeType": {
574 "name": "string"
575 }
576 }
577 ],
578 "goodsReceiptLineItems": [
579 {
580 "id": 0,
581 "displayId": "string",
582 "quantity": 0,
583 "invoicedQuantity": 0,
584 "description": "string",
585 "expenseCategory": {
586 "id": 0,
587 "displayId": "string",
588 "status": "CREATED",
589 "name": "string",
590 "expenseCategoryType": "PAYMENT"
591 },
592 "goodsReceiptId": 0,
593 "goodsReceiptDisplayId": "string",
594 "goodsReceiptState": "INV_DRAFT",
595 "purchaseOrderLineItemId": 0,
596 "invoiceLineItemLinks": [
597 {}
598 ],
599 "availableQuantity": 0,
600 "allowsSystemGenerateNewId": true,
601 "numberRangeIdentifierValue": "string",
602 "numberRangeIdentifierType": {
603 "name": "string"
604 },
605 "numberRangeType": {
606 "name": "string"
607 }
608 }
609 ],
610 "vendorPaymentId": 0,
611 "purchaseRequisitionLineItemId": 0,
612 "purchaseRequisitionDisplayId": "string",
613 "purchaseRequisitionLineItemAvailableQuantity": 0,
614 "remainingQuantity": 0,
615 "availableQuantity": 0,
616 "allowsSystemGenerateNewId": true,
617 "numberRangeIdentifierValue": "string",
618 "numberRangeIdentifierType": {
619 "name": "string"
620 },
621 "numberRangeType": {
622 "name": "string"
623 }
624 }
625 ],
626 "purchaseRequisitionIds": [
627 0
628 ],
629 "purchaseRequisitionDisplayIds": [
630 "string"
631 ],
632 "invoices": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "name": "string",
637 "invoiceType": "VENDOR_INV",
638 "state": "INV_DRAFT",
639 "externalDocumentNumber": "string",
640 "purchaseOrderReference": "string",
641 "invoiceDate": "2019-08-24",
642 "dueDate": "2019-08-24",
643 "notes": "string",
644 "billingPeriodFromDate": "2019-08-24",
645 "billingPeriodToDate": "2019-08-24",
646 "currency": {
647 "id": 0,
648 "displayId": "string",
649 "status": "CREATED",
650 "name": "string",
651 "decimalPoints": 0
652 },
653 "vendor": {
654 "id": 0,
655 "displayId": "string",
656 "status": "CREATED",
657 "name": "string",
658 "erpSystemDisplayId": "string"
659 },
660 "company": {
661 "id": 0,
662 "displayId": "string",
663 "status": "CREATED",
664 "erpSystemId": 0,
665 "erpSystemDisplayId": "string",
666 "countryId": 0,
667 "countryDisplayId": "string",
668 "name": "string",
669 "postingPeriodVariantId": 0,
670 "fiscalVariantId": 0
671 },
672 "netAmount": 0,
673 "taxAmount": 0,
674 "totalAmount": 0,
675 "netAmountBalance": 0,
676 "taxAmountBalance": 0,
677 "paymentTerm": {
678 "id": 0,
679 "displayId": "string",
680 "status": "CREATED",
681 "name": "string"
682 },
683 "paymentMethod": {
684 "id": 0,
685 "displayId": "string",
686 "status": "CREATED",
687 "name": "string",
688 "type": "string"
689 },
690 "paymentBlock": {
691 "id": 0,
692 "displayId": "string",
693 "status": "CREATED",
694 "name": "string"
695 },
696 "defaultCostCenter": {
697 "id": 0,
698 "displayId": "string",
699 "status": "CREATED",
700 "name": "string",
701 "erpSystemId": 0
702 },
703 "defaultProfitCenter": {
704 "id": 0,
705 "displayId": "string",
706 "status": "CREATED",
707 "name": "string",
708 "validTo": "2019-08-24",
709 "erpSystemId": 0,
710 "erpSystemDisplayId": "string"
711 },
712 "invoiceLineItems": [
713 {
714 "id": 0,
715 "displayId": "string",
716 "expenseCategory": {
717 "id": 0,
718 "displayId": "string",
719 "status": "CREATED",
720 "name": "string",
721 "expenseCategoryType": "PAYMENT"
722 },
723 "description": "string",
724 "unitOfMeasure": {
725 "id": 0,
726 "displayId": "string",
727 "status": "CREATED",
728 "name": "string",
729 "erpSystemId": 0
730 },
731 "quantity": 0,
732 "unitPrice": 0,
733 "taxJurisdiction": {
734 "id": 0,
735 "displayId": "string",
736 "status": "CREATED",
737 "name": "string",
738 "erpSystemId": 0,
739 "schema": "string",
740 "countryDisplayId": "string"
741 },
742 "taxCode": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "erpSystemId": 0
748 },
749 "taxExpenseAccount": {
750 "id": 0,
751 "displayId": "string",
752 "generalLedgerAccountName": "string",
753 "generalLedgerAccountCode": "string",
754 "openItemManagement": true,
755 "accountCategory": "BALANCESHEET",
756 "shortName": "string",
757 "longName": "string"
758 },
759 "taxLineItems": [
760 {}
761 ],
762 "workBreakdownStructure": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "erpSystemId": 0
768 },
769 "costCenter": {
770 "id": 0,
771 "displayId": "string",
772 "status": "CREATED",
773 "name": "string",
774 "erpSystemId": 0
775 },
776 "profitCenter": {
777 "id": 0,
778 "displayId": "string",
779 "status": "CREATED",
780 "name": "string",
781 "validTo": "2019-08-24",
782 "erpSystemId": 0,
783 "erpSystemDisplayId": "string"
784 },
785 "functionalArea": {
786 "id": 0,
787 "displayId": "string",
788 "status": "CREATED",
789 "name": "string",
790 "erpSystemId": 0
791 },
792 "businessArea": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0
798 },
799 "segment": {
800 "id": 0,
801 "displayId": "string",
802 "status": "CREATED",
803 "name": "string",
804 "erpSystemId": 0
805 },
806 "network": {
807 "id": 0,
808 "displayId": "string",
809 "status": "CREATED",
810 "name": "string",
811 "erpSystemId": 0
812 },
813 "internalOrderType": {
814 "id": 0,
815 "displayId": "string",
816 "status": "CREATED",
817 "name": "string",
818 "erpSystemId": 0
819 },
820 "internalOrder": {
821 "id": 0,
822 "displayId": "string",
823 "status": "CREATED",
824 "name": "string",
825 "erpSystemId": 0,
826 "internalOrderTypeId": 0
827 },
828 "additionalCurrencies": [
829 {}
830 ],
831 "scheduledPaymentMatches": [
832 {}
833 ],
834 "goodsReceiptLineItemLinks": [
835 {}
836 ],
837 "invoiceId": 0,
838 "invoiceDisplayId": "string",
839 "invoiceState": "INV_DRAFT",
840 "vendorPaymentId": 0,
841 "purchaseOrderLineItemId": 0,
842 "netAmount": 0,
843 "allowsSystemGenerateNewId": true,
844 "numberRangeIdentifierValue": "string",
845 "numberRangeIdentifierType": {
846 "name": "string"
847 },
848 "numberRangeType": {
849 "name": "string"
850 }
851 }
852 ],
853 "workspaceId": 0,
854 "workspaceDisplayId": "string",
855 "workspaceName": "string",
856 "workspaceState": "INV_DRAFT",
857 "remainingNetAmount": 0,
858 "remainingTaxAmount": 0,
859 "remainingTotalAmount": 0,
860 "pendingPaymentCount": 0,
861 "allPaymentsPosted": true,
862 "approvalInfo": {
863 "approverUsername": "string",
864 "approvedAt": "2019-08-24T14:15:22Z"
865 },
866 "rejectionReason": "string",
867 "allowsSystemGenerateNewId": true,
868 "numberRangeIdentifierValue": "string",
869 "numberRangeIdentifierType": {
870 "name": "string"
871 },
872 "numberRangeType": {
873 "name": "string"
874 }
875 }
876 ],
877 "rejectionReason": "string",
878 "allowsSystemGenerateNewId": true,
879 "numberRangeIdentifierValue": "string",
880 "numberRangeIdentifierType": {
881 "name": "string"
882 },
883 "numberRangeType": {
884 "name": "string"
885 }
886 }
887 ],
888 "approvalInfo": {
889 "approverUsername": "string",
890 "approvedAt": "2019-08-24T14:15:22Z"
891 },
892 "rejectionReason": "string",
893 "allowsSystemGenerateNewId": true,
894 "numberRangeIdentifierValue": "string",
895 "numberRangeIdentifierType": {
896 "name": "string"
897 },
898 "numberRangeType": {
899 "name": "string"
900 }
901 }
902 ],
903 "number": 0,
904 "sort": {
905 "unsorted": true,
906 "sorted": true,
907 "empty": true
908 },
909 "first": true,
910 "last": true,
911 "empty": true
912}
Purchase Requisition - Search Link¶
HTTP Request
POST /api/v1/purchase-requisition/link/search
📋 Description: Submits a request to search for linked purchase requisitions, enabling users to efficiently locate and manage procurement needs within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing the search criteria and filters for locating specific purchase requisitions within the procurement system. |
» 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}
Purchase Requisition - Create Or Update Link¶
HTTP Request
POST /api/v1/purchase-requisition/link/create-or-update
📋 Description: Creates or updates a purchase requisition link, enabling efficient management of procurement requests within the enterprise system. This operation ensures that requisition data is accurately maintained and accessible for operational needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the purchase requisition details, including item specifications, quantities, and associated metadata for creating or updating procurement records. |
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}
Purchase Requisition - Upload Documents¶
HTTP Request
POST /api/v1/purchase-requisition/document/upload
📋 Description: Uploads purchase requisition documents to the system, facilitating efficient procurement processes and ensuring all necessary documentation is readily accessible for review and approval.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entityId |
query |
integer(int64) |
true |
Unique identifier for the entity |
files |
query |
array[string] |
false |
An array of files to be uploaded as part of the purchase requisition documentation process. |
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}
Purchase Requisition - Search Documents¶
HTTP Request
POST /api/v1/purchase-requisition/document/search
📋 Description: Submits a search request for purchase requisition documents, enabling users to efficiently locate and retrieve specific requisitions based on defined criteria.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
Request body containing search criteria and filters for retrieving purchase requisition documents based on specified parameters. |
» 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}
Purchase Requisition - Advanced Search¶
HTTP Request
POST /api/v1/purchase-requisition/advanced-search
📋 Description: Submits a request to perform an advanced search for purchase requisitions, allowing users to specify detailed criteria to refine their search results. This operation enhances procurement efficiency by enabling targeted retrieval of requisition data.
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 requisitions, including filters such as status, date range, and supplier information to facilitate targeted retrieval of procurement requests. |
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 "shippingAddress": "string",
7 "state": "INV_DRAFT",
8 "notes": "string",
9 "currency": {
10 "id": 0,
11 "displayId": "string",
12 "status": "CREATED",
13 "name": "string",
14 "decimalPoints": 0
15 },
16 "company": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "erpSystemId": 0,
21 "erpSystemDisplayId": "string",
22 "countryId": 0,
23 "countryDisplayId": "string",
24 "name": "string",
25 "postingPeriodVariantId": 0,
26 "fiscalVariantId": 0
27 },
28 "totalAmount": 0,
29 "purchaseRequisitionItems": [
30 {
31 "id": 0,
32 "displayId": "string",
33 "quantity": 0,
34 "allocatedQuantity": 0,
35 "unitPrice": 0,
36 "description": "string",
37 "expenseCategory": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "expenseCategoryType": "PAYMENT"
43 },
44 "costCenter": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "name": "string",
49 "erpSystemId": 0
50 },
51 "profitCenter": {
52 "id": 0,
53 "displayId": "string",
54 "status": "CREATED",
55 "name": "string",
56 "validTo": "2019-08-24",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string"
59 },
60 "purchaseRequisitionId": 0,
61 "purchaseRequisitionDisplayId": "string",
62 "purchaseOrderLineItems": [
63 {
64 "id": 0,
65 "displayId": "string",
66 "quantity": 0,
67 "allocatedQuantity": 0,
68 "receivedQuantity": 0,
69 "unitPrice": 0,
70 "description": "string",
71 "expenseCategory": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "expenseCategoryType": "PAYMENT"
77 },
78 "costCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "erpSystemId": 0
84 },
85 "profitCenter": {
86 "id": 0,
87 "displayId": "string",
88 "status": "CREATED",
89 "name": "string",
90 "validTo": "2019-08-24",
91 "erpSystemId": 0,
92 "erpSystemDisplayId": "string"
93 },
94 "taxJurisdiction": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0,
100 "schema": "string",
101 "countryDisplayId": "string"
102 },
103 "taxCode": {
104 "id": 0,
105 "displayId": "string",
106 "status": "CREATED",
107 "name": "string",
108 "erpSystemId": 0
109 },
110 "taxLineItems": [
111 {
112 "id": 0,
113 "taxRate": 0.1,
114 "taxAmount": 0,
115 "taxType": "string",
116 "purchaseOrderLineItemId": 0
117 }
118 ],
119 "purchaseOrderId": 0,
120 "purchaseOrderDisplayId": "string",
121 "purchaseOrderState": "INV_DRAFT",
122 "invoiceLineItems": [
123 {
124 "id": 0,
125 "displayId": "string",
126 "expenseCategory": {
127 "id": 0,
128 "displayId": "string",
129 "status": "CREATED",
130 "name": "string",
131 "expenseCategoryType": "PAYMENT"
132 },
133 "description": "string",
134 "unitOfMeasure": {
135 "id": 0,
136 "displayId": "string",
137 "status": "CREATED",
138 "name": "string",
139 "erpSystemId": 0
140 },
141 "quantity": 0,
142 "unitPrice": 0,
143 "taxJurisdiction": {
144 "id": 0,
145 "displayId": "string",
146 "status": "CREATED",
147 "name": "string",
148 "erpSystemId": 0,
149 "schema": "string",
150 "countryDisplayId": "string"
151 },
152 "taxCode": {
153 "id": 0,
154 "displayId": "string",
155 "status": "CREATED",
156 "name": "string",
157 "erpSystemId": 0
158 },
159 "taxExpenseAccount": {
160 "id": 0,
161 "displayId": "string",
162 "generalLedgerAccountName": "string",
163 "generalLedgerAccountCode": "string",
164 "openItemManagement": true,
165 "accountCategory": "BALANCESHEET",
166 "shortName": "string",
167 "longName": "string"
168 },
169 "taxLineItems": [
170 {}
171 ],
172 "workBreakdownStructure": {
173 "id": 0,
174 "displayId": "string",
175 "status": "CREATED",
176 "name": "string",
177 "erpSystemId": 0
178 },
179 "costCenter": {
180 "id": 0,
181 "displayId": "string",
182 "status": "CREATED",
183 "name": "string",
184 "erpSystemId": 0
185 },
186 "profitCenter": {
187 "id": 0,
188 "displayId": "string",
189 "status": "CREATED",
190 "name": "string",
191 "validTo": "2019-08-24",
192 "erpSystemId": 0,
193 "erpSystemDisplayId": "string"
194 },
195 "functionalArea": {
196 "id": 0,
197 "displayId": "string",
198 "status": "CREATED",
199 "name": "string",
200 "erpSystemId": 0
201 },
202 "businessArea": {
203 "id": 0,
204 "displayId": "string",
205 "status": "CREATED",
206 "name": "string",
207 "erpSystemId": 0
208 },
209 "segment": {
210 "id": 0,
211 "displayId": "string",
212 "status": "CREATED",
213 "name": "string",
214 "erpSystemId": 0
215 },
216 "network": {
217 "id": 0,
218 "displayId": "string",
219 "status": "CREATED",
220 "name": "string",
221 "erpSystemId": 0
222 },
223 "internalOrderType": {
224 "id": 0,
225 "displayId": "string",
226 "status": "CREATED",
227 "name": "string",
228 "erpSystemId": 0
229 },
230 "internalOrder": {
231 "id": 0,
232 "displayId": "string",
233 "status": "CREATED",
234 "name": "string",
235 "erpSystemId": 0,
236 "internalOrderTypeId": 0
237 },
238 "additionalCurrencies": [
239 {}
240 ],
241 "scheduledPaymentMatches": [
242 {}
243 ],
244 "goodsReceiptLineItemLinks": [
245 {}
246 ],
247 "invoiceId": 0,
248 "invoiceDisplayId": "string",
249 "invoiceState": "INV_DRAFT",
250 "vendorPaymentId": 0,
251 "purchaseOrderLineItemId": 0,
252 "netAmount": 0,
253 "allowsSystemGenerateNewId": true,
254 "numberRangeIdentifierValue": "string",
255 "numberRangeIdentifierType": {
256 "name": "string"
257 },
258 "numberRangeType": {
259 "name": "string"
260 }
261 }
262 ],
263 "goodsReceiptLineItems": [
264 {
265 "id": 0,
266 "displayId": "string",
267 "quantity": 0,
268 "invoicedQuantity": 0,
269 "description": "string",
270 "expenseCategory": {
271 "id": 0,
272 "displayId": "string",
273 "status": "CREATED",
274 "name": "string",
275 "expenseCategoryType": "PAYMENT"
276 },
277 "goodsReceiptId": 0,
278 "goodsReceiptDisplayId": "string",
279 "goodsReceiptState": "INV_DRAFT",
280 "purchaseOrderLineItemId": 0,
281 "invoiceLineItemLinks": [
282 {}
283 ],
284 "availableQuantity": 0,
285 "allowsSystemGenerateNewId": true,
286 "numberRangeIdentifierValue": "string",
287 "numberRangeIdentifierType": {
288 "name": "string"
289 },
290 "numberRangeType": {
291 "name": "string"
292 }
293 }
294 ],
295 "vendorPaymentId": 0,
296 "purchaseRequisitionLineItemId": 0,
297 "purchaseRequisitionDisplayId": "string",
298 "purchaseRequisitionLineItemAvailableQuantity": 0,
299 "remainingQuantity": 0,
300 "availableQuantity": 0,
301 "allowsSystemGenerateNewId": true,
302 "numberRangeIdentifierValue": "string",
303 "numberRangeIdentifierType": {
304 "name": "string"
305 },
306 "numberRangeType": {
307 "name": "string"
308 }
309 }
310 ],
311 "availableQuantity": 0,
312 "allowsSystemGenerateNewId": true,
313 "numberRangeIdentifierValue": "string",
314 "numberRangeIdentifierType": {
315 "name": "string"
316 },
317 "numberRangeType": {
318 "name": "string"
319 }
320 }
321 ],
322 "purchaseOrders": [
323 {
324 "id": 0,
325 "displayId": "string",
326 "state": "INV_DRAFT",
327 "issueDate": "2019-08-24",
328 "expectedDeliveryDate": "2019-08-24",
329 "name": "string",
330 "shippingAddress": "string",
331 "notes": "string",
332 "netAmount": 0,
333 "taxAmount": 0,
334 "externalPurchaseOrderDisplayId": "string",
335 "vendor": {
336 "id": 0,
337 "displayId": "string",
338 "status": "CREATED",
339 "name": "string",
340 "erpSystemDisplayId": "string"
341 },
342 "currency": {
343 "id": 0,
344 "displayId": "string",
345 "status": "CREATED",
346 "name": "string",
347 "decimalPoints": 0
348 },
349 "company": {
350 "id": 0,
351 "displayId": "string",
352 "status": "CREATED",
353 "erpSystemId": 0,
354 "erpSystemDisplayId": "string",
355 "countryId": 0,
356 "countryDisplayId": "string",
357 "name": "string",
358 "postingPeriodVariantId": 0,
359 "fiscalVariantId": 0
360 },
361 "purchaseOrderLineItems": [
362 {
363 "id": 0,
364 "displayId": "string",
365 "quantity": 0,
366 "allocatedQuantity": 0,
367 "receivedQuantity": 0,
368 "unitPrice": 0,
369 "description": "string",
370 "expenseCategory": {
371 "id": 0,
372 "displayId": "string",
373 "status": "CREATED",
374 "name": "string",
375 "expenseCategoryType": "PAYMENT"
376 },
377 "costCenter": {
378 "id": 0,
379 "displayId": "string",
380 "status": "CREATED",
381 "name": "string",
382 "erpSystemId": 0
383 },
384 "profitCenter": {
385 "id": 0,
386 "displayId": "string",
387 "status": "CREATED",
388 "name": "string",
389 "validTo": "2019-08-24",
390 "erpSystemId": 0,
391 "erpSystemDisplayId": "string"
392 },
393 "taxJurisdiction": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string",
398 "erpSystemId": 0,
399 "schema": "string",
400 "countryDisplayId": "string"
401 },
402 "taxCode": {
403 "id": 0,
404 "displayId": "string",
405 "status": "CREATED",
406 "name": "string",
407 "erpSystemId": 0
408 },
409 "taxLineItems": [
410 {
411 "id": 0,
412 "taxRate": 0.1,
413 "taxAmount": 0,
414 "taxType": "string",
415 "purchaseOrderLineItemId": 0
416 }
417 ],
418 "purchaseOrderId": 0,
419 "purchaseOrderDisplayId": "string",
420 "purchaseOrderState": "INV_DRAFT",
421 "invoiceLineItems": [
422 {
423 "id": 0,
424 "displayId": "string",
425 "expenseCategory": {
426 "id": 0,
427 "displayId": "string",
428 "status": "CREATED",
429 "name": "string",
430 "expenseCategoryType": "PAYMENT"
431 },
432 "description": "string",
433 "unitOfMeasure": {
434 "id": 0,
435 "displayId": "string",
436 "status": "CREATED",
437 "name": "string",
438 "erpSystemId": 0
439 },
440 "quantity": 0,
441 "unitPrice": 0,
442 "taxJurisdiction": {
443 "id": 0,
444 "displayId": "string",
445 "status": "CREATED",
446 "name": "string",
447 "erpSystemId": 0,
448 "schema": "string",
449 "countryDisplayId": "string"
450 },
451 "taxCode": {
452 "id": 0,
453 "displayId": "string",
454 "status": "CREATED",
455 "name": "string",
456 "erpSystemId": 0
457 },
458 "taxExpenseAccount": {
459 "id": 0,
460 "displayId": "string",
461 "generalLedgerAccountName": "string",
462 "generalLedgerAccountCode": "string",
463 "openItemManagement": true,
464 "accountCategory": "BALANCESHEET",
465 "shortName": "string",
466 "longName": "string"
467 },
468 "taxLineItems": [
469 {}
470 ],
471 "workBreakdownStructure": {
472 "id": 0,
473 "displayId": "string",
474 "status": "CREATED",
475 "name": "string",
476 "erpSystemId": 0
477 },
478 "costCenter": {
479 "id": 0,
480 "displayId": "string",
481 "status": "CREATED",
482 "name": "string",
483 "erpSystemId": 0
484 },
485 "profitCenter": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "validTo": "2019-08-24",
491 "erpSystemId": 0,
492 "erpSystemDisplayId": "string"
493 },
494 "functionalArea": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "businessArea": {
502 "id": 0,
503 "displayId": "string",
504 "status": "CREATED",
505 "name": "string",
506 "erpSystemId": 0
507 },
508 "segment": {
509 "id": 0,
510 "displayId": "string",
511 "status": "CREATED",
512 "name": "string",
513 "erpSystemId": 0
514 },
515 "network": {
516 "id": 0,
517 "displayId": "string",
518 "status": "CREATED",
519 "name": "string",
520 "erpSystemId": 0
521 },
522 "internalOrderType": {
523 "id": 0,
524 "displayId": "string",
525 "status": "CREATED",
526 "name": "string",
527 "erpSystemId": 0
528 },
529 "internalOrder": {
530 "id": 0,
531 "displayId": "string",
532 "status": "CREATED",
533 "name": "string",
534 "erpSystemId": 0,
535 "internalOrderTypeId": 0
536 },
537 "additionalCurrencies": [
538 {}
539 ],
540 "scheduledPaymentMatches": [
541 {}
542 ],
543 "goodsReceiptLineItemLinks": [
544 {}
545 ],
546 "invoiceId": 0,
547 "invoiceDisplayId": "string",
548 "invoiceState": "INV_DRAFT",
549 "vendorPaymentId": 0,
550 "purchaseOrderLineItemId": 0,
551 "netAmount": 0,
552 "allowsSystemGenerateNewId": true,
553 "numberRangeIdentifierValue": "string",
554 "numberRangeIdentifierType": {
555 "name": "string"
556 },
557 "numberRangeType": {
558 "name": "string"
559 }
560 }
561 ],
562 "goodsReceiptLineItems": [
563 {
564 "id": 0,
565 "displayId": "string",
566 "quantity": 0,
567 "invoicedQuantity": 0,
568 "description": "string",
569 "expenseCategory": {
570 "id": 0,
571 "displayId": "string",
572 "status": "CREATED",
573 "name": "string",
574 "expenseCategoryType": "PAYMENT"
575 },
576 "goodsReceiptId": 0,
577 "goodsReceiptDisplayId": "string",
578 "goodsReceiptState": "INV_DRAFT",
579 "purchaseOrderLineItemId": 0,
580 "invoiceLineItemLinks": [
581 {}
582 ],
583 "availableQuantity": 0,
584 "allowsSystemGenerateNewId": true,
585 "numberRangeIdentifierValue": "string",
586 "numberRangeIdentifierType": {
587 "name": "string"
588 },
589 "numberRangeType": {
590 "name": "string"
591 }
592 }
593 ],
594 "vendorPaymentId": 0,
595 "purchaseRequisitionLineItemId": 0,
596 "purchaseRequisitionDisplayId": "string",
597 "purchaseRequisitionLineItemAvailableQuantity": 0,
598 "remainingQuantity": 0,
599 "availableQuantity": 0,
600 "allowsSystemGenerateNewId": true,
601 "numberRangeIdentifierValue": "string",
602 "numberRangeIdentifierType": {
603 "name": "string"
604 },
605 "numberRangeType": {
606 "name": "string"
607 }
608 }
609 ],
610 "purchaseRequisitionIds": [
611 0
612 ],
613 "purchaseRequisitionDisplayIds": [
614 "string"
615 ],
616 "invoices": [
617 {
618 "id": 0,
619 "displayId": "string",
620 "name": "string",
621 "invoiceType": "VENDOR_INV",
622 "state": "INV_DRAFT",
623 "externalDocumentNumber": "string",
624 "purchaseOrderReference": "string",
625 "invoiceDate": "2019-08-24",
626 "dueDate": "2019-08-24",
627 "notes": "string",
628 "billingPeriodFromDate": "2019-08-24",
629 "billingPeriodToDate": "2019-08-24",
630 "currency": {
631 "id": 0,
632 "displayId": "string",
633 "status": "CREATED",
634 "name": "string",
635 "decimalPoints": 0
636 },
637 "vendor": {
638 "id": 0,
639 "displayId": "string",
640 "status": "CREATED",
641 "name": "string",
642 "erpSystemDisplayId": "string"
643 },
644 "company": {
645 "id": 0,
646 "displayId": "string",
647 "status": "CREATED",
648 "erpSystemId": 0,
649 "erpSystemDisplayId": "string",
650 "countryId": 0,
651 "countryDisplayId": "string",
652 "name": "string",
653 "postingPeriodVariantId": 0,
654 "fiscalVariantId": 0
655 },
656 "netAmount": 0,
657 "taxAmount": 0,
658 "totalAmount": 0,
659 "netAmountBalance": 0,
660 "taxAmountBalance": 0,
661 "paymentTerm": {
662 "id": 0,
663 "displayId": "string",
664 "status": "CREATED",
665 "name": "string"
666 },
667 "paymentMethod": {
668 "id": 0,
669 "displayId": "string",
670 "status": "CREATED",
671 "name": "string",
672 "type": "string"
673 },
674 "paymentBlock": {
675 "id": 0,
676 "displayId": "string",
677 "status": "CREATED",
678 "name": "string"
679 },
680 "defaultCostCenter": {
681 "id": 0,
682 "displayId": "string",
683 "status": "CREATED",
684 "name": "string",
685 "erpSystemId": 0
686 },
687 "defaultProfitCenter": {
688 "id": 0,
689 "displayId": "string",
690 "status": "CREATED",
691 "name": "string",
692 "validTo": "2019-08-24",
693 "erpSystemId": 0,
694 "erpSystemDisplayId": "string"
695 },
696 "invoiceLineItems": [
697 {
698 "id": 0,
699 "displayId": "string",
700 "expenseCategory": {
701 "id": 0,
702 "displayId": "string",
703 "status": "CREATED",
704 "name": "string",
705 "expenseCategoryType": "PAYMENT"
706 },
707 "description": "string",
708 "unitOfMeasure": {
709 "id": 0,
710 "displayId": "string",
711 "status": "CREATED",
712 "name": "string",
713 "erpSystemId": 0
714 },
715 "quantity": 0,
716 "unitPrice": 0,
717 "taxJurisdiction": {
718 "id": 0,
719 "displayId": "string",
720 "status": "CREATED",
721 "name": "string",
722 "erpSystemId": 0,
723 "schema": "string",
724 "countryDisplayId": "string"
725 },
726 "taxCode": {
727 "id": 0,
728 "displayId": "string",
729 "status": "CREATED",
730 "name": "string",
731 "erpSystemId": 0
732 },
733 "taxExpenseAccount": {
734 "id": 0,
735 "displayId": "string",
736 "generalLedgerAccountName": "string",
737 "generalLedgerAccountCode": "string",
738 "openItemManagement": true,
739 "accountCategory": "BALANCESHEET",
740 "shortName": "string",
741 "longName": "string"
742 },
743 "taxLineItems": [
744 {}
745 ],
746 "workBreakdownStructure": {
747 "id": 0,
748 "displayId": "string",
749 "status": "CREATED",
750 "name": "string",
751 "erpSystemId": 0
752 },
753 "costCenter": {
754 "id": 0,
755 "displayId": "string",
756 "status": "CREATED",
757 "name": "string",
758 "erpSystemId": 0
759 },
760 "profitCenter": {
761 "id": 0,
762 "displayId": "string",
763 "status": "CREATED",
764 "name": "string",
765 "validTo": "2019-08-24",
766 "erpSystemId": 0,
767 "erpSystemDisplayId": "string"
768 },
769 "functionalArea": {
770 "id": 0,
771 "displayId": "string",
772 "status": "CREATED",
773 "name": "string",
774 "erpSystemId": 0
775 },
776 "businessArea": {
777 "id": 0,
778 "displayId": "string",
779 "status": "CREATED",
780 "name": "string",
781 "erpSystemId": 0
782 },
783 "segment": {
784 "id": 0,
785 "displayId": "string",
786 "status": "CREATED",
787 "name": "string",
788 "erpSystemId": 0
789 },
790 "network": {
791 "id": 0,
792 "displayId": "string",
793 "status": "CREATED",
794 "name": "string",
795 "erpSystemId": 0
796 },
797 "internalOrderType": {
798 "id": 0,
799 "displayId": "string",
800 "status": "CREATED",
801 "name": "string",
802 "erpSystemId": 0
803 },
804 "internalOrder": {
805 "id": 0,
806 "displayId": "string",
807 "status": "CREATED",
808 "name": "string",
809 "erpSystemId": 0,
810 "internalOrderTypeId": 0
811 },
812 "additionalCurrencies": [
813 {}
814 ],
815 "scheduledPaymentMatches": [
816 {}
817 ],
818 "goodsReceiptLineItemLinks": [
819 {}
820 ],
821 "invoiceId": 0,
822 "invoiceDisplayId": "string",
823 "invoiceState": "INV_DRAFT",
824 "vendorPaymentId": 0,
825 "purchaseOrderLineItemId": 0,
826 "netAmount": 0,
827 "allowsSystemGenerateNewId": true,
828 "numberRangeIdentifierValue": "string",
829 "numberRangeIdentifierType": {
830 "name": "string"
831 },
832 "numberRangeType": {
833 "name": "string"
834 }
835 }
836 ],
837 "workspaceId": 0,
838 "workspaceDisplayId": "string",
839 "workspaceName": "string",
840 "workspaceState": "INV_DRAFT",
841 "remainingNetAmount": 0,
842 "remainingTaxAmount": 0,
843 "remainingTotalAmount": 0,
844 "pendingPaymentCount": 0,
845 "allPaymentsPosted": true,
846 "approvalInfo": {
847 "approverUsername": "string",
848 "approvedAt": "2019-08-24T14:15:22Z"
849 },
850 "rejectionReason": "string",
851 "allowsSystemGenerateNewId": true,
852 "numberRangeIdentifierValue": "string",
853 "numberRangeIdentifierType": {
854 "name": "string"
855 },
856 "numberRangeType": {
857 "name": "string"
858 }
859 }
860 ],
861 "rejectionReason": "string",
862 "allowsSystemGenerateNewId": true,
863 "numberRangeIdentifierValue": "string",
864 "numberRangeIdentifierType": {
865 "name": "string"
866 },
867 "numberRangeType": {
868 "name": "string"
869 }
870 }
871 ],
872 "approvalInfo": {
873 "approverUsername": "string",
874 "approvedAt": "2019-08-24T14:15:22Z"
875 },
876 "rejectionReason": "string",
877 "allowsSystemGenerateNewId": true,
878 "numberRangeIdentifierValue": "string",
879 "numberRangeIdentifierType": {
880 "name": "string"
881 },
882 "numberRangeType": {
883 "name": "string"
884 }
885 }
886 ],
887 "facets": {
888 "property1": {},
889 "property2": {}
890 },
891 "aggregations": {
892 "property1": {},
893 "property2": {}
894 },
895 "pagination": {
896 "number": 0,
897 "size": 0,
898 "totalElements": 0,
899 "totalPages": 0,
900 "first": true,
901 "last": true,
902 "empty": true,
903 "numberOfElements": 0
904 }
905}
List All Resources¶
HTTP Request
GET /api/v1/purchase-requisition
📋 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 requisition 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 "shippingAddress": "string",
23 "state": "INV_DRAFT",
24 "notes": "string",
25 "currency": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string",
30 "decimalPoints": 0
31 },
32 "company": {
33 "id": 0,
34 "displayId": "string",
35 "status": "CREATED",
36 "erpSystemId": 0,
37 "erpSystemDisplayId": "string",
38 "countryId": 0,
39 "countryDisplayId": "string",
40 "name": "string",
41 "postingPeriodVariantId": 0,
42 "fiscalVariantId": 0
43 },
44 "totalAmount": 0,
45 "purchaseRequisitionItems": [
46 {
47 "id": 0,
48 "displayId": "string",
49 "quantity": 0,
50 "allocatedQuantity": 0,
51 "unitPrice": 0,
52 "description": "string",
53 "expenseCategory": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "expenseCategoryType": "PAYMENT"
59 },
60 "costCenter": {
61 "id": 0,
62 "displayId": "string",
63 "status": "CREATED",
64 "name": "string",
65 "erpSystemId": 0
66 },
67 "profitCenter": {
68 "id": 0,
69 "displayId": "string",
70 "status": "CREATED",
71 "name": "string",
72 "validTo": "2019-08-24",
73 "erpSystemId": 0,
74 "erpSystemDisplayId": "string"
75 },
76 "purchaseRequisitionId": 0,
77 "purchaseRequisitionDisplayId": "string",
78 "purchaseOrderLineItems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "quantity": 0,
83 "allocatedQuantity": 0,
84 "receivedQuantity": 0,
85 "unitPrice": 0,
86 "description": "string",
87 "expenseCategory": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "expenseCategoryType": "PAYMENT"
93 },
94 "costCenter": {
95 "id": 0,
96 "displayId": "string",
97 "status": "CREATED",
98 "name": "string",
99 "erpSystemId": 0
100 },
101 "profitCenter": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "validTo": "2019-08-24",
107 "erpSystemId": 0,
108 "erpSystemDisplayId": "string"
109 },
110 "taxJurisdiction": {
111 "id": 0,
112 "displayId": "string",
113 "status": "CREATED",
114 "name": "string",
115 "erpSystemId": 0,
116 "schema": "string",
117 "countryDisplayId": "string"
118 },
119 "taxCode": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "erpSystemId": 0
125 },
126 "taxLineItems": [
127 {
128 "id": 0,
129 "taxRate": 0.1,
130 "taxAmount": 0,
131 "taxType": "string",
132 "purchaseOrderLineItemId": 0
133 }
134 ],
135 "purchaseOrderId": 0,
136 "purchaseOrderDisplayId": "string",
137 "purchaseOrderState": "INV_DRAFT",
138 "invoiceLineItems": [
139 {
140 "id": 0,
141 "displayId": "string",
142 "expenseCategory": {
143 "id": 0,
144 "displayId": "string",
145 "status": "CREATED",
146 "name": "string",
147 "expenseCategoryType": "PAYMENT"
148 },
149 "description": "string",
150 "unitOfMeasure": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "quantity": 0,
158 "unitPrice": 0,
159 "taxJurisdiction": {
160 "id": 0,
161 "displayId": "string",
162 "status": "CREATED",
163 "name": "string",
164 "erpSystemId": 0,
165 "schema": "string",
166 "countryDisplayId": "string"
167 },
168 "taxCode": {
169 "id": 0,
170 "displayId": "string",
171 "status": "CREATED",
172 "name": "string",
173 "erpSystemId": 0
174 },
175 "taxExpenseAccount": {
176 "id": 0,
177 "displayId": "string",
178 "generalLedgerAccountName": "string",
179 "generalLedgerAccountCode": "string",
180 "openItemManagement": true,
181 "accountCategory": "BALANCESHEET",
182 "shortName": "string",
183 "longName": "string"
184 },
185 "taxLineItems": [
186 {}
187 ],
188 "workBreakdownStructure": {
189 "id": 0,
190 "displayId": "string",
191 "status": "CREATED",
192 "name": "string",
193 "erpSystemId": 0
194 },
195 "costCenter": {
196 "id": 0,
197 "displayId": "string",
198 "status": "CREATED",
199 "name": "string",
200 "erpSystemId": 0
201 },
202 "profitCenter": {
203 "id": 0,
204 "displayId": "string",
205 "status": "CREATED",
206 "name": "string",
207 "validTo": "2019-08-24",
208 "erpSystemId": 0,
209 "erpSystemDisplayId": "string"
210 },
211 "functionalArea": {
212 "id": 0,
213 "displayId": "string",
214 "status": "CREATED",
215 "name": "string",
216 "erpSystemId": 0
217 },
218 "businessArea": {
219 "id": 0,
220 "displayId": "string",
221 "status": "CREATED",
222 "name": "string",
223 "erpSystemId": 0
224 },
225 "segment": {
226 "id": 0,
227 "displayId": "string",
228 "status": "CREATED",
229 "name": "string",
230 "erpSystemId": 0
231 },
232 "network": {
233 "id": 0,
234 "displayId": "string",
235 "status": "CREATED",
236 "name": "string",
237 "erpSystemId": 0
238 },
239 "internalOrderType": {
240 "id": 0,
241 "displayId": "string",
242 "status": "CREATED",
243 "name": "string",
244 "erpSystemId": 0
245 },
246 "internalOrder": {
247 "id": 0,
248 "displayId": "string",
249 "status": "CREATED",
250 "name": "string",
251 "erpSystemId": 0,
252 "internalOrderTypeId": 0
253 },
254 "additionalCurrencies": [
255 {}
256 ],
257 "scheduledPaymentMatches": [
258 {}
259 ],
260 "goodsReceiptLineItemLinks": [
261 {}
262 ],
263 "invoiceId": 0,
264 "invoiceDisplayId": "string",
265 "invoiceState": "INV_DRAFT",
266 "vendorPaymentId": 0,
267 "purchaseOrderLineItemId": 0,
268 "netAmount": 0,
269 "allowsSystemGenerateNewId": true,
270 "numberRangeIdentifierValue": "string",
271 "numberRangeIdentifierType": {
272 "name": "string"
273 },
274 "numberRangeType": {
275 "name": "string"
276 }
277 }
278 ],
279 "goodsReceiptLineItems": [
280 {
281 "id": 0,
282 "displayId": "string",
283 "quantity": 0,
284 "invoicedQuantity": 0,
285 "description": "string",
286 "expenseCategory": {
287 "id": 0,
288 "displayId": "string",
289 "status": "CREATED",
290 "name": "string",
291 "expenseCategoryType": "PAYMENT"
292 },
293 "goodsReceiptId": 0,
294 "goodsReceiptDisplayId": "string",
295 "goodsReceiptState": "INV_DRAFT",
296 "purchaseOrderLineItemId": 0,
297 "invoiceLineItemLinks": [
298 {}
299 ],
300 "availableQuantity": 0,
301 "allowsSystemGenerateNewId": true,
302 "numberRangeIdentifierValue": "string",
303 "numberRangeIdentifierType": {
304 "name": "string"
305 },
306 "numberRangeType": {
307 "name": "string"
308 }
309 }
310 ],
311 "vendorPaymentId": 0,
312 "purchaseRequisitionLineItemId": 0,
313 "purchaseRequisitionDisplayId": "string",
314 "purchaseRequisitionLineItemAvailableQuantity": 0,
315 "remainingQuantity": 0,
316 "availableQuantity": 0,
317 "allowsSystemGenerateNewId": true,
318 "numberRangeIdentifierValue": "string",
319 "numberRangeIdentifierType": {
320 "name": "string"
321 },
322 "numberRangeType": {
323 "name": "string"
324 }
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "purchaseOrders": [
339 {
340 "id": 0,
341 "displayId": "string",
342 "state": "INV_DRAFT",
343 "issueDate": "2019-08-24",
344 "expectedDeliveryDate": "2019-08-24",
345 "name": "string",
346 "shippingAddress": "string",
347 "notes": "string",
348 "netAmount": 0,
349 "taxAmount": 0,
350 "externalPurchaseOrderDisplayId": "string",
351 "vendor": {
352 "id": 0,
353 "displayId": "string",
354 "status": "CREATED",
355 "name": "string",
356 "erpSystemDisplayId": "string"
357 },
358 "currency": {
359 "id": 0,
360 "displayId": "string",
361 "status": "CREATED",
362 "name": "string",
363 "decimalPoints": 0
364 },
365 "company": {
366 "id": 0,
367 "displayId": "string",
368 "status": "CREATED",
369 "erpSystemId": 0,
370 "erpSystemDisplayId": "string",
371 "countryId": 0,
372 "countryDisplayId": "string",
373 "name": "string",
374 "postingPeriodVariantId": 0,
375 "fiscalVariantId": 0
376 },
377 "purchaseOrderLineItems": [
378 {
379 "id": 0,
380 "displayId": "string",
381 "quantity": 0,
382 "allocatedQuantity": 0,
383 "receivedQuantity": 0,
384 "unitPrice": 0,
385 "description": "string",
386 "expenseCategory": {
387 "id": 0,
388 "displayId": "string",
389 "status": "CREATED",
390 "name": "string",
391 "expenseCategoryType": "PAYMENT"
392 },
393 "costCenter": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string",
398 "erpSystemId": 0
399 },
400 "profitCenter": {
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 "taxJurisdiction": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0,
415 "schema": "string",
416 "countryDisplayId": "string"
417 },
418 "taxCode": {
419 "id": 0,
420 "displayId": "string",
421 "status": "CREATED",
422 "name": "string",
423 "erpSystemId": 0
424 },
425 "taxLineItems": [
426 {
427 "id": 0,
428 "taxRate": 0.1,
429 "taxAmount": 0,
430 "taxType": "string",
431 "purchaseOrderLineItemId": 0
432 }
433 ],
434 "purchaseOrderId": 0,
435 "purchaseOrderDisplayId": "string",
436 "purchaseOrderState": "INV_DRAFT",
437 "invoiceLineItems": [
438 {
439 "id": 0,
440 "displayId": "string",
441 "expenseCategory": {
442 "id": 0,
443 "displayId": "string",
444 "status": "CREATED",
445 "name": "string",
446 "expenseCategoryType": "PAYMENT"
447 },
448 "description": "string",
449 "unitOfMeasure": {
450 "id": 0,
451 "displayId": "string",
452 "status": "CREATED",
453 "name": "string",
454 "erpSystemId": 0
455 },
456 "quantity": 0,
457 "unitPrice": 0,
458 "taxJurisdiction": {
459 "id": 0,
460 "displayId": "string",
461 "status": "CREATED",
462 "name": "string",
463 "erpSystemId": 0,
464 "schema": "string",
465 "countryDisplayId": "string"
466 },
467 "taxCode": {
468 "id": 0,
469 "displayId": "string",
470 "status": "CREATED",
471 "name": "string",
472 "erpSystemId": 0
473 },
474 "taxExpenseAccount": {
475 "id": 0,
476 "displayId": "string",
477 "generalLedgerAccountName": "string",
478 "generalLedgerAccountCode": "string",
479 "openItemManagement": true,
480 "accountCategory": "BALANCESHEET",
481 "shortName": "string",
482 "longName": "string"
483 },
484 "taxLineItems": [
485 {}
486 ],
487 "workBreakdownStructure": {
488 "id": 0,
489 "displayId": "string",
490 "status": "CREATED",
491 "name": "string",
492 "erpSystemId": 0
493 },
494 "costCenter": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "profitCenter": {
502 "id": 0,
503 "displayId": "string",
504 "status": "CREATED",
505 "name": "string",
506 "validTo": "2019-08-24",
507 "erpSystemId": 0,
508 "erpSystemDisplayId": "string"
509 },
510 "functionalArea": {
511 "id": 0,
512 "displayId": "string",
513 "status": "CREATED",
514 "name": "string",
515 "erpSystemId": 0
516 },
517 "businessArea": {
518 "id": 0,
519 "displayId": "string",
520 "status": "CREATED",
521 "name": "string",
522 "erpSystemId": 0
523 },
524 "segment": {
525 "id": 0,
526 "displayId": "string",
527 "status": "CREATED",
528 "name": "string",
529 "erpSystemId": 0
530 },
531 "network": {
532 "id": 0,
533 "displayId": "string",
534 "status": "CREATED",
535 "name": "string",
536 "erpSystemId": 0
537 },
538 "internalOrderType": {
539 "id": 0,
540 "displayId": "string",
541 "status": "CREATED",
542 "name": "string",
543 "erpSystemId": 0
544 },
545 "internalOrder": {
546 "id": 0,
547 "displayId": "string",
548 "status": "CREATED",
549 "name": "string",
550 "erpSystemId": 0,
551 "internalOrderTypeId": 0
552 },
553 "additionalCurrencies": [
554 {}
555 ],
556 "scheduledPaymentMatches": [
557 {}
558 ],
559 "goodsReceiptLineItemLinks": [
560 {}
561 ],
562 "invoiceId": 0,
563 "invoiceDisplayId": "string",
564 "invoiceState": "INV_DRAFT",
565 "vendorPaymentId": 0,
566 "purchaseOrderLineItemId": 0,
567 "netAmount": 0,
568 "allowsSystemGenerateNewId": true,
569 "numberRangeIdentifierValue": "string",
570 "numberRangeIdentifierType": {
571 "name": "string"
572 },
573 "numberRangeType": {
574 "name": "string"
575 }
576 }
577 ],
578 "goodsReceiptLineItems": [
579 {
580 "id": 0,
581 "displayId": "string",
582 "quantity": 0,
583 "invoicedQuantity": 0,
584 "description": "string",
585 "expenseCategory": {
586 "id": 0,
587 "displayId": "string",
588 "status": "CREATED",
589 "name": "string",
590 "expenseCategoryType": "PAYMENT"
591 },
592 "goodsReceiptId": 0,
593 "goodsReceiptDisplayId": "string",
594 "goodsReceiptState": "INV_DRAFT",
595 "purchaseOrderLineItemId": 0,
596 "invoiceLineItemLinks": [
597 {}
598 ],
599 "availableQuantity": 0,
600 "allowsSystemGenerateNewId": true,
601 "numberRangeIdentifierValue": "string",
602 "numberRangeIdentifierType": {
603 "name": "string"
604 },
605 "numberRangeType": {
606 "name": "string"
607 }
608 }
609 ],
610 "vendorPaymentId": 0,
611 "purchaseRequisitionLineItemId": 0,
612 "purchaseRequisitionDisplayId": "string",
613 "purchaseRequisitionLineItemAvailableQuantity": 0,
614 "remainingQuantity": 0,
615 "availableQuantity": 0,
616 "allowsSystemGenerateNewId": true,
617 "numberRangeIdentifierValue": "string",
618 "numberRangeIdentifierType": {
619 "name": "string"
620 },
621 "numberRangeType": {
622 "name": "string"
623 }
624 }
625 ],
626 "purchaseRequisitionIds": [
627 0
628 ],
629 "purchaseRequisitionDisplayIds": [
630 "string"
631 ],
632 "invoices": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "name": "string",
637 "invoiceType": "VENDOR_INV",
638 "state": "INV_DRAFT",
639 "externalDocumentNumber": "string",
640 "purchaseOrderReference": "string",
641 "invoiceDate": "2019-08-24",
642 "dueDate": "2019-08-24",
643 "notes": "string",
644 "billingPeriodFromDate": "2019-08-24",
645 "billingPeriodToDate": "2019-08-24",
646 "currency": {
647 "id": 0,
648 "displayId": "string",
649 "status": "CREATED",
650 "name": "string",
651 "decimalPoints": 0
652 },
653 "vendor": {
654 "id": 0,
655 "displayId": "string",
656 "status": "CREATED",
657 "name": "string",
658 "erpSystemDisplayId": "string"
659 },
660 "company": {
661 "id": 0,
662 "displayId": "string",
663 "status": "CREATED",
664 "erpSystemId": 0,
665 "erpSystemDisplayId": "string",
666 "countryId": 0,
667 "countryDisplayId": "string",
668 "name": "string",
669 "postingPeriodVariantId": 0,
670 "fiscalVariantId": 0
671 },
672 "netAmount": 0,
673 "taxAmount": 0,
674 "totalAmount": 0,
675 "netAmountBalance": 0,
676 "taxAmountBalance": 0,
677 "paymentTerm": {
678 "id": 0,
679 "displayId": "string",
680 "status": "CREATED",
681 "name": "string"
682 },
683 "paymentMethod": {
684 "id": 0,
685 "displayId": "string",
686 "status": "CREATED",
687 "name": "string",
688 "type": "string"
689 },
690 "paymentBlock": {
691 "id": 0,
692 "displayId": "string",
693 "status": "CREATED",
694 "name": "string"
695 },
696 "defaultCostCenter": {
697 "id": 0,
698 "displayId": "string",
699 "status": "CREATED",
700 "name": "string",
701 "erpSystemId": 0
702 },
703 "defaultProfitCenter": {
704 "id": 0,
705 "displayId": "string",
706 "status": "CREATED",
707 "name": "string",
708 "validTo": "2019-08-24",
709 "erpSystemId": 0,
710 "erpSystemDisplayId": "string"
711 },
712 "invoiceLineItems": [
713 {
714 "id": 0,
715 "displayId": "string",
716 "expenseCategory": {
717 "id": 0,
718 "displayId": "string",
719 "status": "CREATED",
720 "name": "string",
721 "expenseCategoryType": "PAYMENT"
722 },
723 "description": "string",
724 "unitOfMeasure": {
725 "id": 0,
726 "displayId": "string",
727 "status": "CREATED",
728 "name": "string",
729 "erpSystemId": 0
730 },
731 "quantity": 0,
732 "unitPrice": 0,
733 "taxJurisdiction": {
734 "id": 0,
735 "displayId": "string",
736 "status": "CREATED",
737 "name": "string",
738 "erpSystemId": 0,
739 "schema": "string",
740 "countryDisplayId": "string"
741 },
742 "taxCode": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "erpSystemId": 0
748 },
749 "taxExpenseAccount": {
750 "id": 0,
751 "displayId": "string",
752 "generalLedgerAccountName": "string",
753 "generalLedgerAccountCode": "string",
754 "openItemManagement": true,
755 "accountCategory": "BALANCESHEET",
756 "shortName": "string",
757 "longName": "string"
758 },
759 "taxLineItems": [
760 {}
761 ],
762 "workBreakdownStructure": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "erpSystemId": 0
768 },
769 "costCenter": {
770 "id": 0,
771 "displayId": "string",
772 "status": "CREATED",
773 "name": "string",
774 "erpSystemId": 0
775 },
776 "profitCenter": {
777 "id": 0,
778 "displayId": "string",
779 "status": "CREATED",
780 "name": "string",
781 "validTo": "2019-08-24",
782 "erpSystemId": 0,
783 "erpSystemDisplayId": "string"
784 },
785 "functionalArea": {
786 "id": 0,
787 "displayId": "string",
788 "status": "CREATED",
789 "name": "string",
790 "erpSystemId": 0
791 },
792 "businessArea": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0
798 },
799 "segment": {
800 "id": 0,
801 "displayId": "string",
802 "status": "CREATED",
803 "name": "string",
804 "erpSystemId": 0
805 },
806 "network": {
807 "id": 0,
808 "displayId": "string",
809 "status": "CREATED",
810 "name": "string",
811 "erpSystemId": 0
812 },
813 "internalOrderType": {
814 "id": 0,
815 "displayId": "string",
816 "status": "CREATED",
817 "name": "string",
818 "erpSystemId": 0
819 },
820 "internalOrder": {
821 "id": 0,
822 "displayId": "string",
823 "status": "CREATED",
824 "name": "string",
825 "erpSystemId": 0,
826 "internalOrderTypeId": 0
827 },
828 "additionalCurrencies": [
829 {}
830 ],
831 "scheduledPaymentMatches": [
832 {}
833 ],
834 "goodsReceiptLineItemLinks": [
835 {}
836 ],
837 "invoiceId": 0,
838 "invoiceDisplayId": "string",
839 "invoiceState": "INV_DRAFT",
840 "vendorPaymentId": 0,
841 "purchaseOrderLineItemId": 0,
842 "netAmount": 0,
843 "allowsSystemGenerateNewId": true,
844 "numberRangeIdentifierValue": "string",
845 "numberRangeIdentifierType": {
846 "name": "string"
847 },
848 "numberRangeType": {
849 "name": "string"
850 }
851 }
852 ],
853 "workspaceId": 0,
854 "workspaceDisplayId": "string",
855 "workspaceName": "string",
856 "workspaceState": "INV_DRAFT",
857 "remainingNetAmount": 0,
858 "remainingTaxAmount": 0,
859 "remainingTotalAmount": 0,
860 "pendingPaymentCount": 0,
861 "allPaymentsPosted": true,
862 "approvalInfo": {
863 "approverUsername": "string",
864 "approvedAt": "2019-08-24T14:15:22Z"
865 },
866 "rejectionReason": "string",
867 "allowsSystemGenerateNewId": true,
868 "numberRangeIdentifierValue": "string",
869 "numberRangeIdentifierType": {
870 "name": "string"
871 },
872 "numberRangeType": {
873 "name": "string"
874 }
875 }
876 ],
877 "rejectionReason": "string",
878 "allowsSystemGenerateNewId": true,
879 "numberRangeIdentifierValue": "string",
880 "numberRangeIdentifierType": {
881 "name": "string"
882 },
883 "numberRangeType": {
884 "name": "string"
885 }
886 }
887 ],
888 "approvalInfo": {
889 "approverUsername": "string",
890 "approvedAt": "2019-08-24T14:15:22Z"
891 },
892 "rejectionReason": "string",
893 "allowsSystemGenerateNewId": true,
894 "numberRangeIdentifierValue": "string",
895 "numberRangeIdentifierType": {
896 "name": "string"
897 },
898 "numberRangeType": {
899 "name": "string"
900 }
901 }
902 ],
903 "number": 0,
904 "sort": {
905 "unsorted": true,
906 "sorted": true,
907 "empty": true
908 },
909 "first": true,
910 "last": true,
911 "empty": true
912}
Create A Resource¶
HTTP Request
POST /api/v1/purchase-requisition
📋 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 requisition details, including item descriptions, quantities, and associated cost information for procurement processing. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "shippingAddress": "string",
5 "state": "INV_DRAFT",
6 "notes": "string",
7 "currency": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string",
12 "decimalPoints": 0
13 },
14 "company": {
15 "id": 0,
16 "displayId": "string",
17 "status": "CREATED",
18 "erpSystemId": 0,
19 "erpSystemDisplayId": "string",
20 "countryId": 0,
21 "countryDisplayId": "string",
22 "name": "string",
23 "postingPeriodVariantId": 0,
24 "fiscalVariantId": 0
25 },
26 "totalAmount": 0,
27 "purchaseRequisitionItems": [
28 {
29 "id": 0,
30 "displayId": "string",
31 "quantity": 0,
32 "allocatedQuantity": 0,
33 "unitPrice": 0,
34 "description": "string",
35 "expenseCategory": {
36 "id": 0,
37 "displayId": "string",
38 "status": "CREATED",
39 "name": "string",
40 "expenseCategoryType": "PAYMENT"
41 },
42 "costCenter": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "erpSystemId": 0
48 },
49 "profitCenter": {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "validTo": "2019-08-24",
55 "erpSystemId": 0,
56 "erpSystemDisplayId": "string"
57 },
58 "purchaseRequisitionId": 0,
59 "purchaseRequisitionDisplayId": "string",
60 "purchaseOrderLineItems": [
61 {
62 "id": 0,
63 "displayId": "string",
64 "quantity": 0,
65 "allocatedQuantity": 0,
66 "receivedQuantity": 0,
67 "unitPrice": 0,
68 "description": "string",
69 "expenseCategory": {
70 "id": 0,
71 "displayId": "string",
72 "status": "CREATED",
73 "name": "string",
74 "expenseCategoryType": "PAYMENT"
75 },
76 "costCenter": {
77 "id": 0,
78 "displayId": "string",
79 "status": "CREATED",
80 "name": "string",
81 "erpSystemId": 0
82 },
83 "profitCenter": {
84 "id": 0,
85 "displayId": "string",
86 "status": "CREATED",
87 "name": "string",
88 "validTo": "2019-08-24",
89 "erpSystemId": 0,
90 "erpSystemDisplayId": "string"
91 },
92 "taxJurisdiction": {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "erpSystemId": 0,
98 "schema": "string",
99 "countryDisplayId": "string"
100 },
101 "taxCode": {
102 "id": 0,
103 "displayId": "string",
104 "status": "CREATED",
105 "name": "string",
106 "erpSystemId": 0
107 },
108 "taxLineItems": [
109 {
110 "id": 0,
111 "taxRate": 0.1,
112 "taxAmount": 0,
113 "taxType": "string",
114 "purchaseOrderLineItemId": 0
115 }
116 ],
117 "purchaseOrderId": 0,
118 "purchaseOrderDisplayId": "string",
119 "purchaseOrderState": "INV_DRAFT",
120 "invoiceLineItems": [
121 {
122 "id": 0,
123 "displayId": "string",
124 "expenseCategory": {
125 "id": 0,
126 "displayId": "string",
127 "status": "CREATED",
128 "name": "string",
129 "expenseCategoryType": "PAYMENT"
130 },
131 "description": "string",
132 "unitOfMeasure": {
133 "id": 0,
134 "displayId": "string",
135 "status": "CREATED",
136 "name": "string",
137 "erpSystemId": 0
138 },
139 "quantity": 0,
140 "unitPrice": 0,
141 "taxJurisdiction": {
142 "id": 0,
143 "displayId": "string",
144 "status": "CREATED",
145 "name": "string",
146 "erpSystemId": 0,
147 "schema": "string",
148 "countryDisplayId": "string"
149 },
150 "taxCode": {
151 "id": 0,
152 "displayId": "string",
153 "status": "CREATED",
154 "name": "string",
155 "erpSystemId": 0
156 },
157 "taxExpenseAccount": {
158 "id": 0,
159 "displayId": "string",
160 "generalLedgerAccountName": "string",
161 "generalLedgerAccountCode": "string",
162 "openItemManagement": true,
163 "accountCategory": "BALANCESHEET",
164 "shortName": "string",
165 "longName": "string"
166 },
167 "taxLineItems": [
168 {
169 "id": 0,
170 "taxRate": 0.1,
171 "taxAmount": 0,
172 "taxType": "string",
173 "invoiceLineItemId": 0
174 }
175 ],
176 "workBreakdownStructure": {
177 "id": 0,
178 "displayId": "string",
179 "status": "CREATED",
180 "name": "string",
181 "erpSystemId": 0
182 },
183 "costCenter": {
184 "id": 0,
185 "displayId": "string",
186 "status": "CREATED",
187 "name": "string",
188 "erpSystemId": 0
189 },
190 "profitCenter": {
191 "id": 0,
192 "displayId": "string",
193 "status": "CREATED",
194 "name": "string",
195 "validTo": "2019-08-24",
196 "erpSystemId": 0,
197 "erpSystemDisplayId": "string"
198 },
199 "functionalArea": {
200 "id": 0,
201 "displayId": "string",
202 "status": "CREATED",
203 "name": "string",
204 "erpSystemId": 0
205 },
206 "businessArea": {
207 "id": 0,
208 "displayId": "string",
209 "status": "CREATED",
210 "name": "string",
211 "erpSystemId": 0
212 },
213 "segment": {
214 "id": 0,
215 "displayId": "string",
216 "status": "CREATED",
217 "name": "string",
218 "erpSystemId": 0
219 },
220 "network": {
221 "id": 0,
222 "displayId": "string",
223 "status": "CREATED",
224 "name": "string",
225 "erpSystemId": 0
226 },
227 "internalOrderType": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "erpSystemId": 0
233 },
234 "internalOrder": {
235 "id": 0,
236 "displayId": "string",
237 "status": "CREATED",
238 "name": "string",
239 "erpSystemId": 0,
240 "internalOrderTypeId": 0
241 },
242 "additionalCurrencies": [
243 {
244 "id": 0,
245 "amount": 0,
246 "currency": {
247 "id": 0,
248 "displayId": "string",
249 "status": "CREATED",
250 "name": "string",
251 "decimalPoints": 0
252 },
253 "conversionRate": 0,
254 "conversionDate": "2019-08-24",
255 "translationDateType": "DOCUMENT_DATE",
256 "amountType": "NET_AMOUNT",
257 "currencyDefinitionType": "CONTRACT_CURRENCY",
258 "invoiceEntryId": 0,
259 "invoiceEntryDisplayId": "string"
260 }
261 ],
262 "scheduledPaymentMatches": [
263 {
264 "id": 0,
265 "fromId": 0,
266 "toId": 0,
267 "amount": 0
268 }
269 ],
270 "goodsReceiptLineItemLinks": [
271 {
272 "id": 0,
273 "fromId": 0,
274 "toId": 0,
275 "linkedQuantity": 0
276 }
277 ],
278 "invoiceId": 0,
279 "invoiceDisplayId": "string",
280 "invoiceState": "INV_DRAFT",
281 "vendorPaymentId": 0,
282 "purchaseOrderLineItemId": 0,
283 "netAmount": 0,
284 "allowsSystemGenerateNewId": true,
285 "numberRangeIdentifierValue": "string",
286 "numberRangeIdentifierType": {
287 "name": "string"
288 },
289 "numberRangeType": {
290 "name": "string"
291 }
292 }
293 ],
294 "goodsReceiptLineItems": [
295 {
296 "id": 0,
297 "displayId": "string",
298 "quantity": 0,
299 "invoicedQuantity": 0,
300 "description": "string",
301 "expenseCategory": {
302 "id": 0,
303 "displayId": "string",
304 "status": "CREATED",
305 "name": "string",
306 "expenseCategoryType": "PAYMENT"
307 },
308 "goodsReceiptId": 0,
309 "goodsReceiptDisplayId": "string",
310 "goodsReceiptState": "INV_DRAFT",
311 "purchaseOrderLineItemId": 0,
312 "invoiceLineItemLinks": [
313 {
314 "id": 0,
315 "fromId": 0,
316 "toId": 0,
317 "linkedQuantity": 0
318 }
319 ],
320 "allowsSystemGenerateNewId": true,
321 "numberRangeIdentifierValue": "string",
322 "numberRangeIdentifierType": {
323 "name": "string"
324 },
325 "numberRangeType": {
326 "name": "string"
327 }
328 }
329 ],
330 "vendorPaymentId": 0,
331 "purchaseRequisitionLineItemId": 0,
332 "purchaseRequisitionDisplayId": "string",
333 "purchaseRequisitionLineItemAvailableQuantity": 0,
334 "allowsSystemGenerateNewId": true,
335 "numberRangeIdentifierValue": "string",
336 "numberRangeIdentifierType": {
337 "name": "string"
338 },
339 "numberRangeType": {
340 "name": "string"
341 }
342 }
343 ],
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "purchaseOrders": [
355 {
356 "id": 0,
357 "displayId": "string",
358 "state": "INV_DRAFT",
359 "issueDate": "2019-08-24",
360 "expectedDeliveryDate": "2019-08-24",
361 "name": "string",
362 "shippingAddress": "string",
363 "notes": "string",
364 "netAmount": 0,
365 "taxAmount": 0,
366 "externalPurchaseOrderDisplayId": "string",
367 "vendor": {
368 "id": 0,
369 "displayId": "string",
370 "status": "CREATED",
371 "name": "string",
372 "erpSystemDisplayId": "string"
373 },
374 "currency": {
375 "id": 0,
376 "displayId": "string",
377 "status": "CREATED",
378 "name": "string",
379 "decimalPoints": 0
380 },
381 "company": {
382 "id": 0,
383 "displayId": "string",
384 "status": "CREATED",
385 "erpSystemId": 0,
386 "erpSystemDisplayId": "string",
387 "countryId": 0,
388 "countryDisplayId": "string",
389 "name": "string",
390 "postingPeriodVariantId": 0,
391 "fiscalVariantId": 0
392 },
393 "purchaseOrderLineItems": [
394 {
395 "id": 0,
396 "displayId": "string",
397 "quantity": 0,
398 "allocatedQuantity": 0,
399 "receivedQuantity": 0,
400 "unitPrice": 0,
401 "description": "string",
402 "expenseCategory": {
403 "id": 0,
404 "displayId": "string",
405 "status": "CREATED",
406 "name": "string",
407 "expenseCategoryType": "PAYMENT"
408 },
409 "costCenter": {
410 "id": 0,
411 "displayId": "string",
412 "status": "CREATED",
413 "name": "string",
414 "erpSystemId": 0
415 },
416 "profitCenter": {
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 "taxJurisdiction": {
426 "id": 0,
427 "displayId": "string",
428 "status": "CREATED",
429 "name": "string",
430 "erpSystemId": 0,
431 "schema": "string",
432 "countryDisplayId": "string"
433 },
434 "taxCode": {
435 "id": 0,
436 "displayId": "string",
437 "status": "CREATED",
438 "name": "string",
439 "erpSystemId": 0
440 },
441 "taxLineItems": [
442 {
443 "id": 0,
444 "taxRate": 0.1,
445 "taxAmount": 0,
446 "taxType": "string",
447 "purchaseOrderLineItemId": 0
448 }
449 ],
450 "purchaseOrderId": 0,
451 "purchaseOrderDisplayId": "string",
452 "purchaseOrderState": "INV_DRAFT",
453 "invoiceLineItems": [
454 {
455 "id": 0,
456 "displayId": "string",
457 "expenseCategory": {
458 "id": 0,
459 "displayId": "string",
460 "status": "CREATED",
461 "name": "string",
462 "expenseCategoryType": "PAYMENT"
463 },
464 "description": "string",
465 "unitOfMeasure": {
466 "id": 0,
467 "displayId": "string",
468 "status": "CREATED",
469 "name": "string",
470 "erpSystemId": 0
471 },
472 "quantity": 0,
473 "unitPrice": 0,
474 "taxJurisdiction": {
475 "id": 0,
476 "displayId": "string",
477 "status": "CREATED",
478 "name": "string",
479 "erpSystemId": 0,
480 "schema": "string",
481 "countryDisplayId": "string"
482 },
483 "taxCode": {
484 "id": 0,
485 "displayId": "string",
486 "status": "CREATED",
487 "name": "string",
488 "erpSystemId": 0
489 },
490 "taxExpenseAccount": {
491 "id": 0,
492 "displayId": "string",
493 "generalLedgerAccountName": "string",
494 "generalLedgerAccountCode": "string",
495 "openItemManagement": true,
496 "accountCategory": "BALANCESHEET",
497 "shortName": "string",
498 "longName": "string"
499 },
500 "taxLineItems": [
501 {
502 "id": 0,
503 "taxRate": 0.1,
504 "taxAmount": 0,
505 "taxType": "string",
506 "invoiceLineItemId": 0
507 }
508 ],
509 "workBreakdownStructure": {
510 "id": 0,
511 "displayId": "string",
512 "status": "CREATED",
513 "name": "string",
514 "erpSystemId": 0
515 },
516 "costCenter": {
517 "id": 0,
518 "displayId": "string",
519 "status": "CREATED",
520 "name": "string",
521 "erpSystemId": 0
522 },
523 "profitCenter": {
524 "id": 0,
525 "displayId": "string",
526 "status": "CREATED",
527 "name": "string",
528 "validTo": "2019-08-24",
529 "erpSystemId": 0,
530 "erpSystemDisplayId": "string"
531 },
532 "functionalArea": {
533 "id": 0,
534 "displayId": "string",
535 "status": "CREATED",
536 "name": "string",
537 "erpSystemId": 0
538 },
539 "businessArea": {
540 "id": 0,
541 "displayId": "string",
542 "status": "CREATED",
543 "name": "string",
544 "erpSystemId": 0
545 },
546 "segment": {
547 "id": 0,
548 "displayId": "string",
549 "status": "CREATED",
550 "name": "string",
551 "erpSystemId": 0
552 },
553 "network": {
554 "id": 0,
555 "displayId": "string",
556 "status": "CREATED",
557 "name": "string",
558 "erpSystemId": 0
559 },
560 "internalOrderType": {
561 "id": 0,
562 "displayId": "string",
563 "status": "CREATED",
564 "name": "string",
565 "erpSystemId": 0
566 },
567 "internalOrder": {
568 "id": 0,
569 "displayId": "string",
570 "status": "CREATED",
571 "name": "string",
572 "erpSystemId": 0,
573 "internalOrderTypeId": 0
574 },
575 "additionalCurrencies": [
576 {
577 "id": 0,
578 "amount": 0,
579 "currency": {
580 "id": 0,
581 "displayId": "string",
582 "status": "CREATED",
583 "name": "string",
584 "decimalPoints": 0
585 },
586 "conversionRate": 0,
587 "conversionDate": "2019-08-24",
588 "translationDateType": "DOCUMENT_DATE",
589 "amountType": "NET_AMOUNT",
590 "currencyDefinitionType": "CONTRACT_CURRENCY",
591 "invoiceEntryId": 0,
592 "invoiceEntryDisplayId": "string"
593 }
594 ],
595 "scheduledPaymentMatches": [
596 {
597 "id": 0,
598 "fromId": 0,
599 "toId": 0,
600 "amount": 0
601 }
602 ],
603 "goodsReceiptLineItemLinks": [
604 {
605 "id": 0,
606 "fromId": 0,
607 "toId": 0,
608 "linkedQuantity": 0
609 }
610 ],
611 "invoiceId": 0,
612 "invoiceDisplayId": "string",
613 "invoiceState": "INV_DRAFT",
614 "vendorPaymentId": 0,
615 "purchaseOrderLineItemId": 0,
616 "netAmount": 0,
617 "allowsSystemGenerateNewId": true,
618 "numberRangeIdentifierValue": "string",
619 "numberRangeIdentifierType": {
620 "name": "string"
621 },
622 "numberRangeType": {
623 "name": "string"
624 }
625 }
626 ],
627 "goodsReceiptLineItems": [
628 {
629 "id": 0,
630 "displayId": "string",
631 "quantity": 0,
632 "invoicedQuantity": 0,
633 "description": "string",
634 "expenseCategory": {
635 "id": 0,
636 "displayId": "string",
637 "status": "CREATED",
638 "name": "string",
639 "expenseCategoryType": "PAYMENT"
640 },
641 "goodsReceiptId": 0,
642 "goodsReceiptDisplayId": "string",
643 "goodsReceiptState": "INV_DRAFT",
644 "purchaseOrderLineItemId": 0,
645 "invoiceLineItemLinks": [
646 {
647 "id": 0,
648 "fromId": 0,
649 "toId": 0,
650 "linkedQuantity": 0
651 }
652 ],
653 "allowsSystemGenerateNewId": true,
654 "numberRangeIdentifierValue": "string",
655 "numberRangeIdentifierType": {
656 "name": "string"
657 },
658 "numberRangeType": {
659 "name": "string"
660 }
661 }
662 ],
663 "vendorPaymentId": 0,
664 "purchaseRequisitionLineItemId": 0,
665 "purchaseRequisitionDisplayId": "string",
666 "purchaseRequisitionLineItemAvailableQuantity": 0,
667 "allowsSystemGenerateNewId": true,
668 "numberRangeIdentifierValue": "string",
669 "numberRangeIdentifierType": {
670 "name": "string"
671 },
672 "numberRangeType": {
673 "name": "string"
674 }
675 }
676 ],
677 "purchaseRequisitionIds": [
678 0
679 ],
680 "purchaseRequisitionDisplayIds": [
681 "string"
682 ],
683 "invoices": [
684 {
685 "id": 0,
686 "displayId": "string",
687 "name": "string",
688 "invoiceType": "VENDOR_INV",
689 "state": "INV_DRAFT",
690 "externalDocumentNumber": "string",
691 "purchaseOrderReference": "string",
692 "invoiceDate": "2019-08-24",
693 "dueDate": "2019-08-24",
694 "notes": "string",
695 "billingPeriodFromDate": "2019-08-24",
696 "billingPeriodToDate": "2019-08-24",
697 "currency": {
698 "id": 0,
699 "displayId": "string",
700 "status": "CREATED",
701 "name": "string",
702 "decimalPoints": 0
703 },
704 "vendor": {
705 "id": 0,
706 "displayId": "string",
707 "status": "CREATED",
708 "name": "string",
709 "erpSystemDisplayId": "string"
710 },
711 "company": {
712 "id": 0,
713 "displayId": "string",
714 "status": "CREATED",
715 "erpSystemId": 0,
716 "erpSystemDisplayId": "string",
717 "countryId": 0,
718 "countryDisplayId": "string",
719 "name": "string",
720 "postingPeriodVariantId": 0,
721 "fiscalVariantId": 0
722 },
723 "netAmount": 0,
724 "taxAmount": 0,
725 "totalAmount": 0,
726 "netAmountBalance": 0,
727 "taxAmountBalance": 0,
728 "paymentTerm": {
729 "id": 0,
730 "displayId": "string",
731 "status": "CREATED",
732 "name": "string"
733 },
734 "paymentMethod": {
735 "id": 0,
736 "displayId": "string",
737 "status": "CREATED",
738 "name": "string",
739 "type": "string"
740 },
741 "paymentBlock": {
742 "id": 0,
743 "displayId": "string",
744 "status": "CREATED",
745 "name": "string"
746 },
747 "defaultCostCenter": {
748 "id": 0,
749 "displayId": "string",
750 "status": "CREATED",
751 "name": "string",
752 "erpSystemId": 0
753 },
754 "defaultProfitCenter": {
755 "id": 0,
756 "displayId": "string",
757 "status": "CREATED",
758 "name": "string",
759 "validTo": "2019-08-24",
760 "erpSystemId": 0,
761 "erpSystemDisplayId": "string"
762 },
763 "invoiceLineItems": [
764 {
765 "id": 0,
766 "displayId": "string",
767 "expenseCategory": {
768 "id": 0,
769 "displayId": "string",
770 "status": "CREATED",
771 "name": "string",
772 "expenseCategoryType": "PAYMENT"
773 },
774 "description": "string",
775 "unitOfMeasure": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "erpSystemId": 0
781 },
782 "quantity": 0,
783 "unitPrice": 0,
784 "taxJurisdiction": {
785 "id": 0,
786 "displayId": "string",
787 "status": "CREATED",
788 "name": "string",
789 "erpSystemId": 0,
790 "schema": "string",
791 "countryDisplayId": "string"
792 },
793 "taxCode": {
794 "id": 0,
795 "displayId": "string",
796 "status": "CREATED",
797 "name": "string",
798 "erpSystemId": 0
799 },
800 "taxExpenseAccount": {
801 "id": 0,
802 "displayId": "string",
803 "generalLedgerAccountName": "string",
804 "generalLedgerAccountCode": "string",
805 "openItemManagement": true,
806 "accountCategory": "BALANCESHEET",
807 "shortName": "string",
808 "longName": "string"
809 },
810 "taxLineItems": [
811 {
812 "id": 0,
813 "taxRate": 0.1,
814 "taxAmount": 0,
815 "taxType": "string",
816 "invoiceLineItemId": 0
817 }
818 ],
819 "workBreakdownStructure": {
820 "id": 0,
821 "displayId": "string",
822 "status": "CREATED",
823 "name": "string",
824 "erpSystemId": 0
825 },
826 "costCenter": {
827 "id": 0,
828 "displayId": "string",
829 "status": "CREATED",
830 "name": "string",
831 "erpSystemId": 0
832 },
833 "profitCenter": {
834 "id": 0,
835 "displayId": "string",
836 "status": "CREATED",
837 "name": "string",
838 "validTo": "2019-08-24",
839 "erpSystemId": 0,
840 "erpSystemDisplayId": "string"
841 },
842 "functionalArea": {
843 "id": 0,
844 "displayId": "string",
845 "status": "CREATED",
846 "name": "string",
847 "erpSystemId": 0
848 },
849 "businessArea": {
850 "id": 0,
851 "displayId": "string",
852 "status": "CREATED",
853 "name": "string",
854 "erpSystemId": 0
855 },
856 "segment": {
857 "id": 0,
858 "displayId": "string",
859 "status": "CREATED",
860 "name": "string",
861 "erpSystemId": 0
862 },
863 "network": {
864 "id": 0,
865 "displayId": "string",
866 "status": "CREATED",
867 "name": "string",
868 "erpSystemId": 0
869 },
870 "internalOrderType": {
871 "id": 0,
872 "displayId": "string",
873 "status": "CREATED",
874 "name": "string",
875 "erpSystemId": 0
876 },
877 "internalOrder": {
878 "id": 0,
879 "displayId": "string",
880 "status": "CREATED",
881 "name": "string",
882 "erpSystemId": 0,
883 "internalOrderTypeId": 0
884 },
885 "additionalCurrencies": [
886 {
887 "id": 0,
888 "amount": 0,
889 "currency": {
890 "id": 0,
891 "displayId": "string",
892 "status": "CREATED",
893 "name": "string",
894 "decimalPoints": 0
895 },
896 "conversionRate": 0,
897 "conversionDate": "2019-08-24",
898 "translationDateType": "DOCUMENT_DATE",
899 "amountType": "NET_AMOUNT",
900 "currencyDefinitionType": "CONTRACT_CURRENCY",
901 "invoiceEntryId": 0,
902 "invoiceEntryDisplayId": "string"
903 }
904 ],
905 "scheduledPaymentMatches": [
906 {
907 "id": 0,
908 "fromId": 0,
909 "toId": 0,
910 "amount": 0
911 }
912 ],
913 "goodsReceiptLineItemLinks": [
914 {
915 "id": 0,
916 "fromId": 0,
917 "toId": 0,
918 "linkedQuantity": 0
919 }
920 ],
921 "invoiceId": 0,
922 "invoiceDisplayId": "string",
923 "invoiceState": "INV_DRAFT",
924 "vendorPaymentId": 0,
925 "purchaseOrderLineItemId": 0,
926 "netAmount": 0,
927 "allowsSystemGenerateNewId": true,
928 "numberRangeIdentifierValue": "string",
929 "numberRangeIdentifierType": {
930 "name": "string"
931 },
932 "numberRangeType": {
933 "name": "string"
934 }
935 }
936 ],
937 "workspaceId": 0,
938 "workspaceDisplayId": "string",
939 "workspaceName": "string",
940 "workspaceState": "INV_DRAFT",
941 "remainingNetAmount": 0,
942 "remainingTaxAmount": 0,
943 "remainingTotalAmount": 0,
944 "pendingPaymentCount": 0,
945 "allPaymentsPosted": true,
946 "approvalInfo": {
947 "approverUsername": "string",
948 "approvedAt": "2019-08-24T14:15:22Z"
949 },
950 "rejectionReason": "string",
951 "allowsSystemGenerateNewId": true,
952 "numberRangeIdentifierValue": "string",
953 "numberRangeIdentifierType": {
954 "name": "string"
955 },
956 "numberRangeType": {
957 "name": "string"
958 }
959 }
960 ],
961 "rejectionReason": "string",
962 "allowsSystemGenerateNewId": true,
963 "numberRangeIdentifierValue": "string",
964 "numberRangeIdentifierType": {
965 "name": "string"
966 },
967 "numberRangeType": {
968 "name": "string"
969 }
970 }
971 ],
972 "approvalInfo": {
973 "approverUsername": "string",
974 "approvedAt": "2019-08-24T14:15:22Z"
975 },
976 "rejectionReason": "string",
977 "allowsSystemGenerateNewId": true,
978 "numberRangeIdentifierValue": "string",
979 "numberRangeIdentifierType": {
980 "name": "string"
981 },
982 "numberRangeType": {
983 "name": "string"
984 }
985}
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 "shippingAddress": "string",
18 "state": "INV_DRAFT",
19 "notes": "string",
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 "totalAmount": 0,
40 "purchaseRequisitionItems": [
41 {
42 "id": 0,
43 "displayId": "string",
44 "quantity": 0,
45 "allocatedQuantity": 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 "purchaseRequisitionId": 0,
72 "purchaseRequisitionDisplayId": "string",
73 "purchaseOrderLineItems": [
74 {
75 "id": 0,
76 "displayId": "string",
77 "quantity": 0,
78 "allocatedQuantity": 0,
79 "receivedQuantity": 0,
80 "unitPrice": 0,
81 "description": "string",
82 "expenseCategory": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "expenseCategoryType": "PAYMENT"
88 },
89 "costCenter": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string",
94 "erpSystemId": 0
95 },
96 "profitCenter": {
97 "id": 0,
98 "displayId": "string",
99 "status": "CREATED",
100 "name": "string",
101 "validTo": "2019-08-24",
102 "erpSystemId": 0,
103 "erpSystemDisplayId": "string"
104 },
105 "taxJurisdiction": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "erpSystemId": 0,
111 "schema": "string",
112 "countryDisplayId": "string"
113 },
114 "taxCode": {
115 "id": 0,
116 "displayId": "string",
117 "status": "CREATED",
118 "name": "string",
119 "erpSystemId": 0
120 },
121 "taxLineItems": [
122 {
123 "id": 0,
124 "taxRate": 0.1,
125 "taxAmount": 0,
126 "taxType": "string",
127 "purchaseOrderLineItemId": 0
128 }
129 ],
130 "purchaseOrderId": 0,
131 "purchaseOrderDisplayId": "string",
132 "purchaseOrderState": "INV_DRAFT",
133 "invoiceLineItems": [
134 {
135 "id": 0,
136 "displayId": "string",
137 "expenseCategory": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "expenseCategoryType": "PAYMENT"
143 },
144 "description": "string",
145 "unitOfMeasure": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string",
150 "erpSystemId": 0
151 },
152 "quantity": 0,
153 "unitPrice": 0,
154 "taxJurisdiction": {
155 "id": 0,
156 "displayId": "string",
157 "status": "CREATED",
158 "name": "string",
159 "erpSystemId": 0,
160 "schema": "string",
161 "countryDisplayId": "string"
162 },
163 "taxCode": {
164 "id": 0,
165 "displayId": "string",
166 "status": "CREATED",
167 "name": "string",
168 "erpSystemId": 0
169 },
170 "taxExpenseAccount": {
171 "id": 0,
172 "displayId": "string",
173 "generalLedgerAccountName": "string",
174 "generalLedgerAccountCode": "string",
175 "openItemManagement": true,
176 "accountCategory": "BALANCESHEET",
177 "shortName": "string",
178 "longName": "string"
179 },
180 "taxLineItems": [
181 {
182 "id": 0,
183 "taxRate": 0.1,
184 "taxAmount": 0,
185 "taxType": "string",
186 "invoiceLineItemId": 0
187 }
188 ],
189 "workBreakdownStructure": {
190 "id": 0,
191 "displayId": "string",
192 "status": "CREATED",
193 "name": "string",
194 "erpSystemId": 0
195 },
196 "costCenter": {
197 "id": 0,
198 "displayId": "string",
199 "status": "CREATED",
200 "name": "string",
201 "erpSystemId": 0
202 },
203 "profitCenter": {
204 "id": 0,
205 "displayId": "string",
206 "status": "CREATED",
207 "name": "string",
208 "validTo": "2019-08-24",
209 "erpSystemId": 0,
210 "erpSystemDisplayId": "string"
211 },
212 "functionalArea": {
213 "id": 0,
214 "displayId": "string",
215 "status": "CREATED",
216 "name": "string",
217 "erpSystemId": 0
218 },
219 "businessArea": {
220 "id": 0,
221 "displayId": "string",
222 "status": "CREATED",
223 "name": "string",
224 "erpSystemId": 0
225 },
226 "segment": {
227 "id": 0,
228 "displayId": "string",
229 "status": "CREATED",
230 "name": "string",
231 "erpSystemId": 0
232 },
233 "network": {
234 "id": 0,
235 "displayId": "string",
236 "status": "CREATED",
237 "name": "string",
238 "erpSystemId": 0
239 },
240 "internalOrderType": {
241 "id": 0,
242 "displayId": "string",
243 "status": "CREATED",
244 "name": "string",
245 "erpSystemId": 0
246 },
247 "internalOrder": {
248 "id": 0,
249 "displayId": "string",
250 "status": "CREATED",
251 "name": "string",
252 "erpSystemId": 0,
253 "internalOrderTypeId": 0
254 },
255 "additionalCurrencies": [
256 {
257 "id": 0,
258 "amount": 0,
259 "currency": {},
260 "conversionRate": 0,
261 "conversionDate": "2019-08-24",
262 "translationDateType": "DOCUMENT_DATE",
263 "amountType": "NET_AMOUNT",
264 "currencyDefinitionType": "CONTRACT_CURRENCY",
265 "invoiceEntryId": 0,
266 "invoiceEntryDisplayId": "string"
267 }
268 ],
269 "scheduledPaymentMatches": [
270 {
271 "id": 0,
272 "fromId": 0,
273 "toId": 0,
274 "amount": 0
275 }
276 ],
277 "goodsReceiptLineItemLinks": [
278 {
279 "id": 0,
280 "fromId": 0,
281 "toId": 0,
282 "linkedQuantity": 0
283 }
284 ],
285 "invoiceId": 0,
286 "invoiceDisplayId": "string",
287 "invoiceState": "INV_DRAFT",
288 "vendorPaymentId": 0,
289 "purchaseOrderLineItemId": 0,
290 "netAmount": 0,
291 "allowsSystemGenerateNewId": true,
292 "numberRangeIdentifierValue": "string",
293 "numberRangeIdentifierType": {
294 "name": "string"
295 },
296 "numberRangeType": {
297 "name": "string"
298 }
299 }
300 ],
301 "goodsReceiptLineItems": [
302 {
303 "id": 0,
304 "displayId": "string",
305 "quantity": 0,
306 "invoicedQuantity": 0,
307 "description": "string",
308 "expenseCategory": {
309 "id": 0,
310 "displayId": "string",
311 "status": "CREATED",
312 "name": "string",
313 "expenseCategoryType": "PAYMENT"
314 },
315 "goodsReceiptId": 0,
316 "goodsReceiptDisplayId": "string",
317 "goodsReceiptState": "INV_DRAFT",
318 "purchaseOrderLineItemId": 0,
319 "invoiceLineItemLinks": [
320 {
321 "id": 0,
322 "fromId": 0,
323 "toId": 0,
324 "linkedQuantity": 0
325 }
326 ],
327 "availableQuantity": 0,
328 "allowsSystemGenerateNewId": true,
329 "numberRangeIdentifierValue": "string",
330 "numberRangeIdentifierType": {
331 "name": "string"
332 },
333 "numberRangeType": {
334 "name": "string"
335 }
336 }
337 ],
338 "vendorPaymentId": 0,
339 "purchaseRequisitionLineItemId": 0,
340 "purchaseRequisitionDisplayId": "string",
341 "purchaseRequisitionLineItemAvailableQuantity": 0,
342 "remainingQuantity": 0,
343 "availableQuantity": 0,
344 "allowsSystemGenerateNewId": true,
345 "numberRangeIdentifierValue": "string",
346 "numberRangeIdentifierType": {
347 "name": "string"
348 },
349 "numberRangeType": {
350 "name": "string"
351 }
352 }
353 ],
354 "availableQuantity": 0,
355 "allowsSystemGenerateNewId": true,
356 "numberRangeIdentifierValue": "string",
357 "numberRangeIdentifierType": {
358 "name": "string"
359 },
360 "numberRangeType": {
361 "name": "string"
362 }
363 }
364 ],
365 "purchaseOrders": [
366 {
367 "id": 0,
368 "displayId": "string",
369 "state": "INV_DRAFT",
370 "issueDate": "2019-08-24",
371 "expectedDeliveryDate": "2019-08-24",
372 "name": "string",
373 "shippingAddress": "string",
374 "notes": "string",
375 "netAmount": 0,
376 "taxAmount": 0,
377 "externalPurchaseOrderDisplayId": "string",
378 "vendor": {
379 "id": 0,
380 "displayId": "string",
381 "status": "CREATED",
382 "name": "string",
383 "erpSystemDisplayId": "string"
384 },
385 "currency": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "decimalPoints": 0
391 },
392 "company": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "erpSystemId": 0,
397 "erpSystemDisplayId": "string",
398 "countryId": 0,
399 "countryDisplayId": "string",
400 "name": "string",
401 "postingPeriodVariantId": 0,
402 "fiscalVariantId": 0
403 },
404 "purchaseOrderLineItems": [
405 {
406 "id": 0,
407 "displayId": "string",
408 "quantity": 0,
409 "allocatedQuantity": 0,
410 "receivedQuantity": 0,
411 "unitPrice": 0,
412 "description": "string",
413 "expenseCategory": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "expenseCategoryType": "PAYMENT"
419 },
420 "costCenter": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "erpSystemId": 0
426 },
427 "profitCenter": {
428 "id": 0,
429 "displayId": "string",
430 "status": "CREATED",
431 "name": "string",
432 "validTo": "2019-08-24",
433 "erpSystemId": 0,
434 "erpSystemDisplayId": "string"
435 },
436 "taxJurisdiction": {
437 "id": 0,
438 "displayId": "string",
439 "status": "CREATED",
440 "name": "string",
441 "erpSystemId": 0,
442 "schema": "string",
443 "countryDisplayId": "string"
444 },
445 "taxCode": {
446 "id": 0,
447 "displayId": "string",
448 "status": "CREATED",
449 "name": "string",
450 "erpSystemId": 0
451 },
452 "taxLineItems": [
453 {
454 "id": 0,
455 "taxRate": 0.1,
456 "taxAmount": 0,
457 "taxType": "string",
458 "purchaseOrderLineItemId": 0
459 }
460 ],
461 "purchaseOrderId": 0,
462 "purchaseOrderDisplayId": "string",
463 "purchaseOrderState": "INV_DRAFT",
464 "invoiceLineItems": [
465 {
466 "id": 0,
467 "displayId": "string",
468 "expenseCategory": {
469 "id": 0,
470 "displayId": "string",
471 "status": "CREATED",
472 "name": "string",
473 "expenseCategoryType": "PAYMENT"
474 },
475 "description": "string",
476 "unitOfMeasure": {
477 "id": 0,
478 "displayId": "string",
479 "status": "CREATED",
480 "name": "string",
481 "erpSystemId": 0
482 },
483 "quantity": 0,
484 "unitPrice": 0,
485 "taxJurisdiction": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "erpSystemId": 0,
491 "schema": "string",
492 "countryDisplayId": "string"
493 },
494 "taxCode": {
495 "id": 0,
496 "displayId": "string",
497 "status": "CREATED",
498 "name": "string",
499 "erpSystemId": 0
500 },
501 "taxExpenseAccount": {
502 "id": 0,
503 "displayId": "string",
504 "generalLedgerAccountName": "string",
505 "generalLedgerAccountCode": "string",
506 "openItemManagement": true,
507 "accountCategory": "BALANCESHEET",
508 "shortName": "string",
509 "longName": "string"
510 },
511 "taxLineItems": [
512 {
513 "id": 0,
514 "taxRate": 0.1,
515 "taxAmount": 0,
516 "taxType": "string",
517 "invoiceLineItemId": 0
518 }
519 ],
520 "workBreakdownStructure": {
521 "id": 0,
522 "displayId": "string",
523 "status": "CREATED",
524 "name": "string",
525 "erpSystemId": 0
526 },
527 "costCenter": {
528 "id": 0,
529 "displayId": "string",
530 "status": "CREATED",
531 "name": "string",
532 "erpSystemId": 0
533 },
534 "profitCenter": {
535 "id": 0,
536 "displayId": "string",
537 "status": "CREATED",
538 "name": "string",
539 "validTo": "2019-08-24",
540 "erpSystemId": 0,
541 "erpSystemDisplayId": "string"
542 },
543 "functionalArea": {
544 "id": 0,
545 "displayId": "string",
546 "status": "CREATED",
547 "name": "string",
548 "erpSystemId": 0
549 },
550 "businessArea": {
551 "id": 0,
552 "displayId": "string",
553 "status": "CREATED",
554 "name": "string",
555 "erpSystemId": 0
556 },
557 "segment": {
558 "id": 0,
559 "displayId": "string",
560 "status": "CREATED",
561 "name": "string",
562 "erpSystemId": 0
563 },
564 "network": {
565 "id": 0,
566 "displayId": "string",
567 "status": "CREATED",
568 "name": "string",
569 "erpSystemId": 0
570 },
571 "internalOrderType": {
572 "id": 0,
573 "displayId": "string",
574 "status": "CREATED",
575 "name": "string",
576 "erpSystemId": 0
577 },
578 "internalOrder": {
579 "id": 0,
580 "displayId": "string",
581 "status": "CREATED",
582 "name": "string",
583 "erpSystemId": 0,
584 "internalOrderTypeId": 0
585 },
586 "additionalCurrencies": [
587 {
588 "id": 0,
589 "amount": 0,
590 "currency": {},
591 "conversionRate": 0,
592 "conversionDate": "2019-08-24",
593 "translationDateType": "DOCUMENT_DATE",
594 "amountType": "NET_AMOUNT",
595 "currencyDefinitionType": "CONTRACT_CURRENCY",
596 "invoiceEntryId": 0,
597 "invoiceEntryDisplayId": "string"
598 }
599 ],
600 "scheduledPaymentMatches": [
601 {
602 "id": 0,
603 "fromId": 0,
604 "toId": 0,
605 "amount": 0
606 }
607 ],
608 "goodsReceiptLineItemLinks": [
609 {
610 "id": 0,
611 "fromId": 0,
612 "toId": 0,
613 "linkedQuantity": 0
614 }
615 ],
616 "invoiceId": 0,
617 "invoiceDisplayId": "string",
618 "invoiceState": "INV_DRAFT",
619 "vendorPaymentId": 0,
620 "purchaseOrderLineItemId": 0,
621 "netAmount": 0,
622 "allowsSystemGenerateNewId": true,
623 "numberRangeIdentifierValue": "string",
624 "numberRangeIdentifierType": {
625 "name": "string"
626 },
627 "numberRangeType": {
628 "name": "string"
629 }
630 }
631 ],
632 "goodsReceiptLineItems": [
633 {
634 "id": 0,
635 "displayId": "string",
636 "quantity": 0,
637 "invoicedQuantity": 0,
638 "description": "string",
639 "expenseCategory": {
640 "id": 0,
641 "displayId": "string",
642 "status": "CREATED",
643 "name": "string",
644 "expenseCategoryType": "PAYMENT"
645 },
646 "goodsReceiptId": 0,
647 "goodsReceiptDisplayId": "string",
648 "goodsReceiptState": "INV_DRAFT",
649 "purchaseOrderLineItemId": 0,
650 "invoiceLineItemLinks": [
651 {
652 "id": 0,
653 "fromId": 0,
654 "toId": 0,
655 "linkedQuantity": 0
656 }
657 ],
658 "availableQuantity": 0,
659 "allowsSystemGenerateNewId": true,
660 "numberRangeIdentifierValue": "string",
661 "numberRangeIdentifierType": {
662 "name": "string"
663 },
664 "numberRangeType": {
665 "name": "string"
666 }
667 }
668 ],
669 "vendorPaymentId": 0,
670 "purchaseRequisitionLineItemId": 0,
671 "purchaseRequisitionDisplayId": "string",
672 "purchaseRequisitionLineItemAvailableQuantity": 0,
673 "remainingQuantity": 0,
674 "availableQuantity": 0,
675 "allowsSystemGenerateNewId": true,
676 "numberRangeIdentifierValue": "string",
677 "numberRangeIdentifierType": {
678 "name": "string"
679 },
680 "numberRangeType": {
681 "name": "string"
682 }
683 }
684 ],
685 "purchaseRequisitionIds": [
686 0
687 ],
688 "purchaseRequisitionDisplayIds": [
689 "string"
690 ],
691 "invoices": [
692 {
693 "id": 0,
694 "displayId": "string",
695 "name": "string",
696 "invoiceType": "VENDOR_INV",
697 "state": "INV_DRAFT",
698 "externalDocumentNumber": "string",
699 "purchaseOrderReference": "string",
700 "invoiceDate": "2019-08-24",
701 "dueDate": "2019-08-24",
702 "notes": "string",
703 "billingPeriodFromDate": "2019-08-24",
704 "billingPeriodToDate": "2019-08-24",
705 "currency": {
706 "id": 0,
707 "displayId": "string",
708 "status": "CREATED",
709 "name": "string",
710 "decimalPoints": 0
711 },
712 "vendor": {
713 "id": 0,
714 "displayId": "string",
715 "status": "CREATED",
716 "name": "string",
717 "erpSystemDisplayId": "string"
718 },
719 "company": {
720 "id": 0,
721 "displayId": "string",
722 "status": "CREATED",
723 "erpSystemId": 0,
724 "erpSystemDisplayId": "string",
725 "countryId": 0,
726 "countryDisplayId": "string",
727 "name": "string",
728 "postingPeriodVariantId": 0,
729 "fiscalVariantId": 0
730 },
731 "netAmount": 0,
732 "taxAmount": 0,
733 "totalAmount": 0,
734 "netAmountBalance": 0,
735 "taxAmountBalance": 0,
736 "paymentTerm": {
737 "id": 0,
738 "displayId": "string",
739 "status": "CREATED",
740 "name": "string"
741 },
742 "paymentMethod": {
743 "id": 0,
744 "displayId": "string",
745 "status": "CREATED",
746 "name": "string",
747 "type": "string"
748 },
749 "paymentBlock": {
750 "id": 0,
751 "displayId": "string",
752 "status": "CREATED",
753 "name": "string"
754 },
755 "defaultCostCenter": {
756 "id": 0,
757 "displayId": "string",
758 "status": "CREATED",
759 "name": "string",
760 "erpSystemId": 0
761 },
762 "defaultProfitCenter": {
763 "id": 0,
764 "displayId": "string",
765 "status": "CREATED",
766 "name": "string",
767 "validTo": "2019-08-24",
768 "erpSystemId": 0,
769 "erpSystemDisplayId": "string"
770 },
771 "invoiceLineItems": [
772 {
773 "id": 0,
774 "displayId": "string",
775 "expenseCategory": {
776 "id": 0,
777 "displayId": "string",
778 "status": "CREATED",
779 "name": "string",
780 "expenseCategoryType": "PAYMENT"
781 },
782 "description": "string",
783 "unitOfMeasure": {
784 "id": 0,
785 "displayId": "string",
786 "status": "CREATED",
787 "name": "string",
788 "erpSystemId": 0
789 },
790 "quantity": 0,
791 "unitPrice": 0,
792 "taxJurisdiction": {
793 "id": 0,
794 "displayId": "string",
795 "status": "CREATED",
796 "name": "string",
797 "erpSystemId": 0,
798 "schema": "string",
799 "countryDisplayId": "string"
800 },
801 "taxCode": {
802 "id": 0,
803 "displayId": "string",
804 "status": "CREATED",
805 "name": "string",
806 "erpSystemId": 0
807 },
808 "taxExpenseAccount": {
809 "id": 0,
810 "displayId": "string",
811 "generalLedgerAccountName": "string",
812 "generalLedgerAccountCode": "string",
813 "openItemManagement": true,
814 "accountCategory": "BALANCESHEET",
815 "shortName": "string",
816 "longName": "string"
817 },
818 "taxLineItems": [
819 {
820 "id": 0,
821 "taxRate": 0.1,
822 "taxAmount": 0,
823 "taxType": "string",
824 "invoiceLineItemId": 0
825 }
826 ],
827 "workBreakdownStructure": {
828 "id": 0,
829 "displayId": "string",
830 "status": "CREATED",
831 "name": "string",
832 "erpSystemId": 0
833 },
834 "costCenter": {
835 "id": 0,
836 "displayId": "string",
837 "status": "CREATED",
838 "name": "string",
839 "erpSystemId": 0
840 },
841 "profitCenter": {
842 "id": 0,
843 "displayId": "string",
844 "status": "CREATED",
845 "name": "string",
846 "validTo": "2019-08-24",
847 "erpSystemId": 0,
848 "erpSystemDisplayId": "string"
849 },
850 "functionalArea": {
851 "id": 0,
852 "displayId": "string",
853 "status": "CREATED",
854 "name": "string",
855 "erpSystemId": 0
856 },
857 "businessArea": {
858 "id": 0,
859 "displayId": "string",
860 "status": "CREATED",
861 "name": "string",
862 "erpSystemId": 0
863 },
864 "segment": {
865 "id": 0,
866 "displayId": "string",
867 "status": "CREATED",
868 "name": "string",
869 "erpSystemId": 0
870 },
871 "network": {
872 "id": 0,
873 "displayId": "string",
874 "status": "CREATED",
875 "name": "string",
876 "erpSystemId": 0
877 },
878 "internalOrderType": {
879 "id": 0,
880 "displayId": "string",
881 "status": "CREATED",
882 "name": "string",
883 "erpSystemId": 0
884 },
885 "internalOrder": {
886 "id": 0,
887 "displayId": "string",
888 "status": "CREATED",
889 "name": "string",
890 "erpSystemId": 0,
891 "internalOrderTypeId": 0
892 },
893 "additionalCurrencies": [
894 {
895 "id": 0,
896 "amount": 0,
897 "currency": {},
898 "conversionRate": 0,
899 "conversionDate": "2019-08-24",
900 "translationDateType": "DOCUMENT_DATE",
901 "amountType": "NET_AMOUNT",
902 "currencyDefinitionType": "CONTRACT_CURRENCY",
903 "invoiceEntryId": 0,
904 "invoiceEntryDisplayId": "string"
905 }
906 ],
907 "scheduledPaymentMatches": [
908 {
909 "id": 0,
910 "fromId": 0,
911 "toId": 0,
912 "amount": 0
913 }
914 ],
915 "goodsReceiptLineItemLinks": [
916 {
917 "id": 0,
918 "fromId": 0,
919 "toId": 0,
920 "linkedQuantity": 0
921 }
922 ],
923 "invoiceId": 0,
924 "invoiceDisplayId": "string",
925 "invoiceState": "INV_DRAFT",
926 "vendorPaymentId": 0,
927 "purchaseOrderLineItemId": 0,
928 "netAmount": 0,
929 "allowsSystemGenerateNewId": true,
930 "numberRangeIdentifierValue": "string",
931 "numberRangeIdentifierType": {
932 "name": "string"
933 },
934 "numberRangeType": {
935 "name": "string"
936 }
937 }
938 ],
939 "workspaceId": 0,
940 "workspaceDisplayId": "string",
941 "workspaceName": "string",
942 "workspaceState": "INV_DRAFT",
943 "remainingNetAmount": 0,
944 "remainingTaxAmount": 0,
945 "remainingTotalAmount": 0,
946 "pendingPaymentCount": 0,
947 "allPaymentsPosted": true,
948 "approvalInfo": {
949 "approverUsername": "string",
950 "approvedAt": "2019-08-24T14:15:22Z"
951 },
952 "rejectionReason": "string",
953 "allowsSystemGenerateNewId": true,
954 "numberRangeIdentifierValue": "string",
955 "numberRangeIdentifierType": {
956 "name": "string"
957 },
958 "numberRangeType": {
959 "name": "string"
960 }
961 }
962 ],
963 "rejectionReason": "string",
964 "allowsSystemGenerateNewId": true,
965 "numberRangeIdentifierValue": "string",
966 "numberRangeIdentifierType": {
967 "name": "string"
968 },
969 "numberRangeType": {
970 "name": "string"
971 }
972 }
973 ],
974 "approvalInfo": {
975 "approverUsername": "string",
976 "approvedAt": "2019-08-24T14:15:22Z"
977 },
978 "rejectionReason": "string",
979 "allowsSystemGenerateNewId": true,
980 "numberRangeIdentifierValue": "string",
981 "numberRangeIdentifierType": {
982 "name": "string"
983 },
984 "numberRangeType": {
985 "name": "string"
986 }
987 }
988}
Purchase Requisition - Search Purchase Requisition State History¶
HTTP Request
GET /api/v1/purchase-requisition/{purchaseRequisitionId}/state-history
📋 Description: Retrieves the state history of a specific purchase requisition, allowing users to track its status changes over time for improved procurement oversight.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseRequisitionId |
path |
integer(int64) |
true |
Unique identifier for the purchase requisition |
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 "purchaseRequisitionId": 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 requisition, capturing key status changes and associated metadata to facilitate tracking and auditing within procurement processes.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» success |
boolean |
false |
none |
Indicates whether the purchase requisition state change was successful, providing insight into the status of procurement processes. |
» failedMessage |
string |
false |
none |
Contains the error message associated with a failed purchase requisition, providing insight into the reason for the failure in the requisition process. |
» warningMessage |
string |
false |
none |
Contains a message indicating any warnings related to the purchase requisition state history, providing users with essential insights for decision-making. |
» fromState |
string |
false |
none |
Represents the originating state of a purchase requisition within the state history, providing insight into its progression and status changes. |
» event |
string |
false |
none |
Represents the specific event associated with the state change in the purchase requisition history, providing essential context for tracking procurement activities. |
» comment |
string |
false |
none |
Textual commentary providing additional context or notes regarding the state changes of a purchase requisition. |
» purchaseRequisitionId |
integer(int64) |
false |
none |
Unique identifier for the purchase requisition |
Purchase Requisition - Is Favorite¶
HTTP Request
GET /api/v1/purchase-requisition/{purchaseRequisitionId}/is-favorite
📋 Description: Retrieves the favorite status of a specified purchase requisition, allowing users to determine if the requisition is marked as a favorite for quick access and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
purchaseRequisitionId |
path |
integer(int64) |
true |
Unique identifier for the purchase requisition |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
boolean |
|
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1true
Purchase Requisition - Get Recents¶
HTTP Request
GET /api/v1/purchase-requisition/recents
📋 Description: Retrieves the most recent purchase requisitions submitted within the system, enabling users to quickly access and review pending procurement requests.
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 |
Purchase Requisition - Get Favourites¶
HTTP Request
GET /api/v1/purchase-requisition/favorites
📋 Description: Retrieves a list of favorite purchase requisitions for the authenticated user, enabling quick access to frequently used requests for streamlined procurement processes.
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 |
Purchase Requisition - Delete Link¶
HTTP Request
DELETE /api/v1/purchase-requisition/link/{linkId}
📋 Description: Deletes a specified purchase requisition link identified by the linkId, ensuring the removal of associated data from the system to maintain accurate procurement records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
linkId |
path |
integer(int64) |
true |
Unique identifier for the link |
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}