PUT api/{database}/Order/{orderId}

Updates the specified Order

Request Information

Parameters

Name	Description	Additional information
orderId	The orderId.	Define this parameter in the request URI.
value	The updated values for Order.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "accountManager": "sample string 1",
  "accountManagerId": "sample string 2",
  "messages": [],
  "applyOrderSurcharge": true,
  "approved": true,
  "approvedBy": "sample string 5",
  "autoUnmatchToPurchase": true,
  "blocked": true,
  "canChange": true,
  "cannotChangeReason": "sample string 9",
  "chargeVatType": 0,
  "collectiveInvoiceSystemId": "sample string 10",
  "contactPerson": "sample string 11",
  "contactPersonId": "sample string 12",
  "costCentreId": "sample string 13",
  "costUnitId": "sample string 14",
  "creditSqueezePerc": 15.0,
  "currencyId": "sample string 16",
  "customerCountryId": "sample string 17",
  "customerId": "sample string 18",
  "deliveryAddress": "sample string 19",
  "deliveryConditionId": "sample string 20",
  "discountPercentage": 21.0,
  "invoiceAddress": "sample string 22",
  "kvcPaymentCondition": true,
  "mainOrderId": "sample string 24",
  "mandateId": "sample string 25",
  "matchedToPurchase": true,
  "orderDate": "sample string 27",
  "orderId": "sample string 28",
  "orderLines": null,
  "orderState": 0,
  "orderSurcharge": 29.0,
  "orderSurchargeVatCodeId": 30,
  "orderType": 0,
  "paymentConditionId": "sample string 31",
  "paymentDiscountPercentage": 32.0,
  "processedBy": "sample string 33",
  "processedById": "sample string 34",
  "projectId": "sample string 35",
  "reference": "sample string 36",
  "totalCreditSqueezeAmount": 37.0,
  "totalDiscountAmount": 38.0,
  "totalGoodsAmount": 39.0,
  "totalOrderAmount": 40.0,
  "totalVatAmount": 41.0,
  "vatScenarioId": 42
}

application/xml, text/xml

Sample:

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Sales.Edit">
  <AccountManager>sample string 1</AccountManager>
  <AccountManagerId>sample string 2</AccountManagerId>
  <ApplyOrderSurcharge>true</ApplyOrderSurcharge>
  <Approved>true</Approved>
  <ApprovedBy>sample string 5</ApprovedBy>
  <AutoUnmatchToPurchase>true</AutoUnmatchToPurchase>
  <Blocked>true</Blocked>
  <CanChange>true</CanChange>
  <CannotChangeReason>sample string 9</CannotChangeReason>
  <ChargeVatType>Exclusive</ChargeVatType>
  <CollectiveInvoiceSystemId>sample string 10</CollectiveInvoiceSystemId>
  <ContactPerson>sample string 11</ContactPerson>
  <ContactPersonId>sample string 12</ContactPersonId>
  <CostCentreId>sample string 13</CostCentreId>
  <CostUnitId>sample string 14</CostUnitId>
  <CreditSqueezePerc>15</CreditSqueezePerc>
  <CurrencyId>sample string 16</CurrencyId>
  <CustomerCountryId>sample string 17</CustomerCountryId>
  <CustomerId>sample string 18</CustomerId>
  <DeliveryAddress>sample string 19</DeliveryAddress>
  <DeliveryConditionId>sample string 20</DeliveryConditionId>
  <DiscountPercentage>21</DiscountPercentage>
  <InvoiceAddress>sample string 22</InvoiceAddress>
  <KVCPaymentCondition>true</KVCPaymentCondition>
  <MainOrderId>sample string 24</MainOrderId>
  <MandateId>sample string 25</MandateId>
  <MatchedToPurchase>true</MatchedToPurchase>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
  <OrderDate>sample string 27</OrderDate>
  <OrderId>sample string 28</OrderId>
  <OrderLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Sales.Lists" i:nil="true" />
  <OrderState>Unknown</OrderState>
  <OrderSurcharge>29</OrderSurcharge>
  <OrderSurchargeVatCodeId>30</OrderSurchargeVatCodeId>
  <OrderType>InvoiceOrder</OrderType>
  <PaymentConditionId>sample string 31</PaymentConditionId>
  <PaymentDiscountPercentage>32</PaymentDiscountPercentage>
  <ProcessedBy>sample string 33</ProcessedBy>
  <ProcessedById>sample string 34</ProcessedById>
  <ProjectId>sample string 35</ProjectId>
  <Reference>sample string 36</Reference>
  <TotalCreditSqueezeAmount>37</TotalCreditSqueezeAmount>
  <TotalDiscountAmount>38</TotalDiscountAmount>
  <TotalGoodsAmount>39</TotalGoodsAmount>
  <TotalOrderAmount>40</TotalOrderAmount>
  <TotalVatAmount>41</TotalVatAmount>
  <VatScenarioId>42</VatScenarioId>
