SalesOrders Resource

Customer Users and Administrators can access the SalesOrders Resource.

Users can retrieve one Sales Order or a list of Sales Orders for their Customer. Administrators can retrieve one Sales Order or a list of Sales Orders for any Customer.

Customer Users and Administrators can create new orders, using the Create and Submit method. The Create method, creates a Sales Order Quote in order to calculate freight and sales tax without affecting inventory. The second method, Submit, changes the Quote to an Order.

The Submit method also allows you to post payment information. If your website handles the credit card processing, just post a deposit on the order in a special Payment Type (“WEB”?).

Payment data is not allowed on a Quote!

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/salesOrders[?salesOrderNo=<salesOrderNo>]		Users can retrieve one or more of the Sales Orders belonging to their Customer
list	GET	/salesOrders		Users can retrieve one or more of the Sales Orders belonging to their Customer. Administrators can retrieve one or more Sales Order for any Customer
update	POST	/salesOrders?method=update&salesOrderNo=<salesOrderNo>		The update method removes the Sales Order and creates a new entry with the same Sales Order Number
create	POST	/salesOrders?method=create		The Create method creates a new Sales Order Quote. The Sales Order Number is returned
submit	POST	/salesOrders?method=submit		The Submit method changes the Quote to a Sales Order. The Sales Order Number is returned
delete	POST	/salesOrders?method=delete&salesOrderNo=<salesOrderNo>		Delete the Sales Order from Sage 100

Resource Table List
Click on the table to view detail.

Sales Order

Element Name	Description	Type	Length
SalesOrderNo	Sales Order Number	String	7
OrderDate	Order Date	String	8
OrderType	Order Type	String	1
OrderStatus	Order Status	String	1
MasterRepeatingOrderNo	Master Repeating Order Number	String	7
ShipExpireDate	Ship Expire Date	String	8
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
BillToDivisionNo	Bill To Division Number	String	2
BillToCustomerNo	Bill To Customer Number	String	20
BillToName	Bill To Name	String	30
BillToAddress1	Bill To Address Line 1	String	30
BillToAddress2	Bill To Address Line 2	String	30
BillToAddress3	Bill To Address Line 3	String	30
BillToCity	Bill To City	String	20
BillToState	Bill To State	String	2
BillToZipCode	Bill To Zip Code	String	10
BillToCountryCode	Bill To Country Code	String	3
ShipToCode	Ship-To Code	String	4
ShipToName	Ship To Name	String	30
ShipToAddress1	Ship To Address Line 1	String	30
ShipToAddress2	Ship To Address Line 2	String	30
ShipToAddress3	Ship To Address Line 3	String	30
ShipToCity	Ship To City	String	20
ShipToState	Ship To State	String	2
ShipToZipCode	Ship To Zip Code	String	10
ShipToCountryCode	Ship To Country Code	String	3
ShipVia	Ship Via	String	15
ShipZone	Ship Zone	String	5
ShipZoneActual	Ship Zone Actual	String	5
ShipWeight	Ship Weight	String	5
CustomerPONo	Customer PO Number	String	15
FOB	F.O.B.	String	15
WarehouseCode	Warehouse Code	String	3
ConfirmTo	Confirm To	String	30
Comment	Comment	String	30
TermsCode	Terms Code	String	2
TaxSchedule	Tax Schedule	String	9
TaxExemptNo	Tax Exempt Number	String	15
InvalidTaxCalc	Invalid Tax Calculation	String	1
PrintSalesOrders	Print Sales Orders	String	1
SalesOrderPrinted	Sales Order Printed	String	1
PrintPickingSheets	Print Picking Sheets	String	1
PickingSheetPrinted	Picking Sheet Printed	String	1
LastInvoiceOrderDate	Last Invoice Order Date	String	8
LastInvoiceOrderNo	Last Invoice Order Number	String	7
CurrentInvoiceNo	Current Invoice Number	String	7
CheckNoForDeposit	Check Number For Deposit	String	10
CycleCode	Cycle Code	String	2
FaxNo	Fax Number	String	17
BatchFax	Batch Fax	String	1
BatchEmail	Batch Email	String	1
EmailAddress	Email Address	String	250
FreightCalculationMethod	Freight Calculation Method	String	1
LotSerialLinesExist	Lot/Serial Lines Exist	String	1
SalespersonDivisionNo	Salesperson Division Number	String	2
SalespersonNo	Salesperson Number	String	4
SplitCommissions	Split Commissions	String	1
SalespersonDivisionNo2	Salesperson Division Number 2	String	2
SalespersonNo2	Salesperson Number 2	String	4
SalespersonDivisionNo3	Salesperson Division Number 3	String	2
SalespersonNo3	Salesperson Number 3	String	4
SalespersonDivisionNo4	Salesperson Division Number 4	String	2
SalespersonNo4	Salesperson Number 4	String	4
SalespersonDivisionNo5	Salesperson Division Number 5	String	2
SalespersonNo5	Salesperson Number 5	String	4
EBMUserType	EBM Internet User Type	String	1
EBMSubmissionType	EBM Internet Submission Type	String	1
EBMUserIDSubmittingThisOrder	EBM Internet User ID Submittting This Order	String	15
PaymentType	Payment Type	String	5
OtherPaymentTypeRefNo	Other Payment Type Reference Number	String	24
PaymentTypeCategory	Payment Type Category	String	1
CancelReasonCode	Cancellation Reason Code	String	5
RMANo	RMA Number	String	7
JobNo	Job Number	String	7
ResidentialAddress	Residential Address	String	1
CRMUserID	CRM User ID	String	11
CRMPersonID	CRM Person ID	String	11
CRMOpportunityID	CRM Opportunity ID	String	11
CRMCompanyID	CRM Company ID	String	11
CRMProspectID	CRM Prospect ID	String	11
TaxableSubjectToDiscount	Taxable Subject To Discount	Numeric	13.2
NonTaxableSubjectToDiscount	Non-Taxable Subject To Discount	Numeric	13.2
TaxSubjToDiscPrcntOfTotSubjTo	Tax-Subj-To-Disc % Of Total-Subj-To-Disc	Numeric	7.2
DiscountRate	Discount Rate	Numeric	8.3
DiscountAmt	Discount Amount	Numeric	12.2
TaxableAmt	Taxable Amount	Numeric	13.2
NonTaxableAmt	Non-Taxable Amount	Numeric	13.2
SalesTaxAmt	Sales Tax Amount	Numeric	12.2
Weight	Weight	Numeric	12.2
FreightAmt	Freight Amount	Numeric	12.2
DepositAmt	Deposit Amount	Numeric	13.2
CommissionRate	Commission Rate	Numeric	9.3
SplitCommRate2	Split Commission Rate 2	Numeric	9.3
SplitCommRate3	Split Commission Rate 3	Numeric	9.3
SplitCommRate4	Split Commission Rate 4	Numeric	9.3
SplitCommRate5	Split Commission Rate 5	Numeric	9.3
NumberOfShippingLabels	Number Of Shipping Labels	Numeric	2
LastNoOfShippingLabels	Last Number Of Shipping Labels	Numeric	2
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

Sales Order Detail

