POST api/Order/AddOrder
Request Information
URI Parameters
None.
Body Parameters
OrderHeader| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderYear | integer |
None. |
|
| OrderBook | string |
None. |
|
| InvoiceBook | string |
None. |
|
| WarehouseId | string |
None. |
|
| CustomerId | string |
None. |
|
| CustomerPayerId | 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. |
|
| 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. |
|
| AnnexID | string |
None. |
|
| FolderID | string |
None. |
|
| DocumentHeaderDescription | string |
None. |
|
| DocumentFooterDescription | string |
None. |
|
| DeliveryDate | date |
None. |
|
| CustomerDeliveryDate | date |
None. |
|
| Consigment | boolean |
None. |
|
| ConsigmentWarehouseID | string |
None. |
|
| ExchangeRateDate | date |
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. |
|
| 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. |
|
| PaymentMethod | string |
None. |
|
| RequiredPrepaymentPercent | decimal number |
None. |
|
| OrderLines | OrderLines |
None. |
|
| OrderPaymentLines | OrderPaymentLines |
None. |
Request 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>
<InvoiceBook>sample string 3</InvoiceBook>
<WarehouseId>sample string 4</WarehouseId>
<CustomerId>sample string 5</CustomerId>
<CustomerPayerId>sample string 6</CustomerPayerId>
<OrderDate>2024-04-27T01:12:19.4041216+02:00</OrderDate>
<ConfirmationDate>2024-04-27T01:12:19.4051212+02:00</ConfirmationDate>
<CustomerConfirmationDate>2024-04-27T01:12:19.4051212+02:00</CustomerConfirmationDate>
<OrderReference>sample string 7</OrderReference>
<QuotationNumber>sample string 8</QuotationNumber>
<DeliveryAddress>sample string 9</DeliveryAddress>
<DeliveryMethod>sample string 10</DeliveryMethod>
<CurrencyId>sample string 11</CurrencyId>
<PriceListId>sample string 12</PriceListId>
<CostCenterId>sample string 13</CostCenterId>
<CostUnitId>sample string 14</CostUnitId>
<ClerkId>sample string 15</ClerkId>
<WorkOrderId>sample string 16</WorkOrderId>
<AnalyticId>sample string 17</AnalyticId>
<AccountingBookGroupId>sample string 18</AccountingBookGroupId>
<CustomerClerkID>sample string 19</CustomerClerkID>
<RebatePercentage>1</RebatePercentage>
<RebatePercentage2>1</RebatePercentage2>
<RebatePercentage3>1</RebatePercentage3>
<RebatePercentage4>1</RebatePercentage4>
<RebatePercentage5>1</RebatePercentage5>
<RebateAmountDocument>1</RebateAmountDocument>
<DocumentSalesType>sample string 20</DocumentSalesType>
<DiscountGroupId>sample string 21</DiscountGroupId>
<Comment>sample string 22</Comment>
<ParityCode>sample string 23</ParityCode>
<ParityPlace>sample string 24</ParityPlace>
<AnnexID>sample string 25</AnnexID>
<FolderID>sample string 26</FolderID>
<DocumentHeaderDescription>sample string 27</DocumentHeaderDescription>
<DocumentFooterDescription>sample string 28</DocumentFooterDescription>
<DeliveryDate>2024-04-27T01:12:19.4051212+02:00</DeliveryDate>
<CustomerDeliveryDate>2024-04-27T01:12:19.4051212+02:00</CustomerDeliveryDate>
<Consigment>true</Consigment>
<ConsigmentWarehouseID>sample string 29</ConsigmentWarehouseID>
<ExchangeRateDate>2024-04-27T01:12:19.4051212+02:00</ExchangeRateDate>
<LanguageID>sample string 30</LanguageID>
<VATCalculated>sample string 31</VATCalculated>
<VATInvoiceType>sample string 32</VATInvoiceType>
<ExciseDuty>true</ExciseDuty>
<DiscountAmountType>true</DiscountAmountType>
<DiscountCalculationMethod>true</DiscountCalculationMethod>
<PaymentPeriod>33</PaymentPeriod>
<OrderType>sample string 34</OrderType>
<QuotationYear>35</QuotationYear>
<LocationID>sample string 36</LocationID>
<CarrierID>sample string 37</CarrierID>
<VehicleRegistrationNumber>sample string 38</VehicleRegistrationNumber>
<TrailerRegistrationNumber>sample string 39</TrailerRegistrationNumber>
<Driver>sample string 40</Driver>
<UnloadingTime>2024-04-27T01:12:19.40614+02:00</UnloadingTime>
<UnloadingNote>sample string 41</UnloadingNote>
<PaymentPurposeCode>sample string 42</PaymentPurposeCode>
<CashPayment>true</CashPayment>
<CashierID>sample string 43</CashierID>
<PaymentTypeID>sample string 44</PaymentTypeID>
<CustomerClerkSEQ>sample string 45</CustomerClerkSEQ>
<Analytics_AN1_ID>sample string 46</Analytics_AN1_ID>
<Analytics_AN2_ID>sample string 47</Analytics_AN2_ID>
<Analytics_AN3_ID>sample string 48</Analytics_AN3_ID>
<DeliveryPlace>sample string 49</DeliveryPlace>
<DocumentDeliveryTitle1>sample string 50</DocumentDeliveryTitle1>
<DocumentDeliveryTitle2>sample string 51</DocumentDeliveryTitle2>
<DocumentDeliveryTitle3>sample string 52</DocumentDeliveryTitle3>
<DocumentDeliveryAddress>sample string 53</DocumentDeliveryAddress>
<DocumentDeliveryHouseNo>sample string 54</DocumentDeliveryHouseNo>
<DocumentDeliveryPostalCode>sample string 55</DocumentDeliveryPostalCode>
<DocumentDeliveryCity>sample string 56</DocumentDeliveryCity>
<DocumentDeliveryCountry>sample string 57</DocumentDeliveryCountry>
<PaymentMethod>sample string 58</PaymentMethod>
<RequiredPrepaymentPercent>1</RequiredPrepaymentPercent>
<OrderLines>
<OrderLine>
<OrderLineNo>1</OrderLineNo>
<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>
<ExpirationDate>2024-04-27T01:12:19.40614+02:00</ExpirationDate>
<WareHouseId>sample string 8</WareHouseId>
<Price>1</Price>
<DiscountPercentage>1</DiscountPercentage>
<DiscountPercentage2>1</DiscountPercentage2>
<DiscountPercentage3>1</DiscountPercentage3>
<DiscountPercentage4>1</DiscountPercentage4>
<DiscountPercentage5>1</DiscountPercentage5>
<DiscountAmountAmount>1</DiscountAmountAmount>
<VATRateId>sample string 9</VATRateId>
<PriceIncludeVAT>true</PriceIncludeVAT>
<Comment>sample string 10</Comment>
<CostCenterId>sample string 11</CostCenterId>
<CostUnitId>sample string 12</CostUnitId>
<ClerkId>sample string 13</ClerkId>
<WorkOrderid>sample string 14</WorkOrderid>
<AnalyticId>sample string 15</AnalyticId>
<TextLine>true</TextLine>
<VATCalculated>sample string 16</VATCalculated>
<VATInvoiceType>sample string 17</VATInvoiceType>
<ReservedQTY>1</ReservedQTY>
<ReservedToDate>2024-04-27T01:12:19.4071214+02:00</ReservedToDate>
<UnitOfMeasure>sample string 18</UnitOfMeasure>
<DeliveryDate>2024-04-27T01:12:19.4071214+02:00</DeliveryDate>
<Status>sample string 19</Status>
<ClosedLine>true</ClosedLine>
<OrderedQtyCustomer>1</OrderedQtyCustomer>
<WHTypeID>sample string 20</WHTypeID>
<ConsigmentWarehouseID>sample string 21</ConsigmentWarehouseID>
<CustomerDeliveryDate>2024-04-27T01:12:19.4071214+02:00</CustomerDeliveryDate>
<QuotationNumber>sample string 22</QuotationNumber>
<QuotationYear>23</QuotationYear>
<NumberOfPackages>24</NumberOfPackages>
<ExciseDuty>true</ExciseDuty>
<Analytics_AN1_ID>sample string 25</Analytics_AN1_ID>
<Analytics_AN2_ID>sample string 26</Analytics_AN2_ID>
<Analytics_AN3_ID>sample string 27</Analytics_AN3_ID>
</OrderLine>
<OrderLine>
<OrderLineNo>1</OrderLineNo>
<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>
<ExpirationDate>2024-04-27T01:12:19.40614+02:00</ExpirationDate>
<WareHouseId>sample string 8</WareHouseId>
<Price>1</Price>
<DiscountPercentage>1</DiscountPercentage>
<DiscountPercentage2>1</DiscountPercentage2>
<DiscountPercentage3>1</DiscountPercentage3>
<DiscountPercentage4>1</DiscountPercentage4>
<DiscountPercentage5>1</DiscountPercentage5>
<DiscountAmountAmount>1</DiscountAmountAmount>
<VATRateId>sample string 9</VATRateId>
<PriceIncludeVAT>true</PriceIncludeVAT>
<Comment>sample string 10</Comment>
<CostCenterId>sample string 11</CostCenterId>
<CostUnitId>sample string 12</CostUnitId>
<ClerkId>sample string 13</ClerkId>
<WorkOrderid>sample string 14</WorkOrderid>
<AnalyticId>sample string 15</AnalyticId>
<TextLine>true</TextLine>
<VATCalculated>sample string 16</VATCalculated>
<VATInvoiceType>sample string 17</VATInvoiceType>
<ReservedQTY>1</ReservedQTY>
<ReservedToDate>2024-04-27T01:12:19.4071214+02:00</ReservedToDate>
<UnitOfMeasure>sample string 18</UnitOfMeasure>
<DeliveryDate>2024-04-27T01:12:19.4071214+02:00</DeliveryDate>
<Status>sample string 19</Status>
<ClosedLine>true</ClosedLine>
<OrderedQtyCustomer>1</OrderedQtyCustomer>
<WHTypeID>sample string 20</WHTypeID>
<ConsigmentWarehouseID>sample string 21</ConsigmentWarehouseID>
<CustomerDeliveryDate>2024-04-27T01:12:19.4071214+02:00</CustomerDeliveryDate>
<QuotationNumber>sample string 22</QuotationNumber>
<QuotationYear>23</QuotationYear>
<NumberOfPackages>24</NumberOfPackages>
<ExciseDuty>true</ExciseDuty>
<Analytics_AN1_ID>sample string 25</Analytics_AN1_ID>
<Analytics_AN2_ID>sample string 26</Analytics_AN2_ID>
<Analytics_AN3_ID>sample string 27</Analytics_AN3_ID>
</OrderLine>
</OrderLines>
<OrderPaymentLines>
<OrderPaymentLine>
<PaymentLineNo>1</PaymentLineNo>
<PaymentPurposeID>sample string 2</PaymentPurposeID>
<PaymentAmount>1</PaymentAmount>
<PaymentDate>2024-04-27T01:12:19.4081219+02:00</PaymentDate>
<PaymentTransactionID>sample string 3</PaymentTransactionID>
</OrderPaymentLine>
<OrderPaymentLine>
<PaymentLineNo>1</PaymentLineNo>
<PaymentPurposeID>sample string 2</PaymentPurposeID>
<PaymentAmount>1</PaymentAmount>
<PaymentDate>2024-04-27T01:12:19.4081219+02:00</PaymentDate>
<PaymentTransactionID>sample string 3</PaymentTransactionID>
</OrderPaymentLine>
</OrderPaymentLines>
</OrderHeader>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CreateResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Keys | Collection of EntityKeyField |
None. |
|
| ResultCode | ExternalResultCode |
None. |
|
| Errors | Collection of Error |
None. |
Response Formats
application/xml, text/xml
Sample:
<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Keys>
<Key>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Key>
<Key>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</Key>
</Keys>
<ResultCode>None</ResultCode>
<Errors>
<Error>
<Level>Warning</Level>
<Message>sample string 1</Message>
</Error>
<Error>
<Level>Warning</Level>
<Message>sample string 1</Message>
</Error>
</Errors>
</CreateResult>