ResponsePurchaseOrderDto¶
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 "id": 0,
19 "displayId": "string",
20 "state": "INV_DRAFT",
21 "issueDate": "2019-08-24",
22 "expectedDeliveryDate": "2019-08-24",
23 "name": "string",
24 "shippingAddress": "string",
25 "notes": "string",
26 "netAmount": 0,
27 "taxAmount": 0,
28 "externalPurchaseOrderDisplayId": "string",
29 "vendor": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "erpSystemDisplayId": "string"
35 },
36 "currency": {
37 "id": 0,
38 "displayId": "string",
39 "status": "CREATED",
40 "name": "string",
41 "decimalPoints": 0
42 },
43 "company": {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "erpSystemId": 0,
48 "erpSystemDisplayId": "string",
49 "countryId": 0,
50 "countryDisplayId": "string",
51 "name": "string",
52 "postingPeriodVariantId": 0,
53 "fiscalVariantId": 0
54 },
55 "purchaseOrderLineItems": [
56 {
57 "id": 0,
58 "displayId": "string",
59 "quantity": 0,
60 "allocatedQuantity": 0,
61 "receivedQuantity": 0,
62 "unitPrice": 0,
63 "description": "string",
64 "expenseCategory": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "expenseCategoryType": "PAYMENT"
70 },
71 "costCenter": {
72 "id": 0,
73 "displayId": "string",
74 "status": "CREATED",
75 "name": "string",
76 "erpSystemId": 0
77 },
78 "profitCenter": {
79 "id": 0,
80 "displayId": "string",
81 "status": "CREATED",
82 "name": "string",
83 "validTo": "2019-08-24",
84 "erpSystemId": 0,
85 "erpSystemDisplayId": "string"
86 },
87 "taxJurisdiction": {
88 "id": 0,
89 "displayId": "string",
90 "status": "CREATED",
91 "name": "string",
92 "erpSystemId": 0,
93 "schema": "string",
94 "countryDisplayId": "string"
95 },
96 "taxCode": {
97 "id": 0,
98 "displayId": "string",
99 "status": "CREATED",
100 "name": "string",
101 "erpSystemId": 0
102 },
103 "taxLineItems": [
104 {
105 "id": 0,
106 "taxRate": 0.1,
107 "taxAmount": 0,
108 "taxType": "string",
109 "purchaseOrderLineItemId": 0
110 }
111 ],
112 "purchaseOrderId": 0,
113 "purchaseOrderDisplayId": "string",
114 "purchaseOrderState": "INV_DRAFT",
115 "invoiceLineItems": [
116 {
117 "id": 0,
118 "displayId": "string",
119 "expenseCategory": {
120 "id": 0,
121 "displayId": "string",
122 "status": "CREATED",
123 "name": "string",
124 "expenseCategoryType": "PAYMENT"
125 },
126 "description": "string",
127 "unitOfMeasure": {
128 "id": 0,
129 "displayId": "string",
130 "status": "CREATED",
131 "name": "string",
132 "erpSystemId": 0
133 },
134 "quantity": 0,
135 "unitPrice": 0,
136 "taxJurisdiction": {
137 "id": 0,
138 "displayId": "string",
139 "status": "CREATED",
140 "name": "string",
141 "erpSystemId": 0,
142 "schema": "string",
143 "countryDisplayId": "string"
144 },
145 "taxCode": {
146 "id": 0,
147 "displayId": "string",
148 "status": "CREATED",
149 "name": "string",
150 "erpSystemId": 0
151 },
152 "taxExpenseAccount": {
153 "id": 0,
154 "displayId": "string",
155 "generalLedgerAccountName": "string",
156 "generalLedgerAccountCode": "string",
157 "openItemManagement": true,
158 "accountCategory": "BALANCESHEET",
159 "shortName": "string",
160 "longName": "string"
161 },
162 "taxLineItems": [
163 {
164 "id": 0,
165 "taxRate": 0.1,
166 "taxAmount": 0,
167 "taxType": "string",
168 "invoiceLineItemId": 0
169 }
170 ],
171 "workBreakdownStructure": {
172 "id": 0,
173 "displayId": "string",
174 "status": "CREATED",
175 "name": "string",
176 "erpSystemId": 0
177 },
178 "costCenter": {
179 "id": 0,
180 "displayId": "string",
181 "status": "CREATED",
182 "name": "string",
183 "erpSystemId": 0
184 },
185 "profitCenter": {
186 "id": 0,
187 "displayId": "string",
188 "status": "CREATED",
189 "name": "string",
190 "validTo": "2019-08-24",
191 "erpSystemId": 0,
192 "erpSystemDisplayId": "string"
193 },
194 "functionalArea": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0
200 },
201 "businessArea": {
202 "id": 0,
203 "displayId": "string",
204 "status": "CREATED",
205 "name": "string",
206 "erpSystemId": 0
207 },
208 "segment": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "erpSystemId": 0
214 },
215 "network": {
216 "id": 0,
217 "displayId": "string",
218 "status": "CREATED",
219 "name": "string",
220 "erpSystemId": 0
221 },
222 "internalOrderType": {
223 "id": 0,
224 "displayId": "string",
225 "status": "CREATED",
226 "name": "string",
227 "erpSystemId": 0
228 },
229 "internalOrder": {
230 "id": 0,
231 "displayId": "string",
232 "status": "CREATED",
233 "name": "string",
234 "erpSystemId": 0,
235 "internalOrderTypeId": 0
236 },
237 "additionalCurrencies": [
238 {
239 "id": 0,
240 "amount": 0,
241 "currency": {
242 "id": 0,
243 "displayId": "string",
244 "status": "CREATED",
245 "name": "string",
246 "decimalPoints": 0
247 },
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 "availableQuantity": 0,
316 "allowsSystemGenerateNewId": true,
317 "numberRangeIdentifierValue": "string",
318 "numberRangeIdentifierType": {
319 "name": "string"
320 },
321 "numberRangeType": {
322 "name": "string"
323 }
324 }
325 ],
326 "vendorPaymentId": 0,
327 "purchaseRequisitionLineItemId": 0,
328 "purchaseRequisitionDisplayId": "string",
329 "purchaseRequisitionLineItemAvailableQuantity": 0,
330 "remainingQuantity": 0,
331 "availableQuantity": 0,
332 "allowsSystemGenerateNewId": true,
333 "numberRangeIdentifierValue": "string",
334 "numberRangeIdentifierType": {
335 "name": "string"
336 },
337 "numberRangeType": {
338 "name": "string"
339 }
340 }
341 ],
342 "purchaseRequisitionIds": [
343 0
344 ],
345 "purchaseRequisitionDisplayIds": [
346 "string"
347 ],
348 "invoices": [
349 {
350 "id": 0,
351 "displayId": "string",
352 "name": "string",
353 "invoiceType": "VENDOR_INV",
354 "state": "INV_DRAFT",
355 "externalDocumentNumber": "string",
356 "purchaseOrderReference": "string",
357 "invoiceDate": "2019-08-24",
358 "dueDate": "2019-08-24",
359 "notes": "string",
360 "billingPeriodFromDate": "2019-08-24",
361 "billingPeriodToDate": "2019-08-24",
362 "currency": {
363 "id": 0,
364 "displayId": "string",
365 "status": "CREATED",
366 "name": "string",
367 "decimalPoints": 0
368 },
369 "vendor": {
370 "id": 0,
371 "displayId": "string",
372 "status": "CREATED",
373 "name": "string",
374 "erpSystemDisplayId": "string"
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 "netAmount": 0,
389 "taxAmount": 0,
390 "totalAmount": 0,
391 "netAmountBalance": 0,
392 "taxAmountBalance": 0,
393 "paymentTerm": {
394 "id": 0,
395 "displayId": "string",
396 "status": "CREATED",
397 "name": "string"
398 },
399 "paymentMethod": {
400 "id": 0,
401 "displayId": "string",
402 "status": "CREATED",
403 "name": "string",
404 "type": "string"
405 },
406 "paymentBlock": {
407 "id": 0,
408 "displayId": "string",
409 "status": "CREATED",
410 "name": "string"
411 },
412 "defaultCostCenter": {
413 "id": 0,
414 "displayId": "string",
415 "status": "CREATED",
416 "name": "string",
417 "erpSystemId": 0
418 },
419 "defaultProfitCenter": {
420 "id": 0,
421 "displayId": "string",
422 "status": "CREATED",
423 "name": "string",
424 "validTo": "2019-08-24",
425 "erpSystemId": 0,
426 "erpSystemDisplayId": "string"
427 },
428 "invoiceLineItems": [
429 {
430 "id": 0,
431 "displayId": "string",
432 "expenseCategory": {
433 "id": 0,
434 "displayId": "string",
435 "status": "CREATED",
436 "name": "string",
437 "expenseCategoryType": "PAYMENT"
438 },
439 "description": "string",
440 "unitOfMeasure": {
441 "id": 0,
442 "displayId": "string",
443 "status": "CREATED",
444 "name": "string",
445 "erpSystemId": 0
446 },
447 "quantity": 0,
448 "unitPrice": 0,
449 "taxJurisdiction": {
450 "id": 0,
451 "displayId": "string",
452 "status": "CREATED",
453 "name": "string",
454 "erpSystemId": 0,
455 "schema": "string",
456 "countryDisplayId": "string"
457 },
458 "taxCode": {
459 "id": 0,
460 "displayId": "string",
461 "status": "CREATED",
462 "name": "string",
463 "erpSystemId": 0
464 },
465 "taxExpenseAccount": {
466 "id": 0,
467 "displayId": "string",
468 "generalLedgerAccountName": "string",
469 "generalLedgerAccountCode": "string",
470 "openItemManagement": true,
471 "accountCategory": "BALANCESHEET",
472 "shortName": "string",
473 "longName": "string"
474 },
475 "taxLineItems": [
476 {
477 "id": 0,
478 "taxRate": 0.1,
479 "taxAmount": 0,
480 "taxType": "string",
481 "invoiceLineItemId": 0
482 }
483 ],
484 "workBreakdownStructure": {
485 "id": 0,
486 "displayId": "string",
487 "status": "CREATED",
488 "name": "string",
489 "erpSystemId": 0
490 },
491 "costCenter": {
492 "id": 0,
493 "displayId": "string",
494 "status": "CREATED",
495 "name": "string",
496 "erpSystemId": 0
497 },
498 "profitCenter": {
499 "id": 0,
500 "displayId": "string",
501 "status": "CREATED",
502 "name": "string",
503 "validTo": "2019-08-24",
504 "erpSystemId": 0,
505 "erpSystemDisplayId": "string"
506 },
507 "functionalArea": {
508 "id": 0,
509 "displayId": "string",
510 "status": "CREATED",
511 "name": "string",
512 "erpSystemId": 0
513 },
514 "businessArea": {
515 "id": 0,
516 "displayId": "string",
517 "status": "CREATED",
518 "name": "string",
519 "erpSystemId": 0
520 },
521 "segment": {
522 "id": 0,
523 "displayId": "string",
524 "status": "CREATED",
525 "name": "string",
526 "erpSystemId": 0
527 },
528 "network": {
529 "id": 0,
530 "displayId": "string",
531 "status": "CREATED",
532 "name": "string",
533 "erpSystemId": 0
534 },
535 "internalOrderType": {
536 "id": 0,
537 "displayId": "string",
538 "status": "CREATED",
539 "name": "string",
540 "erpSystemId": 0
541 },
542 "internalOrder": {
543 "id": 0,
544 "displayId": "string",
545 "status": "CREATED",
546 "name": "string",
547 "erpSystemId": 0,
548 "internalOrderTypeId": 0
549 },
550 "additionalCurrencies": [
551 {
552 "id": 0,
553 "amount": 0,
554 "currency": {
555 "id": 0,
556 "displayId": "string",
557 "status": "CREATED",
558 "name": "string",
559 "decimalPoints": 0
560 },
561 "conversionRate": 0,
562 "conversionDate": "2019-08-24",
563 "translationDateType": "DOCUMENT_DATE",
564 "amountType": "NET_AMOUNT",
565 "currencyDefinitionType": "CONTRACT_CURRENCY",
566 "invoiceEntryId": 0,
567 "invoiceEntryDisplayId": "string"
568 }
569 ],
570 "scheduledPaymentMatches": [
571 {
572 "id": 0,
573 "fromId": 0,
574 "toId": 0,
575 "amount": 0
576 }
577 ],
578 "goodsReceiptLineItemLinks": [
579 {
580 "id": 0,
581 "fromId": 0,
582 "toId": 0,
583 "linkedQuantity": 0
584 }
585 ],
586 "invoiceId": 0,
587 "invoiceDisplayId": "string",
588 "invoiceState": "INV_DRAFT",
589 "vendorPaymentId": 0,
590 "purchaseOrderLineItemId": 0,
591 "netAmount": 0,
592 "allowsSystemGenerateNewId": true,
593 "numberRangeIdentifierValue": "string",
594 "numberRangeIdentifierType": {
595 "name": "string"
596 },
597 "numberRangeType": {
598 "name": "string"
599 }
600 }
601 ],
602 "workspaceId": 0,
603 "workspaceDisplayId": "string",
604 "workspaceName": "string",
605 "workspaceState": "INV_DRAFT",
606 "remainingNetAmount": 0,
607 "remainingTaxAmount": 0,
608 "remainingTotalAmount": 0,
609 "pendingPaymentCount": 0,
610 "allPaymentsPosted": true,
611 "approvalInfo": {
612 "approverUsername": "string",
613 "approvedAt": "2019-08-24T14:15:22Z"
614 },
615 "rejectionReason": "string",
616 "allowsSystemGenerateNewId": true,
617 "numberRangeIdentifierValue": "string",
618 "numberRangeIdentifierType": {
619 "name": "string"
620 },
621 "numberRangeType": {
622 "name": "string"
623 }
624 }
625 ],
626 "rejectionReason": "string",
627 "allowsSystemGenerateNewId": true,
628 "numberRangeIdentifierValue": "string",
629 "numberRangeIdentifierType": {
630 "name": "string"
631 },
632 "numberRangeType": {
633 "name": "string"
634 }
635 }
636}
📄 Description: Data transfer object representing the details of a purchase order, including item specifications, quantities, and pricing, essential for tracking procurement activities and facilitating efficient order management.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
code |
string |
false |
none |
Code identifier for the resource |
message |
string |
false |
write-only |
Contains a descriptive message related to the purchase order, providing essential context for transaction details. |
defaultMessage |
string |
false |
write-only |
Default message to be displayed in the purchase order response, providing essential information to the user. |
debugMessage |
string |
false |
write-only |
Provides detailed information about any errors or issues encountered during the processing of the purchase order, aiding in troubleshooting and resolution. |
errors |
false |
none |
Collection of error messages related to the processing of the purchase order, providing insights for troubleshooting and resolution. |
|
object |
false |
none |
Represents the details of the purchase order response, encapsulating relevant transaction information for processing and record-keeping. |
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 |