Create Sales Order

Creates a Sales Order

Name	Data Type	Description
ThirdPartyRefNo	string, required	A reference number for the order. If an order in Xorosoft ERP exists with the same ThirdPartyRefNo, it will be detected as a duplicate and will not be created.
ThirdPartySource	string	If the order came from a third party platform, it can be indicated here.
ThirdPartyIconUrl	string	Use a URL that ends with .png or .jpg for an image of the third party source.For example, a Joor order would have a Joor icon.
ThirdPartyDisplayName	string	It represents the name of third party source.
CheckThirdPartySource	bool	Property, when set to true, checks if a third-party reference number exists with the same third-party source
SaleStoreName	string, required	It is Sale Store's (inventory set) name here exactly as it is in Xorosoft ERP.
StoreName	string	It is Ship Store's (inventory set) name here exactly as it is in Xorosoft ERP. If this is left blank, then **SaleStoreName will be used.
CurrencyCode	string, required	It represents the currency for the order. This must match with the customer's currency. Choose from: USD,CAD,EUR,AUD.
CustomerName	string, required	It represents the name of customer.
CustomerFirstName	string	First Name of the customer.
CustomerLastName	string	Last Name of the customer.
CustomerMainPhone	string	Customer main Phone Number
CustomerEmailMain	string	The customer's email address.
CustomerPO	string	Customer PO field.
OrderDate	DateTime, required	The date the order was placed.
DateToBeShipped	DateTime, required	The date the order is to be shipped before or on.
LastDateToBeShipped	DateTime	The date the order should be shipped.
DateToBeCancelled	DateTime	If the order hasn't been fulfilled by this date, then it can be cancelled, MM-DD-YYYY
OrderClassCode	string	It represents the Code categorize your orders.
OrderClassName	string	It represents the name of the Class to categorize your orders.
OrderTypeCode	string	It represents the code for type of order.
OrderTypeName	string	It represents the name for type of order.
ExchangeRate	double, required	It represents the exchange rate betweeen currencies. If currency is the same as home currency, then put 1 here. Otherwise put the exchange rate for the order.
Memo	string	A memo for the order can be entered here.
PaymentTermsName	string	It is a payment term from the system for this order. This must match up exactly to a Payment Term in Xorosoft ERP.
PaymentTermsType	string	It represents the code for type of payment terms.
RefNo	string	It is a reference number for the order here. This can be an internal reference number, as opposed to a third-party reference number.
Tags	string	It represents tags here for the order and multiple tags can be separated by a comma.
SalesRepId	string	Please refer to the User Centre in your Xorosoft ERP system and enter the UserID of the sales rep for this Sales Order.
ShipMethodName	string	It is a ship method for the order here. Choose from: Pick Up, Delivery(Own Truck) and Delivery(Third Party)
CarrierName	string	If ShipMethodName is not Pick Up, then enter a carrier.
CarrierCode	string	The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).
ShipServiceName	string	It represents the name of ship service for the order.
ShipServiceCode	string	The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).
FobName	string	It represents the FobName for the order.
IsOrderTaxExempt	bool	It represents the boolean represented in the form of N for Exempt tax and Y for Active Tax.
ShippingTaxItemCode1	string	It represents the ShippingTaxItemCode1 for the Order.
ShippingTaxItemValue1	double	It represents the ShippingTaxItemValue1 for the Order.
ShippingTaxItemCode2	string	It represents the ShippingTaxItemCode2 for the Order.
ShippingTaxItemValue2	double	It represents the ShippingTaxItemValue2 for the Order.
ShippingTaxItemCode3	string	It represents the ShippingTaxItemCode3 for the Order.
ShippingTaxItemValue3	double	It represents the ShippingTaxItemValue3 for the Order.
ShippingTaxItemCode4	string	It represents the ShippingTaxItemCode4 for the Order.
ShippingTaxItemValue4	double	It represents the ShippingTaxItemValue5 for the Order.
ShippingTermsName	string	It represents the shipping terms.Choose from: Prepaid, Collect, Prepaid& Billed, Collect& Allowed and Third Party Billing.
ShippingAccountNumber	string	It represents the shipping account number here.
ShippingCost	double	It represents the shipping cost for the Order.
ShippingNotes	string	It represents the shipping notes for the Order.
ShipToFirstName	string	It represents the first name of ship to for the Order.
ShipToLastName	string	It represents the last name of ship to for the Order.
ShipToName	string	It represents the Main address name of ship to for the Order.
ShipToCompanyName	string	It represents the company name of ship to for the Order.
ShipToAddr	string	It represents the address line 1 of ship to for the Order.
ShipToAddr2	string	It represents the address line 2 of ship to for the Order.
ShipToCity	string	It represents the city of ship to for the Order.
ShipToCountry	string	It represents the country name of ship to for the Order.
ShipToCountryISO2	string	It is a code to Identify a Country of ship to for the Order
ShipToState	string	It represents the state name of ship to for the Order.
ShipToStateAbbr	string	It is the abbrevation of state of ship to for the Order.
ShipToZpCode	string	It represents the zip code of ship to for the Order.
ShipToPhoneNumber	string	It represents the phone number of ship to for the Order.
ShipToEmail	string	It represents the email of ship to for the Order.
BuyerName	string	It is a name of Buyer.
BillToFirstName	string	It represents the first name of bill to for the Order.
BillToLastName	string	It represents the last name of bill to for the Order.
BillToName	string	It represents the Main address name of bill to for the Order.
BillToAddr	string	It represents the address line 1 of bill to for the Order.
BillToAddr2	string	It represents the address line 2 of bill to for the Order.
BillToCity	string	It represents the city of bill to for the Order.
BillToCountry	string	It represents the country name of bill to for the Order.
BillToCountryISO2	string	It is a code to Identify a Country of bill to for the Order
BillToState	string	It represents the state name of bill to for the Order.
BillToStateAbbr	string	It is the abbrevation of state name of bill to for the Order.
BillToZpCode	string	It represents the zip code of bill to for the Order.
BillToCompanyName	string	It represents the company name of bill to for the Order.
BillToPhoneNumber	string	It represents the phone number of bill to for the Order.
BillToEmail	string	It represents the email of bill to for the Order.
CustomerGroupName	string	It represents the customer group name for the Order.
DepositRequiredTypeName	string	It represents the deposit on the order, whether that deposit is Amount or a Percentage.
DepositRequiredAmount	double	It is percentage or amount of deposit required for this order.
DepositAmount	double	It represents the deposit amount for the Deposit.
DepositAccountName	string	It represents the deposit account name for the Account.
LiabilityAccountName	string	It represents the liability account name for the Account.
PaymentMethodName	string	It represents the payment method name for the Method.
AutoDepositTotalAmount	string	It represents the auto deposit total amount for the Total.
CustomerServiceRepId	string	It represents the customer service representative id.
ThirdPartyTotalAmount	double	It represents the third party total amount.
CustomFieldH1	string	Custom Fields (CustomFieldH1 - CustomFieldH30).
ItemNumber	string, required	The item's (SKU) number. This property is unique to this item, another item cannot be created with the same Item Number.
ItemUpc	string	The item's UPC code.
ItemBrand	string	The item's Brand.
Description	string	The item's description.
UnitPrice	double, required	The item's Unit Price.
Qty	double, required	The item's Qty.
Discount	double	The item's Discount.
DiscountTypeName	string	Percentage or Amount.
SellUomName	string	Selling unit of measurement of the item
ItemNotes	string	It represents the item notes for the Item.
TaxItemCode1	string	It represents the TaxItemCode1 for the Item.
TaxItemValue1	double	It represents the TaxItemValue1 for the Item.
TaxItemCode2	string	It represents the TaxItemCode2 for the Item.
TaxItemValue2	double	It represents the TaxItemValue2 for the Item.
TaxItemCode3	string	It represents the TaxItemCode3 for the Item.
TaxItemValue3	double	It represents the TaxItemValue3 for the Item.
TaxItemCode4	string	It represents the TaxItemCode4 for the Item.
TaxItemValue4	double	It represents the TaxItemValue4 for the Item.
ItemCategoryName	string	It represents the name of item category here.
ItemGroupName	string	It represents the name of item group here.
ItemShippingCost	double	It represents the item shipping cost.
ItemShippingTaxItemCode1	string	It represents the ItemShippingTaxItemCode1.
ItemShippingTaxItemValue1	double	It represents the ItemShippingTaxItemValue1.
ItemShippingTaxItemCode2	string	It represents the ItemShippingTaxItemCode2.
ItemShippingTaxItemValue2	double	It represents the ItemShippingTaxItemValue2.
ItemShippingTaxItemCode3	string	It represents the ItemShippingTaxItemCode3.
ItemShippingTaxItemValue3	double	It represents the ItemShippingTaxItemValue3.
ItemShippingTaxItemCode4	string	It represents the ItemShippingTaxItemCode4.
ItemShippingTaxItemValue4	double	It represents the ItemShippingTaxItemValue4.
BaseUomCode	string	It represents the code for base value of unit of measurement.
SellUomCode	string	It represents the code for unit of measurement used for selling.
VASItemName	string	Value added service name.
VASItemCost	double	Value added service item cost.
AutoReleaseSalesOrder	bool	This will auto release the sales order while creating sales order.
CustomFieldD1	string	Custom Fields (CustomFieldD1 - CustomFieldD30).
CustomerDefaultOrderTypeName	string	The default order type associated with the customer.
CustomerDefaultProjectClassName	string	The default project class linked to the customer.
IsCustomerTaxExempt	bool	Indicates whether the customer is tax-exempt (true or false).
CustomerTaxNumber1	string	It represents the primary tax identification number of the customer.
CustomerTaxNumber2	string	It represents the secondary tax identification number of the customer (if applicable).
CustomerTags	string	Tags or labels associated with the customer for categorization or reporting purposes.