</Order>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "accountManager": "sample string 1",
  "accountManagerId": "sample string 2",
  "messages": [],
  "applyOrderSurcharge": true,
  "approved": true,
  "approvedBy": "sample string 5",
  "autoUnmatchToPurchase": true,
  "blocked": true,
  "canChange": true,
  "cannotChangeReason": "sample string 9",
  "chargeVatType": 0,
  "collectiveInvoiceSystemId": "sample string 10",
  "contactPerson": "sample string 11",
  "contactPersonId": "sample string 12",
  "costCentreId": "sample string 13",
  "costUnitId": "sample string 14",
  "creditSqueezePerc": 15.0,
  "currencyId": "sample string 16",
  "customerCountryId": "sample string 17",
  "customerId": "sample string 18",
  "deliveryAddress": "sample string 19",
  "deliveryConditionId": "sample string 20",
  "discountPercentage": 21.0,
  "invoiceAddress": "sample string 22",
  "kvcPaymentCondition": true,
  "mainOrderId": "sample string 24",
  "mandateId": "sample string 25",
  "matchedToPurchase": true,
  "orderDate": "sample string 27",
  "orderId": "sample string 28",
  "orderLines": null,
  "orderState": 0,
  "orderSurcharge": 29.0,
  "orderSurchargeVatCodeId": 30,
  "orderType": 0,
  "paymentConditionId": "sample string 31",
  "paymentDiscountPercentage": 32.0,
  "processedBy": "sample string 33",
  "processedById": "sample string 34",
  "projectId": "sample string 35",
  "reference": "sample string 36",
  "totalCreditSqueezeAmount": 37.0,
  "totalDiscountAmount": 38.0,
  "totalGoodsAmount": 39.0,
  "totalOrderAmount": 40.0,
  "totalVatAmount": 41.0,
  "vatScenarioId": 42
}

application/xml, text/xml

Sample:

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Sales.Edit">
  <AccountManager>sample string 1</AccountManager>
  <AccountManagerId>sample string 2</AccountManagerId>
  <ApplyOrderSurcharge>true</ApplyOrderSurcharge>
  <Approved>true</Approved>
  <ApprovedBy>sample string 5</ApprovedBy>
  <AutoUnmatchToPurchase>true</AutoUnmatchToPurchase>
  <Blocked>true</Blocked>
  <CanChange>true</CanChange>
  <CannotChangeReason>sample string 9</CannotChangeReason>
  <ChargeVatType>Exclusive</ChargeVatType>
  <CollectiveInvoiceSystemId>sample string 10</CollectiveInvoiceSystemId>
  <ContactPerson>sample string 11</ContactPerson>
  <ContactPersonId>sample string 12</ContactPersonId>
  <CostCentreId>sample string 13</CostCentreId>
  <CostUnitId>sample string 14</CostUnitId>
  <CreditSqueezePerc>15</CreditSqueezePerc>
  <CurrencyId>sample string 16</CurrencyId>
  <CustomerCountryId>sample string 17</CustomerCountryId>
  <CustomerId>sample string 18</CustomerId>
  <DeliveryAddress>sample string 19</DeliveryAddress>
  <DeliveryConditionId>sample string 20</DeliveryConditionId>
  <DiscountPercentage>21</DiscountPercentage>
  <InvoiceAddress>sample string 22</InvoiceAddress>
  <KVCPaymentCondition>true</KVCPaymentCondition>
  <MainOrderId>sample string 24</MainOrderId>
  <MandateId>sample string 25</MandateId>
  <MatchedToPurchase>true</MatchedToPurchase>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
  <OrderDate>sample string 27</OrderDate>
  <OrderId>sample string 28</OrderId>
  <OrderLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.Sales.Lists" i:nil="true" />
  <OrderState>Unknown</OrderState>
  <OrderSurcharge>29</OrderSurcharge>
  <OrderSurchargeVatCodeId>30</OrderSurchargeVatCodeId>
  <OrderType>InvoiceOrder</OrderType>
  <PaymentConditionId>sample string 31</PaymentConditionId>
  <PaymentDiscountPercentage>32</PaymentDiscountPercentage>
  <ProcessedBy>sample string 33</ProcessedBy>
  <ProcessedById>sample string 34</ProcessedById>
  <ProjectId>sample string 35</ProjectId>
  <Reference>sample string 36</Reference>
  <TotalCreditSqueezeAmount>37</TotalCreditSqueezeAmount>
  <TotalDiscountAmount>38</TotalDiscountAmount>
  <TotalGoodsAmount>39</TotalGoodsAmount>
  <TotalOrderAmount>40</TotalOrderAmount>
  <TotalVatAmount>41</TotalVatAmount>
  <VatScenarioId>42</VatScenarioId>
</Order>

Database:

URI parameters

Headers | Add header

: Delete

Body

Samples:

Important note when applying XML requests: the XML elements MUST be applied in alphabetical order, otherwise some values can be denied.

PUT api/{database}/Order/{orderId}

Request Information

Parameters

Request body formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Response body formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body