SearchResponseDtoPurchaseOrderDto¶
Example Json Object
1{
2 "results": [
3 {
4 "id": 0,
5 "displayId": "string",
6 "state": "INV_DRAFT",
7 "issueDate": "2019-08-24",
8 "expectedDeliveryDate": "2019-08-24",
9 "name": "string",
10 "shippingAddress": "string",
11 "notes": "string",
12 "netAmount": 0,
13 "taxAmount": 0,
14 "externalPurchaseOrderDisplayId": "string",
15 "vendor": {
16 "id": 0,
17 "displayId": "string",
18 "status": "CREATED",
19 "name": "string",
20 "erpSystemDisplayId": "string"
21 },
22 "currency": {
23 "id": 0,
24 "displayId": "string",
25 "status": "CREATED",
26 "name": "string",
27 "decimalPoints": 0
28 },
29 "company": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "erpSystemId": 0,
34 "erpSystemDisplayId": "string",
35 "countryId": 0,
36 "countryDisplayId": "string",
37 "name": "string",
38 "postingPeriodVariantId": 0,
39 "fiscalVariantId": 0
40 },
41 "purchaseOrderLineItems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "quantity": 0,
46 "allocatedQuantity": 0,
47 "receivedQuantity": 0,
48 "unitPrice": 0,
49 "description": "string",
50 "expenseCategory": {
51 "id": 0,
52 "displayId": "string",
53 "status": "CREATED",
54 "name": "string",
55 "expenseCategoryType": "PAYMENT"
56 },
57 "costCenter": {
58 "id": 0,
59 "displayId": "string",
60 "status": "CREATED",
61 "name": "string",
62 "erpSystemId": 0
63 },
64 "profitCenter": {
65 "id": 0,
66 "displayId": "string",
67 "status": "CREATED",
68 "name": "string",
69 "validTo": "2019-08-24",
70 "erpSystemId": 0,
71 "erpSystemDisplayId": "string"
72 },
73 "taxJurisdiction": {
74 "id": 0,
75 "displayId": "string",
76 "status": "CREATED",
77 "name": "string",
78 "erpSystemId": 0,
79 "schema": "string",
80 "countryDisplayId": "string"
81 },
82 "taxCode": {
83 "id": 0,
84 "displayId": "string",
85 "status": "CREATED",
86 "name": "string",
87 "erpSystemId": 0
88 },
89 "taxLineItems": [
90 {
91 "id": 0,
92 "taxRate": 0.1,
93 "taxAmount": 0,
94 "taxType": "string",
95 "purchaseOrderLineItemId": 0
96 }
97 ],
98 "purchaseOrderId": 0,
99 "purchaseOrderDisplayId": "string",
100 "purchaseOrderState": "INV_DRAFT",
101 "invoiceLineItems": [
102 {
103 "id": 0,
104 "displayId": "string",
105 "expenseCategory": {
106 "id": 0,
107 "displayId": "string",
108 "status": "CREATED",
109 "name": "string",
110 "expenseCategoryType": "PAYMENT"
111 },
112 "description": "string",
113 "unitOfMeasure": {
114 "id": 0,
115 "displayId": "string",
116 "status": "CREATED",
117 "name": "string",
118 "erpSystemId": 0
119 },
120 "quantity": 0,
121 "unitPrice": 0,
122 "taxJurisdiction": {
123 "id": 0,
124 "displayId": "string",
125 "status": "CREATED",
126 "name": "string",
127 "erpSystemId": 0,
128 "schema": "string",
129 "countryDisplayId": "string"
130 },
131 "taxCode": {
132 "id": 0,
133 "displayId": "string",
134 "status": "CREATED",
135 "name": "string",
136 "erpSystemId": 0
137 },
138 "taxExpenseAccount": {
139 "id": 0,
140 "displayId": "string",
141 "generalLedgerAccountName": "string",
142 "generalLedgerAccountCode": "string",
143 "openItemManagement": true,
144 "accountCategory": "BALANCESHEET",
145 "shortName": "string",
146 "longName": "string"
147 },
148 "taxLineItems": [
149 {
150 "id": 0,
151 "taxRate": 0.1,
152 "taxAmount": 0,
153 "taxType": "string",
154 "invoiceLineItemId": 0
155 }
156 ],
157 "workBreakdownStructure": {
158 "id": 0,
159 "displayId": "string",
160 "status": "CREATED",
161 "name": "string",
162 "erpSystemId": 0
163 },
164 "costCenter": {
165 "id": 0,
166 "displayId": "string",
167 "status": "CREATED",
168 "name": "string",
169 "erpSystemId": 0
170 },
171 "profitCenter": {
172 "id": 0,
173 "displayId": "string",
174 "status": "CREATED",
175 "name": "string",
176 "validTo": "2019-08-24",
177 "erpSystemId": 0,
178 "erpSystemDisplayId": "string"
179 },
180 "functionalArea": {
181 "id": 0,
182 "displayId": "string",
183 "status": "CREATED",
184 "name": "string",
185 "erpSystemId": 0
186 },
187 "businessArea": {
188 "id": 0,
189 "displayId": "string",
190 "status": "CREATED",
191 "name": "string",
192 "erpSystemId": 0
193 },
194 "segment": {
195 "id": 0,
196 "displayId": "string",
197 "status": "CREATED",
198 "name": "string",
199 "erpSystemId": 0
200 },
201 "network": {
202 "id": 0,
203 "displayId": "string",
204 "status": "CREATED",
205 "name": "string",
206 "erpSystemId": 0
207 },
208 "internalOrderType": {
209 "id": 0,
210 "displayId": "string",
211 "status": "CREATED",
212 "name": "string",
213 "erpSystemId": 0
214 },
215 "internalOrder": {
216 "id": 0,
217 "displayId": "string",
218 "status": "CREATED",
219 "name": "string",
220 "erpSystemId": 0,
221 "internalOrderTypeId": 0
222 },
223 "additionalCurrencies": [
224 {
225 "id": 0,
226 "amount": 0,
227 "currency": {
228 "id": 0,
229 "displayId": "string",
230 "status": "CREATED",
231 "name": "string",
232 "decimalPoints": 0
233 },
234 "conversionRate": 0,
235 "conversionDate": "2019-08-24",
236 "translationDateType": "DOCUMENT_DATE",
237 "amountType": "NET_AMOUNT",
238 "currencyDefinitionType": "CONTRACT_CURRENCY",
239 "invoiceEntryId": 0,
240 "invoiceEntryDisplayId": "string"
241 }
242 ],
243 "scheduledPaymentMatches": [
244 {
245 "id": 0,
246 "fromId": 0,
247 "toId": 0,
248 "amount": 0
249 }
250 ],
251 "goodsReceiptLineItemLinks": [
252 {
253 "id": 0,
254 "fromId": 0,
255 "toId": 0,
256 "linkedQuantity": 0
257 }
258 ],
259 "invoiceId": 0,
260 "invoiceDisplayId": "string",
261 "invoiceState": "INV_DRAFT",
262 "vendorPaymentId": 0,
263 "purchaseOrderLineItemId": 0,
264 "netAmount": 0,
265 "allowsSystemGenerateNewId": true,
266 "numberRangeIdentifierValue": "string",
267 "numberRangeIdentifierType": {
268 "name": "string"
269 },
270 "numberRangeType": {
271 "name": "string"
272 }
273 }
274 ],
275 "goodsReceiptLineItems": [
276 {
277 "id": 0,
278 "displayId": "string",
279 "quantity": 0,
280 "invoicedQuantity": 0,
281 "description": "string",
282 "expenseCategory": {
283 "id": 0,
284 "displayId": "string",
285 "status": "CREATED",
286 "name": "string",
287 "expenseCategoryType": "PAYMENT"
288 },
289 "goodsReceiptId": 0,
290 "goodsReceiptDisplayId": "string",
291 "goodsReceiptState": "INV_DRAFT",
292 "purchaseOrderLineItemId": 0,
293 "invoiceLineItemLinks": [
294 {
295 "id": 0,
296 "fromId": 0,
297 "toId": 0,
298 "linkedQuantity": 0
299 }
300 ],
301 "availableQuantity": 0,
302 "allowsSystemGenerateNewId": true,
303 "numberRangeIdentifierValue": "string",
304 "numberRangeIdentifierType": {
305 "name": "string"
306 },
307 "numberRangeType": {
308 "name": "string"
309 }
310 }
311 ],
312 "vendorPaymentId": 0,
313 "purchaseRequisitionLineItemId": 0,
314 "purchaseRequisitionDisplayId": "string",
315 "purchaseRequisitionLineItemAvailableQuantity": 0,
316 "remainingQuantity": 0,
317 "availableQuantity": 0,
318 "allowsSystemGenerateNewId": true,
319 "numberRangeIdentifierValue": "string",
320 "numberRangeIdentifierType": {
321 "name": "string"
322 },
323 "numberRangeType": {
324 "name": "string"
325 }
326 }
327 ],
328 "purchaseRequisitionIds": [
329 0
330 ],
331 "purchaseRequisitionDisplayIds": [
332 "string"
333 ],
334 "invoices": [
335 {
336 "id": 0,
337 "displayId": "string",
338 "name": "string",
339 "invoiceType": "VENDOR_INV",
340 "state": "INV_DRAFT",
341 "externalDocumentNumber": "string",
342 "purchaseOrderReference": "string",
343 "invoiceDate": "2019-08-24",
344 "dueDate": "2019-08-24",
345 "notes": "string",
346 "billingPeriodFromDate": "2019-08-24",
347 "billingPeriodToDate": "2019-08-24",
348 "currency": {
349 "id": 0,
350 "displayId": "string",
351 "status": "CREATED",
352 "name": "string",
353 "decimalPoints": 0
354 },
355 "vendor": {
356 "id": 0,
357 "displayId": "string",
358 "status": "CREATED",
359 "name": "string",
360 "erpSystemDisplayId": "string"
361 },
362 "company": {
363 "id": 0,
364 "displayId": "string",
365 "status": "CREATED",
366 "erpSystemId": 0,
367 "erpSystemDisplayId": "string",
368 "countryId": 0,
369 "countryDisplayId": "string",
370 "name": "string",
371 "postingPeriodVariantId": 0,
372 "fiscalVariantId": 0
373 },
374 "netAmount": 0,
375 "taxAmount": 0,
376 "totalAmount": 0,
377 "netAmountBalance": 0,
378 "taxAmountBalance": 0,
379 "paymentTerm": {
380 "id": 0,
381 "displayId": "string",
382 "status": "CREATED",
383 "name": "string"
384 },
385 "paymentMethod": {
386 "id": 0,
387 "displayId": "string",
388 "status": "CREATED",
389 "name": "string",
390 "type": "string"
391 },
392 "paymentBlock": {
393 "id": 0,
394 "displayId": "string",
395 "status": "CREATED",
396 "name": "string"
397 },
398 "defaultCostCenter": {
399 "id": 0,
400 "displayId": "string",
401 "status": "CREATED",
402 "name": "string",
403 "erpSystemId": 0
404 },
405 "defaultProfitCenter": {
406 "id": 0,
407 "displayId": "string",
408 "status": "CREATED",
409 "name": "string",
410 "validTo": "2019-08-24",
411 "erpSystemId": 0,
412 "erpSystemDisplayId": "string"
413 },
414 "invoiceLineItems": [
415 {
416 "id": 0,
417 "displayId": "string",
418 "expenseCategory": {
419 "id": 0,
420 "displayId": "string",
421 "status": "CREATED",
422 "name": "string",
423 "expenseCategoryType": "PAYMENT"
424 },
425 "description": "string",
426 "unitOfMeasure": {
427 "id": 0,
428 "displayId": "string",
429 "status": "CREATED",
430 "name": "string",
431 "erpSystemId": 0
432 },
433 "quantity": 0,
434 "unitPrice": 0,
435 "taxJurisdiction": {
436 "id": 0,
437 "displayId": "string",
438 "status": "CREATED",
439 "name": "string",
440 "erpSystemId": 0,
441 "schema": "string",
442 "countryDisplayId": "string"
443 },
444 "taxCode": {
445 "id": 0,
446 "displayId": "string",
447 "status": "CREATED",
448 "name": "string",
449 "erpSystemId": 0
450 },
451 "taxExpenseAccount": {
452 "id": 0,
453 "displayId": "string",
454 "generalLedgerAccountName": "string",
455 "generalLedgerAccountCode": "string",
456 "openItemManagement": true,
457 "accountCategory": "BALANCESHEET",
458 "shortName": "string",
459 "longName": "string"
460 },
461 "taxLineItems": [
462 {
463 "id": 0,
464 "taxRate": 0.1,
465 "taxAmount": 0,
466 "taxType": "string",
467 "invoiceLineItemId": 0
468 }
469 ],
470 "workBreakdownStructure": {
471 "id": 0,
472 "displayId": "string",
473 "status": "CREATED",
474 "name": "string",
475 "erpSystemId": 0
476 },
477 "costCenter": {
478 "id": 0,
479 "displayId": "string",
480 "status": "CREATED",
481 "name": "string",
482 "erpSystemId": 0
483 },
484 "profitCenter": {
485 "id": 0,
486 "displayId": "string",
487 "status": "CREATED",
488 "name": "string",
489 "validTo": "2019-08-24",
490 "erpSystemId": 0,
491 "erpSystemDisplayId": "string"
492 },
493 "functionalArea": {
494 "id": 0,
495 "displayId": "string",
496 "status": "CREATED",
497 "name": "string",
498 "erpSystemId": 0
499 },
500 "businessArea": {
501 "id": 0,
502 "displayId": "string",
503 "status": "CREATED",
504 "name": "string",
505 "erpSystemId": 0
506 },
507 "segment": {
508 "id": 0,
509 "displayId": "string",
510 "status": "CREATED",
511 "name": "string",
512 "erpSystemId": 0
513 },
514 "network": {
515 "id": 0,
516 "displayId": "string",
517 "status": "CREATED",
518 "name": "string",
519 "erpSystemId": 0
520 },
521 "internalOrderType": {
522 "id": 0,
523 "displayId": "string",
524 "status": "CREATED",
525 "name": "string",
526 "erpSystemId": 0
527 },
528 "internalOrder": {
529 "id": 0,
530 "displayId": "string",
531 "status": "CREATED",
532 "name": "string",
533 "erpSystemId": 0,
534 "internalOrderTypeId": 0
535 },
536 "additionalCurrencies": [
537 {
538 "id": 0,
539 "amount": 0,
540 "currency": {
541 "id": 0,
542 "displayId": "string",
543 "status": "CREATED",
544 "name": "string",
545 "decimalPoints": 0
546 },
547 "conversionRate": 0,
548 "conversionDate": "2019-08-24",
549 "translationDateType": "DOCUMENT_DATE",
550 "amountType": "NET_AMOUNT",
551 "currencyDefinitionType": "CONTRACT_CURRENCY",
552 "invoiceEntryId": 0,
553 "invoiceEntryDisplayId": "string"
554 }
555 ],
556 "scheduledPaymentMatches": [
557 {
558 "id": 0,
559 "fromId": 0,
560 "toId": 0,
561 "amount": 0
562 }
563 ],
564 "goodsReceiptLineItemLinks": [
565 {
566 "id": 0,
567 "fromId": 0,
568 "toId": 0,
569 "linkedQuantity": 0
570 }
571 ],
572 "invoiceId": 0,
573 "invoiceDisplayId": "string",
574 "invoiceState": "INV_DRAFT",
575 "vendorPaymentId": 0,
576 "purchaseOrderLineItemId": 0,
577 "netAmount": 0,
578 "allowsSystemGenerateNewId": true,
579 "numberRangeIdentifierValue": "string",
580 "numberRangeIdentifierType": {
581 "name": "string"
582 },
583 "numberRangeType": {
584 "name": "string"
585 }
586 }
587 ],
588 "workspaceId": 0,
589 "workspaceDisplayId": "string",
590 "workspaceName": "string",
591 "workspaceState": "INV_DRAFT",
592 "remainingNetAmount": 0,
593 "remainingTaxAmount": 0,
594 "remainingTotalAmount": 0,
595 "pendingPaymentCount": 0,
596 "allPaymentsPosted": true,
597 "approvalInfo": {
598 "approverUsername": "string",
599 "approvedAt": "2019-08-24T14:15:22Z"
600 },
601 "rejectionReason": "string",
602 "allowsSystemGenerateNewId": true,
603 "numberRangeIdentifierValue": "string",
604 "numberRangeIdentifierType": {
605 "name": "string"
606 },
607 "numberRangeType": {
608 "name": "string"
609 }
610 }
611 ],
612 "rejectionReason": "string",
613 "allowsSystemGenerateNewId": true,
614 "numberRangeIdentifierValue": "string",
615 "numberRangeIdentifierType": {
616 "name": "string"
617 },
618 "numberRangeType": {
619 "name": "string"
620 }
621 }
622 ],
623 "facets": {
624 "property1": {},
625 "property2": {}
626 },
627 "aggregations": {
628 "property1": {},
629 "property2": {}
630 },
631 "pagination": {
632 "number": 0,
633 "size": 0,
634 "totalElements": 0,
635 "totalPages": 0,
636 "first": true,
637 "last": true,
638 "empty": true,
639 "numberOfElements": 0
640 }
641}
📄 Description: Data transfer object representing the details of a purchase order, including relevant metadata and status information, to facilitate efficient order management and tracking within the procurement process.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
results |
false |
none |
An array of purchase order details returned in the search response, providing insights into procurement activities. |
|
facets |
object |
false |
none |
The ‘facets’ field provides structured insights into the various attributes of the purchase order, enabling users to refine and enhance their search results effectively. |
» additionalProperties |
object |
false |
none |
none |
aggregations |
object |
false |
none |
Aggregations provide summarized insights and metrics related to purchase orders, enabling businesses to analyze purchasing trends and make informed decisions. |
» additionalProperties |
object |
false |
none |
none |
pagination |
false |
none |
Pagination controls the segmentation of search results for purchase orders, enabling efficient navigation through large datasets. |