PurchaseOrderDto

Example Json Object

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

📄 Description: Data transfer object representing a purchase order, encapsulating essential details such as order items, quantities, pricing, and supplier information to facilitate efficient procurement processes.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

displayId

string

false

none

Unique identifier for the display

state

string

false

none

Represents the current status of the purchase order, indicating its progress within the procurement process.

issueDate

string(date)

false

none

Date of the issue

expectedDeliveryDate

string(date)

false

none

Date of the expected delivery

name

string

false

none

Name of the resource

shippingAddress

string

false

none

Represents the destination address for the delivery of goods associated with the purchase order.

notes

string

false

none

Additional comments or observations related to the purchase order, providing context for stakeholders involved in the procurement process.

netAmount

number

false

none

Amount of net

taxAmount

number

false

none

Amount of tax

externalPurchaseOrderDisplayId

string

false

none

Unique identifier for the external purchase order display

vendor

PartnerLite

false

none

Identifies the vendor associated with the purchase order, facilitating effective supplier management and procurement processes.

currency

CurrencyLite

false

none

Specifies the currency in which the purchase order is denominated, ensuring accurate financial transactions and reporting.

company

CompanyLite

false

none

Represents the name of the company associated with the purchase order, facilitating accurate tracking and management of procurement activities.

purchaseOrderLineItems

[PurchaseOrderLineItemDto]

false

none

An array of purchase order line items detailing the specific products or services included in the purchase order.

purchaseRequisitionIds

[integer]

false

none

An array of unique identifiers for purchase requisitions associated with the purchase order, facilitating efficient tracking and management of procurement activities.

purchaseRequisitionDisplayIds

[string]

false

none

An array of unique identifiers for purchase requisitions associated with the purchase order, facilitating streamlined tracking and management of procurement requests.

invoices

[InvoiceDto]

false

none

An array of Purchase Order Data Transfer Objects (PurchaseOrderDto) representing the invoices associated with the transaction.

rejectionReason

string

false

none

none

allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

numberRangeIdentifierValue

string

false

none

Represents a unique identifier for the number range associated with the purchase order, facilitating efficient tracking and management of order processing.

numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Type of the number range identifier

numberRangeType

INumberRangeType

false

none

Type of the number range

Enumerated Values

Attribute

Value

state

GOODS_RECEIPT_DRAFT, GOODS_RECEIPT_MATCHED, GOODS_RECEIPT_RECEIVED, GOODS_RECEIPT_REJECTED, INVOICE_PAYMENT_DRAFT, INVOICE_PAYMENT_JOURNALS_GENERATING, INVOICE_PAYMENT_POSTED, INVOICE_PAYMENT_POSTING, INVOICE_PAYMENT_REVIEW, INV_APPROVED, INV_DRAFT, INV_GENERATING_JOURNALS, INV_PAID, INV_POSTED, INV_POSTING, INV_REJECTED, INV_REVIEW, INV_WAITING_FOR_APPROVAL, PURCHASE_ORDER_APPROVED, PURCHASE_ORDER_DRAFT, PURCHASE_ORDER_REJECTED, PURCHASE_ORDER_WAITING_FOR_APPROVAL, PURCHASE_REQUISITION_APPROVED, PURCHASE_REQUISITION_DRAFT, PURCHASE_REQUISITION_REJECTED, PURCHASE_REQUISITION_WAITING_FOR_APPROVAL, VENDOR_REQUEST_APPROVED, VENDOR_REQUEST_DRAFT, VENDOR_REQUEST_PENDING_APPROVAL, VENDOR_REQUEST_REJECTED, WORKSPACE_CLOSED, WORKSPACE_JOURNALS_GENERATING, WORKSPACE_OPEN, WORKSPACE_POSTING, WORKSPACE_REVIEW