Equivalent Routes

This operation is documented once to avoid duplicate pages. The same workflow is also available at: /api/xerp/salesorder/import.

post

Authorizations

AuthorizationstringRequired

Body

Request body for Create Sales Order.

ThirdPartyRefNostringRequired

A reference number for the order. If an order in Xorosoft ERP exists with the same ThirdPartyRefNo, it will be detected as a duplicate and will not be created.

ThirdPartySourcestringOptional

If the order came from a third party platform, it can be indicated here.

ThirdPartyIconUrlstringOptional

Use a URL that ends with .png or .jpg for an image of the third party source.For example, a Joor order would have a Joor icon.

ThirdPartyDisplayNamestringOptional

It represents the name of third party source.

CheckThirdPartySourcebooleanOptional

Property, when set to true, checks if a third-party reference number exists with the same third-party source

SaleStoreNamestringRequired

It is Sale Store's (inventory set) name here exactly as it is in Xorosoft ERP.

StoreNamestringOptional

It is Ship Store's (inventory set) name here exactly as it is in Xorosoft ERP. If this is left blank, then **SaleStoreName will be used.

CurrencyCodestringRequired

It represents the currency for the order. This must match with the customer's currency. Choose from: USD,CAD,EUR,AUD.

CustomerNamestringRequired

