ResponseListPurchaseOrderDto¶
Example Json Object
1{
2 "code": "UPDATED",
3 "message": "string",
4 "defaultMessage": "string",
5 "debugMessage": "string",
6 "errors": {
7 "all": [
8 {
9 "type": "GENERIC",
10 "source": {},
11 "errorMessage": "string",
12 "field": "string",
13 "errorKey": "string"
14 }
15 ]
16 },
17 "object": [
18 {
19 "id": 0,
20 "displayId": "string",
21 "state": "INV_DRAFT",
22 "issueDate": "2019-08-24",
23 "expectedDeliveryDate": "2019-08-24",
24 "name": "string",
25 "shippingAddress": "string",
26 "notes": "string",
27 "netAmount": 0,
28 "taxAmount": 0,
29 "externalPurchaseOrderDisplayId": "string",
30 "vendor": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "erpSystemDisplayId": "string"
36 },
37 "currency": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string",
42 "decimalPoints": 0
43 },
44 "company": {
45 "id": 0,
46 "displayId": "string",
47 "status": "CREATED",
48 "erpSystemId": 0,
49 "erpSystemDisplayId": "string",
50 "countryId": 0,
51 "countryDisplayId": "string",
52 "name": "string",
53 "postingPeriodVariantId": 0,
54 "fiscalVariantId": 0
55 },
56 "purchaseOrderLineItems": [
57 {
58 "id": 0,
59 "displayId": "string",
60 "quantity": 0,
61 "allocatedQuantity": 0,
62 "receivedQuantity": 0,
63 "unitPrice": 0,
64 "description": "string",
65 "expenseCategory": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "expenseCategoryType": "PAYMENT"
71 },
72 "costCenter": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0
78 },
79 "profitCenter": {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "validTo": "2019-08-24",
85 "erpSystemId": 0,
86 "erpSystemDisplayId": "string"
87 },
88 "taxJurisdiction": {
89 "id": 0,
90 "displayId": "string",
91 "status": "CREATED",
92 "name": "string",
93 "erpSystemId": 0,
94 "schema": "string",
95 "countryDisplayId": "string"
96 },
97 "taxCode": {
98 "id": 0,
99 "displayId": "string",
100 "status": "CREATED",
101 "name": "string",
102 "erpSystemId": 0
103 },
104 "taxLineItems": [
105 {
106 "id": 0,
107 "taxRate": 0.1,
108 "taxAmount": 0,
109 "taxType": "string",
110 "purchaseOrderLineItemId": 0
111 }
112 ],
113 "purchaseOrderId": 0,
114 "purchaseOrderDisplayId": "string",
115 "purchaseOrderState": "INV_DRAFT",
116 "invoiceLineItems": [
117 {
118 "id": 0,
119 "displayId": "string",
120 "expenseCategory": {
121 "id": 0,
122 "displayId": "string",
123 "status": "CREATED",
124 "name": "string",
125 "expenseCategoryType": "PAYMENT"
126 },
127 "description": "string",
128 "unitOfMeasure": {
129 "id": 0,
130 "displayId": "string",
131 "status": "CREATED",
132 "name": "string",
133 "erpSystemId": 0
134 },
135 "quantity": 0,
136 "unitPrice": 0,
137 "taxJurisdiction": {
138 "id": 0,
139 "displayId": "string",
140 "status": "CREATED",
141 "name": "string",
142 "erpSystemId": 0,
143 "schema": "string",
144 "countryDisplayId": "string"
145 },
146 "taxCode": {
147 "id": 0,
148 "displayId": "string",
149 "status": "CREATED",
150 "name": "string",
151 "erpSystemId": 0
152 },
153 "taxExpenseAccount": {
154 "id": 0,
155 "displayId": "string",
156 "generalLedgerAccountName": "string",
157 "generalLedgerAccountCode": "string",
158 "openItemManagement": true,
159 "accountCategory": "BALANCESHEET",
160 "shortName": "string",
161 "longName": "string"
162 },
163 "taxLineItems": [
164 {
165 "id": 0,
166 "taxRate": 0.1,
167 "taxAmount": 0,
168 "taxType": "string",
169 "invoiceLineItemId": 0
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 "id": 0,
241 "amount": 0,
242 "currency": {
243 "id": 0,
244 "displayId": "string",
245 "status": "CREATED",
246 "name": "string",
247 "decimalPoints": 0
248 },
249 "conversionRate": 0,
250 "conversionDate": "2019-08-24",
251 "translationDateType": "DOCUMENT_DATE",
252 "amountType": "NET_AMOUNT",
253 "currencyDefinitionType": "CONTRACT_CURRENCY",
254 "invoiceEntryId": 0,
255 "invoiceEntryDisplayId": "string"
256 }
257 ],
258 "scheduledPaymentMatches": [
259 {
260 "id": 0,
261 "fromId": 0,
262 "toId": 0,
263 "amount": 0
264 }
265 ],
266 "goodsReceiptLineItemLinks": [
267 {
268 "id": 0,
269 "fromId": 0,
270 "toId": 0,
271 "linkedQuantity": 0
272 }
273 ],
274 "invoiceId": 0,
275 "invoiceDisplayId": "string",
276 "invoiceState": "INV_DRAFT",
277 "vendorPaymentId": 0,
278 "purchaseOrderLineItemId": 0,
279 "netAmount": 0,
280 "allowsSystemGenerateNewId": true,
281 "numberRangeIdentifierValue": "string",
282 "numberRangeIdentifierType": {
283 "name": "string"
284 },
285 "numberRangeType": {
286 "name": "string"
287 }
288 }
289 ],
290 "goodsReceiptLineItems": [
291 {
292 "id": 0,
293 "displayId": "string",
294 "quantity": 0,
295 "invoicedQuantity": 0,
296 "description": "string",
297 "expenseCategory": {
298 "id": 0,
299 "displayId": "string",
300 "status": "CREATED",
301 "name": "string",
302 "expenseCategoryType": "PAYMENT"
303 },
304 "goodsReceiptId": 0,
305 "goodsReceiptDisplayId": "string",
306 "goodsReceiptState": "INV_DRAFT",
307 "purchaseOrderLineItemId": 0,
308 "invoiceLineItemLinks": [
309 {
310 "id": 0,
311 "fromId": 0,
312 "toId": 0,
313 "linkedQuantity": 0
314 }
315 ],
316 "availableQuantity": 0,
317 "allowsSystemGenerateNewId": true,
318 "numberRangeIdentifierValue": "string",
319 "numberRangeIdentifierType": {
320 "name": "string"
321 },
322 "numberRangeType": {
323 "name": "string"
324 }
325 }
326 ],
327 "vendorPaymentId": 0,
328 "purchaseRequisitionLineItemId": 0,
329 "purchaseRequisitionDisplayId": "string",
330 "purchaseRequisitionLineItemAvailableQuantity": 0,
331 "remainingQuantity": 0,
332 "availableQuantity": 0,
333 "allowsSystemGenerateNewId": true,
334 "numberRangeIdentifierValue": "string",
335 "numberRangeIdentifierType": {
336 "name": "string"
337 },
338 "numberRangeType": {
339 "name": "string"
340 }
341 }
342 ],
343 "purchaseRequisitionIds": [
344 0
345 ],
346 "purchaseRequisitionDisplayIds": [
347 "string"
348 ],
349 "invoices": [
350 {
351 "id": 0,
352 "displayId": "string",
353 "name": "string",
354 "invoiceType": "VENDOR_INV",
355 "state": "INV_DRAFT",
356 "externalDocumentNumber": "string",
357 "purchaseOrderReference": "string",
358 "invoiceDate": "2019-08-24",
359 "dueDate": "2019-08-24",
360 "notes": "string",
361 "billingPeriodFromDate": "2019-08-24",
362 "billingPeriodToDate": "2019-08-24",
363 "currency": {
364 "id": 0,
365 "displayId": "string",
366 "status": "CREATED",
367 "name": "string",
368 "decimalPoints": 0
369 },
370 "vendor": {
371 "id": 0,
372 "displayId": "string",
373 "status": "CREATED",
374 "name": "string",
375 "erpSystemDisplayId": "string"
376 },
377 "company": {
378 "id": 0,
379 "displayId": "string",
380 "status": "CREATED",
381 "erpSystemId": 0,
382 "erpSystemDisplayId": "string",
383 "countryId": 0,
384 "countryDisplayId": "string",
385 "name": "string",
386 "postingPeriodVariantId": 0,
387 "fiscalVariantId": 0
388 },
389 "netAmount": 0,
390 "taxAmount": 0,
391 "totalAmount": 0,
392 "netAmountBalance": 0,
393 "taxAmountBalance": 0,
394 "paymentTerm": {
395 "id": 0,
396 "displayId": "string",
397 "status": "CREATED",
398 "name": "string"
399 },
400 "paymentMethod": {
401 "id": 0,
402 "displayId": "string",
403 "status": "CREATED",
404 "name": "string",
405 "type": "string"
406 },
407 "paymentBlock": {
408 "id": 0,
409 "displayId": "string",
410 "status": "CREATED",
411 "name": "string"
412 },
413 "defaultCostCenter": {
414 "id": 0,
415 "displayId": "string",
416 "status": "CREATED",
417 "name": "string",
418 "erpSystemId": 0
419 },
420 "defaultProfitCenter": {
421 "id": 0,
422 "displayId": "string",
423 "status": "CREATED",
424 "name": "string",
425 "validTo": "2019-08-24",
426 "erpSystemId": 0,
427 "erpSystemDisplayId": "string"
428 },
429 "invoiceLineItems": [
430 {
431 "id": 0,
432 "displayId": "string",
433 "expenseCategory": {
434 "id": 0,
435 "displayId": "string",
436 "status": "CREATED",
437 "name": "string",
438 "expenseCategoryType": "PAYMENT"
439 },
440 "description": "string",
441 "unitOfMeasure": {
442 "id": 0,
443 "displayId": "string",
444 "status": "CREATED",
445 "name": "string",
446 "erpSystemId": 0
447 },
448 "quantity": 0,
449 "unitPrice": 0,
450 "taxJurisdiction": {
451 "id": 0,
452 "displayId": "string",
453 "status": "CREATED",
454 "name": "string",
455 "erpSystemId": 0,
456 "schema": "string",
457 "countryDisplayId": "string"
458 },
459 "taxCode": {
460 "id": 0,
461 "displayId": "string",
462 "status": "CREATED",
463 "name": "string",
464 "erpSystemId": 0
465 },
466 "taxExpenseAccount": {
467 "id": 0,
468 "displayId": "string",
469 "generalLedgerAccountName": "string",
470 "generalLedgerAccountCode": "string",
471 "openItemManagement": true,
472 "accountCategory": "BALANCESHEET",
473 "shortName": "string",
474 "longName": "string"
475 },
476 "taxLineItems": [
477 {
478 "id": 0,
479 "taxRate": 0.1,
480 "taxAmount": 0,
481 "taxType": "string",
482 "invoiceLineItemId": 0
483 }
484 ],
485 "workBreakdownStructure": {
486 "id": 0,
487 "displayId": "string",
488 "status": "CREATED",
489 "name": "string",
490 "erpSystemId": 0
491 },
492 "costCenter": {
493 "id": 0,
494 "displayId": "string",
495 "status": "CREATED",
496 "name": "string",
497 "erpSystemId": 0
498 },
499 "profitCenter": {
500 "id": 0,
501 "displayId": "string",
502 "status": "CREATED",
503 "name": "string",
504 "validTo": "2019-08-24",
505 "erpSystemId": 0,
506 "erpSystemDisplayId": "string"
507 },
508 "functionalArea": {
509 "id": 0,
510 "displayId": "string",
511 "status": "CREATED",
512 "name": "string",
513 "erpSystemId": 0
514 },
515 "businessArea": {
516 "id": 0,
517 "displayId": "string",
518 "status": "CREATED",
519 "name": "string",
520 "erpSystemId": 0
521 },
522 "segment": {
523 "id": 0,
524 "displayId": "string",
525 "status": "CREATED",
526 "name": "string",
527 "erpSystemId": 0
528 },
529 "network": {
530 "id": 0,
531 "displayId": "string",
532 "status": "CREATED",
533 "name": "string",
534 "erpSystemId": 0
535 },
536 "internalOrderType": {
537 "id": 0,
538 "displayId": "string",
539 "status": "CREATED",
540 "name": "string",
541 "erpSystemId": 0
542 },
543 "internalOrder": {
544 "id": 0,
545 "displayId": "string",
546 "status": "CREATED",
547 "name": "string",
548 "erpSystemId": 0,
549 "internalOrderTypeId": 0
550 },
551 "additionalCurrencies": [
552 {
553 "id": 0,
554 "amount": 0,
555 "currency": {
556 "id": 0,
557 "displayId": "string",
558 "status": "CREATED",
559 "name": "string",
560 "decimalPoints": 0
561 },
562 "conversionRate": 0,
563 "conversionDate": "2019-08-24",
564 "translationDateType": "DOCUMENT_DATE",
565 "amountType": "NET_AMOUNT",
566 "currencyDefinitionType": "CONTRACT_CURRENCY",
567 "invoiceEntryId": 0,
568 "invoiceEntryDisplayId": "string"
569 }
570 ],
571 "scheduledPaymentMatches": [
572 {
573 "id": 0,
574 "fromId": 0,
575 "toId": 0,
576 "amount": 0
577 }
578 ],
579 "goodsReceiptLineItemLinks": [
580 {
581 "id": 0,
582 "fromId": 0,
583 "toId": 0,
584 "linkedQuantity": 0
585 }
586 ],
587 "invoiceId": 0,
588 "invoiceDisplayId": "string",
589 "invoiceState": "INV_DRAFT",
590 "vendorPaymentId": 0,
591 "purchaseOrderLineItemId": 0,
592 "netAmount": 0,
593 "allowsSystemGenerateNewId": true,
594 "numberRangeIdentifierValue": "string",
595 "numberRangeIdentifierType": {
596 "name": "string"
597 },
598 "numberRangeType": {
599 "name": "string"
600 }
601 }
602 ],
603 "workspaceId": 0,
604 "workspaceDisplayId": "string",
605 "workspaceName": "string",
606 "workspaceState": "INV_DRAFT",
607 "remainingNetAmount": 0,
608 "remainingTaxAmount": 0,
609 "remainingTotalAmount": 0,
610 "pendingPaymentCount": 0,
611 "allPaymentsPosted": true,
612 "approvalInfo": {
613 "approverUsername": "string",
614 "approvedAt": "2019-08-24T14:15:22Z"
615 },
616 "rejectionReason": "string",
617 "allowsSystemGenerateNewId": true,
618 "numberRangeIdentifierValue": "string",
619 "numberRangeIdentifierType": {
620 "name": "string"
621 },
622 "numberRangeType": {
623 "name": "string"
624 }
625 }
626 ],
627 "rejectionReason": "string",
628 "allowsSystemGenerateNewId": true,
629 "numberRangeIdentifierValue": "string",
630 "numberRangeIdentifierType": {
631 "name": "string"
632 },
633 "numberRangeType": {
634 "name": "string"
635 }
636 }
637 ]
638}
📄 Description: Data transfer object representing a collection of purchase orders, including relevant details and statuses, to facilitate efficient order management and tracking within the procurement process.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
code |
string |
false |
none |
Code identifier for the resource |
message |
string |
false |
write-only |
Contains the detailed message associated with the purchase order response, providing essential context for order processing and communication. |
defaultMessage |
string |
false |
write-only |
Default message to be displayed for purchase orders when no specific message is provided. |
debugMessage |
string |
false |
write-only |
Provides detailed information about any errors or issues encountered during the processing of the purchase order, assisting in troubleshooting and resolution. |
errors |
false |
none |
List of error messages encountered during the processing of purchase orders, providing insights for troubleshooting and resolution. |
|
object |
false |
none |
An array containing a list of purchase order details, facilitating efficient management and tracking of procurement activities. |
Enumerated Values
Attribute |
Value |
|---|---|
code |
API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED |