GET api/Order/GetOrder/{orderYear}/{orderBook}/{orderNumber}

Request Information

URI Parameters

Name	Type	Additional information
orderYear	integer	Required
orderBook	string	Required
orderNumber	integer	Required

Body Parameters

None.

Response Information

Resource Description

OrderHeaderDetail

Name	Type	Additional information
OrderYear	integer	None.
OrderBook	string	None.
OrderNumber	integer	None.
InvoiceBook	string	None.
WarehouseId	string	None.
CustomerId	string	None.
CustomerTitle1	string	None.
CustomerTitle2	string	None.
CustomerTitle3	string	None.
CustomerAddress	string	None.
CustomerHouseNo	string	None.
CustomerPostalCode	string	None.
CustomerCity	string	None.
CustomerCountry	string	None.
CustomerTaxNumber	string	None.
CustomerShopID	string	None.
CustomerPayerId	string	None.
PayerTitle1	string	None.
PayerTitle2	string	None.
PayerTitle3	string	None.
PayerAddress	string	None.
PayerHouseNo	string	None.
PayerPostalCode	string	None.
PayerCity	string	None.
PayerCountry	string	None.
PayerTaxNumber	string	None.
OrderDate	date	None.
ConfirmationDate	date	None.
CustomerConfirmationDate	date	None.
OrderReference	string	None.
QuotationNumber	string	None.
DeliveryAddress	string	None.
DeliveryMethod	string	None.
CurrencyId	string	None.
PriceListId	string	None.
CostCenterId	string	None.
CostUnitId	string	None.
ClerkId	string	None.
WorkOrderId	string	None.
AnalyticId	string	None.
AccountingBookGroupId	string	None.
CustomerClerkID	string	None.
CustomerClerkName	string	None.
RebatePercentage	decimal number	None.
RebatePercentage2	decimal number	None.
RebatePercentage3	decimal number	None.
RebatePercentage4	decimal number	None.
RebatePercentage5	decimal number	None.
RebateAmountDocument	decimal number	None.
DocumentSalesType	string	None.
DiscountGroupId	string	None.
Comment	string	None.
ParityCode	string	None.
ParityPlace	string	None.
AttachmentID	string	None.
AnnexID	string	None.
FolderID	string	None.
DocumentHeaderDescription	string	None.
DocumentFooterDescription	string	None.
DeliveryDate	date	None.
CustomerDeliveryDate	date	None.
OrderStatus	string	None.
OrderDetailsStatus	string	None.
GrossAmount	decimal number	None.
DiscountAmount	decimal number	None.
RebateAmount	decimal number	None.
NetAmount	decimal number	None.
VATAmount	decimal number	None.
PaymentAmount	decimal number	None.
ReferenceDeliveryNote	string	None.
ReferenceWarehouseDocument	string	None.
ReferenceBill	string	None.
ReferenceInvoice	string	None.
ReferenceAdvancePayment	string	None.
ReferenceServiceInvoice	string	None.
Consigment	boolean	None.
ConsigmentWarehouseID	string	None.
ExchangeRateDate	date	None.
ExchangeRate	decimal number	None.
LanguageID	string	None.
VATCalculated	string	None.
VATInvoiceType	string	None.
ExciseDuty	boolean	None.
DiscountAmountType	boolean	None.
DiscountCalculationMethod	boolean	None.
PaymentPeriod	integer	None.
OrderType	string	None.
QuotationYear	integer	None.
LocationID	string	None.
CarrierID	string	None.
VehicleRegistrationNumber	string	None.
TrailerRegistrationNumber	string	None.
Driver	string	None.
UnloadingTime	date	None.
UnloadingNote	string	None.
PaymentPurposeCode	string	None.
CashPayment	boolean	None.
CashierID	string	None.
PaymentTypeID	string	None.
CustomerClerkSEQ	string	None.
InsertedBy	string	None.
InsertedTime	date	None.
ModifiedBy	string	None.
ModifiedTime	date	None.
Analytics_AN1_ID	string	None.
Analytics_AN2_ID	string	None.
Analytics_AN3_ID	string	None.
DeliveryPlace	string	None.
DocumentDeliveryTitle1	string	None.
DocumentDeliveryTitle2	string	None.
DocumentDeliveryTitle3	string	None.
DocumentDeliveryAddress	string	None.
DocumentDeliveryHouseNo	string	None.
DocumentDeliveryPostalCode	string	None.
DocumentDeliveryCity	string	None.
DocumentDeliveryCountry	string	None.
ProformaInvoiceYear	string	None.
ProformaInvoiceBook	string	None.
ProformaInvoiceNumber	string	None.
ProformaInvoicePaymentStatus	string	None.
PaymentMethod	string	None.
RequiredPrepaymentPercent	decimal number	None.
CancelledDate	date	None.
DeliveryLocationAddress	string	None.
VATTaxCategory	string	None.
PaymentReferenceExternal	string	None.
OrderPriority	integer	None.
OrderReservation	boolean	None.
DeliveryContactTypeID	string	None.
DeliveryContactInTypeID	integer	None.
DeliveryContactDescription	string	None.
DeliveryContactPhoneNo	string	None.
OrderLines	OrderLine_	None.
OrderPaymentLines	OrderPaymentLines	None.