It represents the name of customer.

CustomerFirstNamestringOptional

First Name of the customer.

CustomerLastNamestringOptional

Last Name of the customer.

CustomerMainPhonestringOptional

Customer main Phone Number

CustomerEmailMainstringOptional

The customer's email address.

CustomerPOstringOptional

Customer PO field.

OrderDatestring · date-timeRequired

The date the order was placed.

DateToBeShippedstring · date-timeRequired

The date the order is to be shipped before or on.

LastDateToBeShippedstring · date-timeOptional

The date the order should be shipped.

DateToBeCancelledstring · date-timeOptional

If the order hasn't been fulfilled by this date, then it can be cancelled, MM-DD-YYYY

OrderClassCodestringOptional

It represents the Code categorize your orders.

OrderClassNamestringOptional

It represents the name of the Class to categorize your orders.

OrderTypeCodestringOptional

It represents the code for type of order.

OrderTypeNamestringOptional

It represents the name for type of order.

ExchangeRatenumberRequired

It represents the exchange rate betweeen currencies. If currency is the same as home currency, then put 1 here. Otherwise put the exchange rate for the order.

MemostringOptional

A memo for the order can be entered here.

PaymentTermsNamestringOptional

It is a payment term from the system for this order. This must match up exactly to a Payment Term in Xorosoft ERP.

PaymentTermsTypestringOptional

It represents the code for type of payment terms.

RefNostringOptional

It is a reference number for the order here. This can be an internal reference number, as opposed to a third-party reference number.

TagsstringOptional

It represents tags here for the order and multiple tags can be separated by a comma.

SalesRepIdstringOptional

Please refer to the User Centre in your Xorosoft ERP system and enter the UserID of the sales rep for this Sales Order.

