Overview

Customer order API is used to create,read, update and delete customer orders.

Creating a new order

This API used to create new order. API will create an order with Registed order status. If you need to create an order with Draft stauts set the StatusCode property value to 10001

Endpoint : api/biz/orders

Method Type : POST

Content-Type : application/json

Request payload 

{
  "_createguid": "string",
  "AccrualID": 0,
  "Comment": "string",
  "CreatedAt": "2020-04-09",
  "CreatedBy": "string",
  "CreditDays": 0,
  "CurrencyCodeID": 0,
  "CurrencyExchangeRate": 0,
  "CustomerID": 0,
  "CustomerName": "string",
  "CustomerOrgNumber": "string",
  "CustomerPerson": "string",
  "DefaultDimensionsID": 0,
  "DefaultSellerID": 0,
  "Deleted": true,
  "DeliveryDate": "2020-04-09",
  "DeliveryMethod": "string",
  "DeliveryName": "string",
  "DeliveryTerm": "string",
  "DeliveryTermsID": 0,
  "DistributionPlanID": 0,
  "EmailAddress": "string",
  "FreeTxt": "string",
  "ID": 0,
  "InternalNote": "string",
  "InvoiceAddressLine1": "string",
  "InvoiceAddressLine2": "string",
  "InvoiceAddressLine3": "string",
  "InvoiceCity": "string",
  "InvoiceCountry": "string",
  "InvoiceCountryCode": "string",
  "InvoicePostalCode": "string",
  "InvoiceReceiverName": "string",
  "OrderDate": "2020-04-09",
  "OrderNumber": 0,
  "OrderNumberSeriesID": 0,
  "OurReference": "string",
  "PayableRoundingAmount": 0,
  "PayableRoundingCurrencyAmount": 0,
  "PaymentInfoTypeID": 0,
  "PaymentTerm": "string",
  "PaymentTermsID": 0,
  "PrintStatus": 0,
  "ReadyToInvoice": true,
  "Requisition": "string",
  "RestAmountCurrency": 0,
  "RestExclusiveAmountCurrency": 0,
  "SalesPerson": "string",
  "ShippingAddressLine1": "string",
  "ShippingAddressLine2": "string",
  "ShippingAddressLine3": "string",
  "ShippingCity": "string",
  "ShippingCountry": "string",
  "ShippingCountryCode": "string",
  "ShippingPostalCode": "string",
  "StatusCode": 0,
  "SupplierOrgNumber": "string",
  "TaxExclusiveAmount": 0,
  "TaxExclusiveAmountCurrency": 0,
  "TaxInclusiveAmount": 0,
  "TaxInclusiveAmountCurrency": 0,
  "UpdateCurrencyAmountsOnDateChange": true,
  "UpdateCurrencyOnToInvoice": true,
  "UpdatedAt": "2020-04-09",
  "UpdatedBy": "string",
  "UseReportID": 0,
  "VatTotalsAmount": 0,
  "VatTotalsAmountCurrency": 0,
  "YourReference": "string",
  "Accrual": "Accrual",
  "PaymentTerms": "Terms",
  "DeliveryTerms": "Terms",
  "DefaultDimensions": "Dimensions",
  "Customer": "Customer",
  "Items": [
    {
      "_createguid": "string",
      "AccountID": 0,
      "CalculateGrossPriceBasedOnNetPrice": true,
      "Comment": "string",
      "CreatedAt": "2020-04-09",
      "CreatedBy": "string",
      "CurrencyCodeID": 0,
      "CurrencyExchangeRate": 0,
      "CustomerOrderID": 0,
      "Deleted": true,
      "DimensionsID": 0,
      "Discount": 0,
      "DiscountCurrency": 0,
      "DiscountPercent": 0,
      "ID": 0,
      "ItemSourceID": 0,
      "ItemText": "string",
      "NumberOfItems": 0,
      "PriceExVat": 0,
      "PriceExVatCurrency": 0,
      "PriceIncVat": 0,
      "PriceSetByUser": true,
      "ProductID": 0,
      "ReadyToInvoice": true,
      "SortIndex": 0,
      "StatusCode": 0,
      "SumTotalExVat": 0,
      "SumTotalExVatCurrency": 0,
      "SumTotalIncVat": 0,
      "SumTotalIncVatCurrency": 0,
      "SumVat": 0,
      "SumVatCurrency": 0,
      "Unit": "string",
      "UpdatedAt": "2020-04-09",
      "UpdatedBy": "string",
      "VatDate": "2020-04-09",
      "VatPercent": 0,
      "VatTypeID": 0,
      "Dimensions": "Dimensions",
      "ItemSource": "ItemSource",
      "CustomValues": "CustomValues"
    }
  ],
  "DefaultSeller": "Seller",
  "OrderDistributionPlan": "DistributionPlan",
  "CustomValues": "CustomValues"
}