POST api/SIMS/ImportSalesOrder?companyKey={companyKey}
Posts a sales order, with no items being deducted from SIMS until the sales order is processed into a sale.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyKey |
The company name if the service is connected to multiple SIMS companies (Optional) |
string |
Default value is |
Body Parameters
The Sales Order object.
SalesOrder| Name | Description | Type | Additional information |
|---|---|---|---|
| Header |
The sales order header. |
SalesOrderHeader |
N/A |
| Lines |
The sales order line(s) attached to the sales order header. |
Collection of SalesOrderLine |
N/A |
Request Formats
application/json, text/json
Sample:
{
"Header": {
"SalesOrderReference": "41",
"SalesOrderDate": "2024-10-06T00:00:00",
"DeliveryDate": "2024-10-07T00:00:00",
"ClientCode": "F80",
"CurrencyCode": "EUR",
"ExchangeRate": 1.0,
"TotalValue": 135.36,
"TotalVat": 24.48,
"DiscountRate": 0.0,
"DiscountAmount": 0.0,
"PettyDiscount": 0.0,
"Address1": "Address Line 1",
"Address2": "Address Line 2",
"Address3": "Address Line 3",
"Address4": "Address Line 4",
"Address5": "Address Line 5",
"InternalReference": "",
"ClientReference": "",
"PaymentTerms": "",
"Remarks": "send item n10.107.029 as follows:\n\n2 x blue\n1 x red",
"SalesmanCode": "SSL",
"Deposit": 0.0,
"Contact": "",
"DeliveryInstructions": "Delivery instructions",
"CreatedBy": "WEB",
"Created": "2024-10-06T00:00:00.4268877",
"AmendedBy": "WEB",
"Amended": "2024-10-06T00:00:00.4268877",
"DeliveryType": "TS",
"MediaType": "TEST"
},
"Lines": [
{
"SalesOrderReference": null,
"StockCode": null,
"StockDescription": null,
"Quantity": 0.0,
"FreeQuantity": 0.0,
"UnitCode": null,
"ItemOrder": 0,
"PackSize": 0.0,
"PacksOrd": 0.0,
"UnitPrice": 0.0,
"DeliveryDate": "0001-01-01T00:00:00",
"VatCode": null,
"VatRate": 0.0,
"VatAmount": 0.0,
"Discount": 0.0,
"DiscountAmount": 0.0,
"PettyDiscount": 0.0,
"NonInventoryCost": 0.0,
"LocationCode": null,
"Remarks": null
}
]
}
Response Information
Resource Description
The operation's result
ImportSalesOrderResult| Name | Description | Type | Additional information |
|---|---|---|---|
| Status |
The status of the sales order after the attempt to post it to SIMS |
ImportStatus |
N/A |
| ErrorMessage |
The message returned in case of an error. |
string |
N/A |
Response Formats
application/json, text/json
Sample:
{
"Status": 0,
"ErrorMessage": ""
}