ShipMethodNamestringOptional

It is a ship method for the order here. Choose from: Pick Up, Delivery(Own Truck) and Delivery(Third Party)

CarrierNamestringOptional

If ShipMethodName is not Pick Up, then enter a carrier.

CarrierCodestringOptional

The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).

ShipServiceNamestringOptional

It represents the name of ship service for the order.

ShipServiceCodestringOptional

The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).

FobNamestringOptional

It represents the FobName for the order.

IsOrderTaxExemptbooleanOptional

It represents the boolean represented in the form of N for Exempt tax and Y for Active Tax.

ShippingTaxItemCode1stringOptional

It represents the ShippingTaxItemCode1 for the Order.

ShippingTaxItemValue1numberOptional

It represents the ShippingTaxItemValue1 for the Order.

ShippingTaxItemCode2stringOptional

It represents the ShippingTaxItemCode2 for the Order.

ShippingTaxItemValue2numberOptional

It represents the ShippingTaxItemValue2 for the Order.

ShippingTaxItemCode3stringOptional

It represents the ShippingTaxItemCode3 for the Order.

ShippingTaxItemValue3numberOptional

It represents the ShippingTaxItemValue3 for the Order.

ShippingTaxItemCode4stringOptional

It represents the ShippingTaxItemCode4 for the Order.

ShippingTaxItemValue4numberOptional

It represents the ShippingTaxItemValue5 for the Order.

ShippingTermsNamestringOptional

It represents the shipping terms.Choose from: Prepaid, Collect, Prepaid& Billed, Collect& Allowed and Third Party Billing.

ShippingAccountNumberstringOptional

It represents the shipping account number here.

ShippingCostnumberOptional

It represents the shipping cost for the Order.

ShippingNotesstringOptional

It represents the shipping notes for the Order.

ShipToFirstNamestringOptional

It represents the first name of ship to for the Order.

ShipToLastNamestringOptional

It represents the last name of ship to for the Order.

ShipToNamestringOptional

It represents the Main address name of ship to for the Order.

ShipToCompanyNamestringOptional

It represents the company name of ship to for the Order.

ShipToAddrstringOptional

It represents the address line 1 of ship to for the Order.

ShipToAddr2stringOptional

It represents the address line 2 of ship to for the Order.

ShipToCitystringOptional

It represents the city of ship to for the Order.

ShipToCountrystringOptional

It represents the country name of ship to for the Order.

ShipToCountryISO2stringOptional

It is a code to Identify a Country of ship to for the Order

ShipToStatestringOptional

It represents the state name of ship to for the Order.

ShipToStateAbbrstringOptional

It is the abbrevation of state of ship to for the Order.

ShipToZpCodestringOptional

It represents the zip code of ship to for the Order.

ShipToPhoneNumberstringOptional

It represents the phone number of ship to for the Order.

ShipToEmailstringOptional

It represents the email of ship to for the Order.

BuyerNamestringOptional

It is a name of Buyer.

BillToFirstNamestringOptional

It represents the first name of bill to for the Order.

BillToLastNamestringOptional

It represents the last name of bill to for the Order.

BillToNamestringOptional

It represents the Main address name of bill to for the Order.

BillToAddrstringOptional

It represents the address line 1 of bill to for the Order.

BillToAddr2stringOptional

It represents the address line 2 of bill to for the Order.

BillToCitystringOptional

It represents the city of bill to for the Order.

BillToCountrystringOptional

It represents the country name of bill to for the Order.

BillToCountryISO2stringOptional

It is a code to Identify a Country of bill to for the Order

BillToStatestringOptional

It represents the state name of bill to for the Order.

BillToStateAbbrstringOptional

It is the abbrevation of state name of bill to for the Order.

BillToZpCodestringOptional

It represents the zip code of bill to for the Order.

BillToCompanyNamestringOptional

It represents the company name of bill to for the Order.

BillToPhoneNumberstringOptional

It represents the phone number of bill to for the Order.

BillToEmailstringOptional

It represents the email of bill to for the Order.

CustomerGroupNamestringOptional

It represents the customer group name for the Order.

DepositRequiredTypeNamestringOptional

It represents the deposit on the order, whether that deposit is Amount or a Percentage.

DepositRequiredAmountnumberRequired

It is percentage or amount of deposit required for this order.

DepositAmountnumberOptional