Element Name	Description	Type	Length
SalesOrderNo	Sales Order Number	String	7
LineKey	Line Key	String	6
LineSeqNo	Line Sequence Number	String	14
ItemCode	Item Code	String	30
ItemType	ItemType	String	1
ItemCodeDesc	Item Code Description	String	30
ExtendedDescriptionKey	Extended Description Key	String	10
Discount	Discount	String	1
Commissionable	Commissionable	String	1
SubjectToExemption	Subject To Exemption	String	1
WarehouseCode	Warehouse Code	String	3
Valuation	Valuation	String	1
PriceLevel	Price Level	String	1
MasterOrderLineKey	Master Order Line Key	String	6
UnitOfMeasure	Unit Of Measure	String	4
DropShip	Drop Ship	String	1
LotSerialFullyDistributed	Lot/Serial Fully Distributed	String	1
PrintDropShipment	Print Drop Shipment	String	1
SalesKitLineKey	Sales Kit Line Key	String	6
CostOfGoodsSoldAcctKey	Cost of Goods Sold Account Key	String	9
SalesAcctKey	Sales Account Key	String	9
PriceOverridden	Has Price Been Overridden	String	1
ExplodedKitItem	Exploded Kit Item	String	1
StandardKitBill	Standard/Kit Bill	String	1
Revision	Bill Revision Code	String	3
BillOption1	Bill Option 1	String	2
BillOption2	Bill Option 2	String	2
BillOption3	Bill Option 3	String	2
BillOption4	Bill Option 4	String	2
BillOption5	Bill Option 5	String	2
BillOption6	Bill Option 6	String	2
BillOption7	Bill Option 7	String	2
BillOption8	Bill Option 8	String	2
BillOption9	Bill Option 9	String	2
BackorderKitCompLine	Backorder Kit Component Line	String	1
SkipPrintCompLine	Skip Printing Of This Component	String	1
PromiseDate	Promise Date	String	8
AliasItemNo	Alias Item Number	String	30
SOHistoryDetlSeqNo	Sales Order History Detail Sequence Number	String	14
TaxClass	Tax Class	String	2
CustomerAction	Customer Action	String	1
ItemAction	Item Action	String	1
WarrantyCode	Warranty Code	String	10
ExpirationDate	Expiration Date	String	8
ExpirationOverridden	Expiration Overridden	String	1
CostOverridden	Cost Overridden	String	1
CostCode	Cost Code	String	9
CostType	Cost Type	String	1
CommentText	Comment Text	String	2048
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
PurchaseOrderNo	Purchase Order Number	String	7
PurchaseOrderRequiredDate	Purchase Order Required Date	String	8
QuantityOrdered	Quantity Ordered	Numeric	16.6
QuantityShipped	Quantity Shipped	Numeric	16.6
QuantityBackordered	Quantity Backordered	Numeric	16.6
MasterOriginalQty	Master Original Quantity	Numeric	16.6
MasterQtyBalance	Master Quantity Balance	Numeric	16.6
MasterQtyOrderedToDate	Master Quantity Ordered To Date	Numeric	16.6
RepeatingQtyShippedToDate	Repeating Quantity Shipped To Date	Numeric	16.6
UnitPrice	Unit Price	Numeric	16.6
UnitCost	Unit Cost	Numeric	16.6
ExtensionAmt	Extension Amount	Numeric	12.2
UnitOfMeasureConvFactor	Unit Of Measure Conversion Factor	Numeric	12.4
QuantityPerBill	Quantity Per Bill	Numeric	16.6
LineDiscountPercent	Line Discount Percent	Numeric	9.3
LineWeight	Line Weight	Numeric	12.2

AR Customer