Response Formats

application/xml, text/xml

Sample:

<OrderHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderYear>1</OrderYear>
  <OrderBook>sample string 2</OrderBook>
  <OrderNumber>3</OrderNumber>
  <InvoiceBook>sample string 4</InvoiceBook>
  <WarehouseId>sample string 5</WarehouseId>
  <CustomerId>sample string 6</CustomerId>
  <CustomerTitle1>sample string 7</CustomerTitle1>
  <CustomerTitle2>sample string 8</CustomerTitle2>
  <CustomerTitle3>sample string 9</CustomerTitle3>
  <CustomerAddress>sample string 10</CustomerAddress>
  <CustomerHouseNo>sample string 11</CustomerHouseNo>
  <CustomerPostalCode>sample string 12</CustomerPostalCode>
  <CustomerCity>sample string 13</CustomerCity>
  <CustomerCountry>sample string 14</CustomerCountry>
  <CustomerTaxNumber>sample string 15</CustomerTaxNumber>
  <CustomerShopID>sample string 16</CustomerShopID>
  <CustomerPayerId>sample string 17</CustomerPayerId>
  <PayerTitle1>sample string 18</PayerTitle1>
  <PayerTitle2>sample string 19</PayerTitle2>
  <PayerTitle3>sample string 20</PayerTitle3>
  <PayerAddress>sample string 21</PayerAddress>
  <PayerHouseNo>sample string 22</PayerHouseNo>
  <PayerPostalCode>sample string 23</PayerPostalCode>
  <PayerCity>sample string 24</PayerCity>
  <PayerCountry>sample string 25</PayerCountry>
  <PayerTaxNumber>sample string 26</PayerTaxNumber>
  <OrderDate>2025-10-27T22:35:47.562807+01:00</OrderDate>
  <ConfirmationDate>2025-10-27T22:35:47.562807+01:00</ConfirmationDate>
  <CustomerConfirmationDate>2025-10-27T22:35:47.562807+01:00</CustomerConfirmationDate>
  <OrderReference>sample string 27</OrderReference>
  <QuotationNumber>sample string 28</QuotationNumber>
  <DeliveryAddress>sample string 29</DeliveryAddress>
  <DeliveryMethod>sample string 30</DeliveryMethod>
  <CurrencyId>sample string 31</CurrencyId>
  <PriceListId>sample string 32</PriceListId>
  <CostCenterId>sample string 33</CostCenterId>
  <CostUnitId>sample string 34</CostUnitId>
  <ClerkId>sample string 35</ClerkId>
  <WorkOrderId>sample string 36</WorkOrderId>
  <AnalyticId>sample string 37</AnalyticId>
  <AccountingBookGroupId>sample string 38</AccountingBookGroupId>
  <CustomerClerkID>sample string 39</CustomerClerkID>
  <CustomerClerkName>sample string 40</CustomerClerkName>
  <RebatePercentage>1</RebatePercentage>
  <RebatePercentage2>1</RebatePercentage2>
  <RebatePercentage3>1</RebatePercentage3>
  <RebatePercentage4>1</RebatePercentage4>
  <RebatePercentage5>1</RebatePercentage5>
  <RebateAmountDocument>1</RebateAmountDocument>
  <DocumentSalesType>sample string 41</DocumentSalesType>
  <DiscountGroupId>sample string 42</DiscountGroupId>
  <Comment>sample string 43</Comment>
  <ParityCode>sample string 44</ParityCode>
  <ParityPlace>sample string 45</ParityPlace>
  <AttachmentID>sample string 46</AttachmentID>
  <AnnexID>sample string 47</AnnexID>
  <FolderID>sample string 48</FolderID>
  <DocumentHeaderDescription>sample string 49</DocumentHeaderDescription>
  <DocumentFooterDescription>sample string 50</DocumentFooterDescription>
  <DeliveryDate>2025-10-27T22:35:47.562807+01:00</DeliveryDate>
  <CustomerDeliveryDate>2025-10-27T22:35:47.562807+01:00</CustomerDeliveryDate>
  <OrderStatus>sample string 51</OrderStatus>
  <OrderDetailsStatus>sample string 52</OrderDetailsStatus>
  <GrossAmount>1</GrossAmount>
  <DiscountAmount>1</DiscountAmount>
  <RebateAmount>1</RebateAmount>
  <NetAmount>1</NetAmount>
  <VATAmount>1</VATAmount>
  <PaymentAmount>1</PaymentAmount>
  <ReferenceDeliveryNote>sample string 53</ReferenceDeliveryNote>
  <ReferenceWarehouseDocument>sample string 54</ReferenceWarehouseDocument>
  <ReferenceBill>sample string 55</ReferenceBill>
  <ReferenceInvoice>sample string 56</ReferenceInvoice>
  <ReferenceAdvancePayment>sample string 57</ReferenceAdvancePayment>
  <ReferenceServiceInvoice>sample string 58</ReferenceServiceInvoice>
  <Consigment>true</Consigment>
  <ConsigmentWarehouseID>sample string 59</ConsigmentWarehouseID>
  <ExchangeRateDate>2025-10-27T22:35:47.562807+01:00</ExchangeRateDate>
  <ExchangeRate>1</ExchangeRate>
  <LanguageID>sample string 60</LanguageID>
  <VATCalculated>sample string 61</VATCalculated>
  <VATInvoiceType>sample string 62</VATInvoiceType>
  <ExciseDuty>true</ExciseDuty>
  <DiscountAmountType>true</DiscountAmountType>
  <DiscountCalculationMethod>true</DiscountCalculationMethod>
  <PaymentPeriod>63</PaymentPeriod>
  <OrderType>sample string 64</OrderType>
  <QuotationYear>65</QuotationYear>
  <LocationID>sample string 66</LocationID>
  <CarrierID>sample string 67</CarrierID>
  <VehicleRegistrationNumber>sample string 68</VehicleRegistrationNumber>
  <TrailerRegistrationNumber>sample string 69</TrailerRegistrationNumber>
  <Driver>sample string 70</Driver>
  <UnloadingTime>2025-10-27T22:35:47.562807+01:00</UnloadingTime>
  <UnloadingNote>sample string 71</UnloadingNote>
  <PaymentPurposeCode>sample string 72</PaymentPurposeCode>
  <CashPayment>true</CashPayment>
  <CashierID>sample string 73</CashierID>
  <PaymentTypeID>sample string 74</PaymentTypeID>
  <CustomerClerkSEQ>sample string 75</CustomerClerkSEQ>
  <InsertedBy>sample string 76</InsertedBy>
  <InsertedTime>2025-10-27T22:35:47.562807+01:00</InsertedTime>
  <ModifiedBy>sample string 77</ModifiedBy>
  <ModifiedTime>2025-10-27T22:35:47.562807+01:00</ModifiedTime>
  <Analytics_AN1_ID>sample string 78</Analytics_AN1_ID>
  <Analytics_AN2_ID>sample string 79</Analytics_AN2_ID>
  <Analytics_AN3_ID>sample string 80</Analytics_AN3_ID>
  <DeliveryPlace>sample string 81</DeliveryPlace>
  <DocumentDeliveryTitle1>sample string 82</DocumentDeliveryTitle1>
  <DocumentDeliveryTitle2>sample string 83</DocumentDeliveryTitle2>
  <DocumentDeliveryTitle3>sample string 84</DocumentDeliveryTitle3>
  <DocumentDeliveryAddress>sample string 85</DocumentDeliveryAddress>
  <DocumentDeliveryHouseNo>sample string 86</DocumentDeliveryHouseNo>
  <DocumentDeliveryPostalCode>sample string 87</DocumentDeliveryPostalCode>
  <DocumentDeliveryCity>sample string 88</DocumentDeliveryCity>
  <DocumentDeliveryCountry>sample string 89</DocumentDeliveryCountry>
  <ProformaInvoiceYear>sample string 90</ProformaInvoiceYear>
  <ProformaInvoiceBook>sample string 91</ProformaInvoiceBook>
  <ProformaInvoiceNumber>sample string 92</ProformaInvoiceNumber>
  <ProformaInvoicePaymentStatus>sample string 93</ProformaInvoicePaymentStatus>
  <PaymentMethod>sample string 94</PaymentMethod>
  <RequiredPrepaymentPercent>1</RequiredPrepaymentPercent>
  <CancelledDate>2025-10-27T22:35:47.562807+01:00</CancelledDate>
  <DeliveryLocationAddress>sample string 95</DeliveryLocationAddress>
  <VATTaxCategory>sample string 96</VATTaxCategory>
  <PaymentReferenceExternal>sample string 97</PaymentReferenceExternal>
  <OrderPriority>1</OrderPriority>
  <OrderReservation>true</OrderReservation>
  <DeliveryContactTypeID>sample string 98</DeliveryContactTypeID>
  <DeliveryContactInTypeID>1</DeliveryContactInTypeID>
  <DeliveryContactDescription>sample string 99</DeliveryContactDescription>
  <DeliveryContactPhoneNo>sample string 100</DeliveryContactPhoneNo>
  <OrderLines>
    <OrderLine OrderLineNo="1">
      <ItemID>sample string 2</ItemID>
      <ItemIDType>sample string 3</ItemIDType>
      <ItemTitle1>sample string 4</ItemTitle1>
      <ItemTitle2>sample string 5</ItemTitle2>
      <ItemDescription>sample string 6</ItemDescription>
      <Qty>1</Qty>
      <Series>sample string 7</Series>
      <ItemBarCode>sample string 8</ItemBarCode>
      <AlternateBarCode>sample string 9</AlternateBarCode>
      <AlternateQuantity>1</AlternateQuantity>
      <AlternateConvertFactor>1</AlternateConvertFactor>
      <AlternateUnitOfMeasurement>sample string 10</AlternateUnitOfMeasurement>
      <ShippedQTY>1</ShippedQTY>
      <ExpirationDate>2025-10-27T22:35:47.562807+01:00</ExpirationDate>
      <WareHouseId>sample string 11</WareHouseId>
      <Price>1</Price>
      <PriceWithVAT>1</PriceWithVAT>
      <DiscountPercentage>1</DiscountPercentage>
      <DiscountPercentage2>1</DiscountPercentage2>
      <DiscountPercentage3>1</DiscountPercentage3>
      <DiscountPercentage4>1</DiscountPercentage4>
      <DiscountPercentage5>1</DiscountPercentage5>
      <DiscountAmountAmount>1</DiscountAmountAmount>
      <VATRateId>sample string 12</VATRateId>
      <VATRatePercent>1</VATRatePercent>
      <PriceIncludeVAT>true</PriceIncludeVAT>
      <Comment>sample string 13</Comment>
      <CostCenterId>sample string 14</CostCenterId>
      <CostUnitId>sample string 15</CostUnitId>
      <ClerkId>sample string 16</ClerkId>
      <WorkOrderid>sample string 17</WorkOrderid>
      <AnalyticId>sample string 18</AnalyticId>
      <TextLine>true</TextLine>
      <VATCalculated>sample string 19</VATCalculated>
      <VATInvoiceType>sample string 20</VATInvoiceType>
      <ReservedQTY>1</ReservedQTY>
      <ReservedToDate>2025-10-27T22:35:47.562807+01:00</ReservedToDate>
      <UnitOfMeasure>sample string 21</UnitOfMeasure>
      <DeliveryDate>2025-10-27T22:35:47.562807+01:00</DeliveryDate>
      <Status>sample string 22</Status>
      <ClosedLine>true</ClosedLine>
      <GrossAmout>1</GrossAmout>
      <IntermediateAmount>1</IntermediateAmount>
      <NetAmount>1</NetAmount>
      <VATAmount>1</VATAmount>
      <DiscountAmount>1</DiscountAmount>
      <RebatAmount>1</RebatAmount>
      <OrderedQtyCustomer>1</OrderedQtyCustomer>
      <WHTypeID>sample string 23</WHTypeID>
      <ConsigmentWarehouseID>sample string 24</ConsigmentWarehouseID>
      <CustomerDeliveryDate>2025-10-27T22:35:47.562807+01:00</CustomerDeliveryDate>
      <QuotationNumber>sample string 25</QuotationNumber>
      <QuotationYear>26</QuotationYear>
      <NumberOfPackages>27</NumberOfPackages>
      <InsertedBy>sample string 28</InsertedBy>
      <InsertedTime>2025-10-27T22:35:47.562807+01:00</InsertedTime>
      <ModifiedBy>sample string 29</ModifiedBy>
      <ModifiedTime>2025-10-27T22:35:47.562807+01:00</ModifiedTime>
      <ExciseDuty>true</ExciseDuty>
      <ExciseDutyID>sample string 30</ExciseDutyID>
      <ExciseDutyConvertFactor>1</ExciseDutyConvertFactor>
      <ExciseDutyPercentage>1</ExciseDutyPercentage>
      <ExciseDutyAmount>1</ExciseDutyAmount>
      <ExciseDutyValue>1</ExciseDutyValue>
      <ExciseDutyMinimalValue>1</ExciseDutyMinimalValue>
      <InsUpdDate>2025-10-27T22:35:47.562807+01:00</InsUpdDate>
      <Analytics_AN1_ID>sample string 31</Analytics_AN1_ID>
      <Analytics_AN2_ID>sample string 32</Analytics_AN2_ID>
      <Analytics_AN3_ID>sample string 33</Analytics_AN3_ID>
      <WorkOrderYear>34</WorkOrderYear>
      <WorkOrderBook>sample string 35</WorkOrderBook>
      <WorkOrderNumber>36</WorkOrderNumber>
      <VATTaxCategory>sample string 37</VATTaxCategory>
      <OrderLineReservation>true</OrderLineReservation>
    </OrderLine>
    <OrderLine OrderLineNo="1">
      <ItemID>sample string 2</ItemID>
      <ItemIDType>sample string 3</ItemIDType>
      <ItemTitle1>sample string 4</ItemTitle1>
      <ItemTitle2>sample string 5</ItemTitle2>
      <ItemDescription>sample string 6</ItemDescription>
      <Qty>1</Qty>
      <Series>sample string 7</Series>
      <ItemBarCode>sample string 8</ItemBarCode>
      <AlternateBarCode>sample string 9</AlternateBarCode>
      <AlternateQuantity>1</AlternateQuantity>
      <AlternateConvertFactor>1</AlternateConvertFactor>
      <AlternateUnitOfMeasurement>sample string 10</AlternateUnitOfMeasurement>
      <ShippedQTY>1</ShippedQTY>
      <ExpirationDate>2025-10-27T22:35:47.562807+01:00</ExpirationDate>
      <WareHouseId>sample string 11</WareHouseId>
      <Price>1</Price>
      <PriceWithVAT>1</PriceWithVAT>
      <DiscountPercentage>1</DiscountPercentage>
      <DiscountPercentage2>1</DiscountPercentage2>
      <DiscountPercentage3>1</DiscountPercentage3>
      <DiscountPercentage4>1</DiscountPercentage4>
      <DiscountPercentage5>1</DiscountPercentage5>
      <DiscountAmountAmount>1</DiscountAmountAmount>
      <VATRateId>sample string 12</VATRateId>
      <VATRatePercent>1</VATRatePercent>
      <PriceIncludeVAT>true</PriceIncludeVAT>
      <Comment>sample string 13</Comment>
      <CostCenterId>sample string 14</CostCenterId>
      <CostUnitId>sample string 15</CostUnitId>
      <ClerkId>sample string 16</ClerkId>
      <WorkOrderid>sample string 17</WorkOrderid>
      <AnalyticId>sample string 18</AnalyticId>
      <TextLine>true</TextLine>
      <VATCalculated>sample string 19</VATCalculated>
      <VATInvoiceType>sample string 20</VATInvoiceType>
      <ReservedQTY>1</ReservedQTY>
      <ReservedToDate>2025-10-27T22:35:47.562807+01:00</ReservedToDate>
      <UnitOfMeasure>sample string 21</UnitOfMeasure>
      <DeliveryDate>2025-10-27T22:35:47.562807+01:00</DeliveryDate>
      <Status>sample string 22</Status>
      <ClosedLine>true</ClosedLine>
      <GrossAmout>1</GrossAmout>
      <IntermediateAmount>1</IntermediateAmount>
      <NetAmount>1</NetAmount>
      <VATAmount>1</VATAmount>
      <DiscountAmount>1</DiscountAmount>
      <RebatAmount>1</RebatAmount>
      <OrderedQtyCustomer>1</OrderedQtyCustomer>
      <WHTypeID>sample string 23</WHTypeID>
      <ConsigmentWarehouseID>sample string 24</ConsigmentWarehouseID>
      <CustomerDeliveryDate>2025-10-27T22:35:47.562807+01:00</CustomerDeliveryDate>
      <QuotationNumber>sample string 25</QuotationNumber>
      <QuotationYear>26</QuotationYear>
      <NumberOfPackages>27</NumberOfPackages>
      <InsertedBy>sample string 28</InsertedBy>
      <InsertedTime>2025-10-27T22:35:47.562807+01:00</InsertedTime>
      <ModifiedBy>sample string 29</ModifiedBy>
      <ModifiedTime>2025-10-27T22:35:47.562807+01:00</ModifiedTime>
      <ExciseDuty>true</ExciseDuty>
      <ExciseDutyID>sample string 30</ExciseDutyID>
      <ExciseDutyConvertFactor>1</ExciseDutyConvertFactor>
      <ExciseDutyPercentage>1</ExciseDutyPercentage>
      <ExciseDutyAmount>1</ExciseDutyAmount>
      <ExciseDutyValue>1</ExciseDutyValue>
      <ExciseDutyMinimalValue>1</ExciseDutyMinimalValue>
      <InsUpdDate>2025-10-27T22:35:47.562807+01:00</InsUpdDate>
      <Analytics_AN1_ID>sample string 31</Analytics_AN1_ID>
      <Analytics_AN2_ID>sample string 32</Analytics_AN2_ID>
      <Analytics_AN3_ID>sample string 33</Analytics_AN3_ID>
      <WorkOrderYear>34</WorkOrderYear>
      <WorkOrderBook>sample string 35</WorkOrderBook>
      <WorkOrderNumber>36</WorkOrderNumber>
      <VATTaxCategory>sample string 37</VATTaxCategory>
      <OrderLineReservation>true</OrderLineReservation>
    </OrderLine>
  </OrderLines>
  <OrderPaymentLines>
    <OrderPaymentLine>
      <PaymentLineNo>1</PaymentLineNo>
      <PaymentPurposeID>sample string 2</PaymentPurposeID>
      <PaymentAmount>1</PaymentAmount>
      <PaymentDate>2025-10-27T22:35:47.562807+01:00</PaymentDate>
      <PaymentTransactionID>sample string 3</PaymentTransactionID>
    </OrderPaymentLine>
    <OrderPaymentLine>
      <PaymentLineNo>1</PaymentLineNo>
      <PaymentPurposeID>sample string 2</PaymentPurposeID>
      <PaymentAmount>1</PaymentAmount>
      <PaymentDate>2025-10-27T22:35:47.562807+01:00</PaymentDate>
      <PaymentTransactionID>sample string 3</PaymentTransactionID>
    </OrderPaymentLine>
  </OrderPaymentLines>
</OrderHeader>