It represents the deposit amount for the Deposit.

DepositAccountNamestringOptional

It represents the deposit account name for the Account.

LiabilityAccountNamestringOptional

It represents the liability account name for the Account.

PaymentMethodNamestringOptional

It represents the payment method name for the Method.

AutoDepositTotalAmountstringOptional

It represents the auto deposit total amount for the Total.

CustomerServiceRepIdstringOptional

It represents the customer service representative id.

ThirdPartyTotalAmountnumberOptional

It represents the third party total amount.

CustomFieldH1stringOptional

Custom Fields (CustomFieldH1 - CustomFieldH30).

ItemNumberstringRequired

The item's (SKU) number. This property is unique to this item, another item cannot be created with the same Item Number.

ItemUpcstringOptional

The item's UPC code.

ItemBrandstringOptional

The item's Brand.

UnitPricenumberRequired

The item's Unit Price.

QtynumberRequired

The item's Qty.

DiscountnumberOptional

The item's Discount.

DiscountTypeNamestringOptional

Percentage or Amount.

SellUomNamestringOptional

Selling unit of measurement of the item

ItemNotesstringOptional

It represents the item notes for the Item.

TaxItemCode1stringOptional

It represents the TaxItemCode1 for the Item.

TaxItemValue1numberOptional

It represents the TaxItemValue1 for the Item.

TaxItemCode2stringOptional

It represents the TaxItemCode2 for the Item.

TaxItemValue2numberOptional

It represents the TaxItemValue2 for the Item.

TaxItemCode3stringOptional

It represents the TaxItemCode3 for the Item.

TaxItemValue3numberOptional

It represents the TaxItemValue3 for the Item.

TaxItemCode4stringOptional

It represents the TaxItemCode4 for the Item.

TaxItemValue4numberOptional

It represents the TaxItemValue4 for the Item.

ItemCategoryNamestringOptional

It represents the name of item category here.

ItemGroupNamestringOptional

It represents the name of item group here.

ItemShippingCostnumberOptional

It represents the item shipping cost.

ItemShippingTaxItemCode1stringOptional

It represents the ItemShippingTaxItemCode1.

ItemShippingTaxItemValue1numberOptional

It represents the ItemShippingTaxItemValue1.

ItemShippingTaxItemCode2stringOptional

It represents the ItemShippingTaxItemCode2.

ItemShippingTaxItemValue2numberOptional

It represents the ItemShippingTaxItemValue2.

ItemShippingTaxItemCode3stringOptional

It represents the ItemShippingTaxItemCode3.

ItemShippingTaxItemValue3numberOptional

It represents the ItemShippingTaxItemValue3.

ItemShippingTaxItemCode4stringOptional

It represents the ItemShippingTaxItemCode4.

ItemShippingTaxItemValue4numberOptional

It represents the ItemShippingTaxItemValue4.

BaseUomCodestringOptional

It represents the code for base value of unit of measurement.

SellUomCodestringOptional

It represents the code for unit of measurement used for selling.

VASItemNamestringOptional

Value added service name.

VASItemCostnumberOptional

Value added service item cost.

AutoReleaseSalesOrderbooleanOptional

This will auto release the sales order while creating sales order.

CustomFieldD1stringOptional

Custom Fields (CustomFieldD1 - CustomFieldD30).

CustomerDefaultOrderTypeNamestringOptional

The default order type associated with the customer.

CustomerDefaultProjectClassNamestringOptional

The default project class linked to the customer.

IsCustomerTaxExemptbooleanOptional

Indicates whether the customer is tax-exempt (true or false).

CustomerTaxNumber1stringOptional

It represents the primary tax identification number of the customer.

CustomerTaxNumber2stringOptional

It represents the secondary tax identification number of the customer (if applicable).

CustomerTagsstringOptional

Tags or labels associated with the customer for categorization or reporting purposes.

Other propertiesanyOptional

Responses

200

OK

No content

post/api/xerp/salesorder/create

POST /api/xerp/salesorder/create HTTP/1.1
Host: res.xorosoft.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "SoEstimateHeader": {
    "ThirdPartyRefNo": "SO-EXT-1001",
    "CustomerName": "Example Customer"
  },
  "SoEstimateItemLineArr": [
    {
      "ItemNumber": "SKU-001",
      "Qty": 1
    }
  ]
}

200

OK

No content