Element Name	Description	Type	Length
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
CustomerName	Customer Name	String	30
AddressLine1	Address Line 1	String	30
AddressLine2	Address Line 2	String	30
AddressLine3	Address Line 3	String	30
City	City	String	20
State	State	String	2
ZipCode	Zip Code	String	10
CountryCode	Country Code	String	3
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
EmailAddress	Email Address	String	250
URLAddress	URL Address	String	50
EBMEnabled	eBusiness Manager Enabled	String	1
EBMConsumerUserID	eBusiness Manager Consumer User ID	String	15
BatchFax	Batch Fax	String	1
DefaultCreditCardPmtType	Default Credit Card Payment Type	String	5
ContactCode	Contact Code	String	10
ShipMethod	Ship Method	String	15
TaxSchedule	Tax Schedule	String	9
TaxExemptNo	Tax Exempt Number	String	15
TermsCode	Terms Code	String	2
SalespersonDivisionNo	Salesperson Division Number	String	2
SalespersonNo	Salesperson Number	String	4
SalespersonDivisionNo2	Salesperson Division Number 2	String	2
SalespersonNo2	Salesperson Number 2	String	4
SalespersonDivisionNo3	Salesperson Division Number 3	String	2
SalespersonNo3	Salesperson Number 3	String	4
SalespersonDivisionNo4	Salesperson Division Number 4	String	2
SalespersonNo4	Salesperson Number 4	String	4
SalespersonDivisionNo5	Salesperson Division Number 5	String	2
SalespersonNo5	Salesperson Number 5	String	4
Comment	Customer Comment	String	30
SortField	Sort Field	String	10
TemporaryCustomer	Obsolete 5.00	String	1
CustomerStatus	Customer Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
OpenItemCustomer	Open Item Customer	String	1
ResidentialAddress	Residential Address	String	1
StatementCycle	Statement Cycle	String	1
PrintDunningMessage	Print Dunning Message On Statement	String	1
CustomerType	Customer Type	String	4
PriceLevel	Price Level	String	1
DateLastActivity	Date Of Last Activity	String	8
DateLastPayment	Date Of Last Payment	String	8
DateLastStatement	Date Of Last Statement	String	8
DateLastFinanceChrg	Date Of Last Finance Charge	String	8
DateLastAging	Date Of Last Aging	String	8
DefaultItemCode	Default Item Code	String	30
DefaultCostCode	Default Cost Code	String	9
DefaultCostType	Default Cost Type	String	1
CreditHold	Customer On Credit Hold	String	1
PrimaryShipToCode	Primary Ship To Code	String	4
DateEstablished	Date Established	String	8
CreditCardGUID	Sage Exchange vault credit card identifier	String	32
DefaultPaymentType	Default Payment Type	String	5
EmailStatements	Obsolete 4.30	String	1
NumberOfInvToUseInCalc	Number Of Invoices To Use In Days Calc	Numeric	2
AvgDaysPaymentInvoice	Avg Days For Payment From Invoice Date	Numeric	3
AvgDaysOverDue	Avg Days Overdue (Pay Date - Due Date)	Numeric	3
CustomerDiscountRate	Customer Discount Rate	Numeric	13.3
ServiceChargeRate	Service Charge Rate	Numeric	13.3
CreditLimit	Credit Limit	Numeric	14.2
LastPaymentAmt	Last Payment Amount	Numeric	14.2
HighestStmntBalance	Highest Statement Balance	Numeric	14.2
UnpaidServiceChrg	Unpaid Service Charge	Numeric	14.2
BalanceForward	Balance Forward	Numeric	14.2
CurrentBalance	Current Balance	Numeric	14.2
AgingCategory1	Aging Category 1	Numeric	14.2
AgingCategory2	Aging Category 2	Numeric	14.2
AgingCategory3	Aging Category 3	Numeric	14.2
AgingCategory4	Aging Category 4	Numeric	14.2
OpenOrderAmt	Open Order Amount	Numeric	14.2
RetentionCurrent	Retention Current	Numeric	14.2
RetentionAging1	Retention Aging 1	Numeric	14.2
RetentionAging2	Retention Aging 2	Numeric	14.2
RetentionAging3	Retention Aging 3	Numeric	14.2
RetentionAging4	Retention Aging 4	Numeric	14.2
SplitCommRate2	Split Commission Rate 2	Numeric	9.3
SplitCommRate3	Split Commission Rate 3	Numeric	9.3
SplitCommRate4	Split Commission Rate 4	Numeric	9.3
SplitCommRate5	Split Commission Rate 5	Numeric	9.3
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AR Division

Element Name	Description	Type	Length
TermsCode	AR Terms Code	String	2
TermsCodeDesc	Terms Code Description	String	30
DueDateADayOfTheMonth	Due Date a Day of The Month	String	1
DiscountDateADayOfTheMo	Discount Date a Day of The Month	String	1
DiscountCalculationMethod	Discount Calculation Method	String	1
DaysBeforeDue	Days Before Due	Numeric	3
MinimumDaysAllowedInv	Minimum Days Allowed Before Invoice is Due	Numeric	3
DaysBeforeDiscountDue	Days Before Discount Due	Numeric	3
MinimumDaysAllowedDisc	Minimum Days Allowed Before Discount Due	Numeric	3
DiscountRate	Discount Rate	Numeric	9.3
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

Sales Order header and detail data is available to Customer Users and Administrators. The columns to be returned are defined in Return Maintenance.

Customer Users can return a list of all of their Sales Orders. Administrators can return a list of all Sales Orders.

Customer Users can update Sales Orders assign to their Customer, while Administrators can update any Sales Orders.

Customer Users can create Sales Orders for their Customer. (Administrators can create a Sales Order for any Customer.) Sales Orders are created initially as Quotes, and then converted to Orders using the Submit method. This paradigm is in place so the order can be added without affecting inventory and still calculating sales tax and freight. This enables your application to display the sales tax and freight to a web user before submitting the order.

Customer Users can submit Sales Orders previously placed on file for their Customer as Quotes. The Quote is simply changed to an Order. Administrators can Submit any Sales Order placed on file as a Quote.

Only Administrators can change a user from Active to Inactive, removing the users access to the Sage Data Exchange API. Users cannot actually be deleted by the external application.

SalesOrders Resource

Sales Order

Sales Order Detail

AR Customer

AR Division

Resource Methods

Get

List

Update

Create

Submit

Delete