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”?).

Resource Method List
ActionHTTPURIAdmin?Description
getGET/salesOrders[?salesOrderNo=<salesOrderNo>] Users can retrieve one or more of the Sales Orders belonging to their Customer
listGET/salesOrdersUsers can retrieve one or more of the Sales Orders belonging to their Customer. Administrators can retrieve one or more Sales Order for any Customer
updatePOST/salesOrders?method=update&salesOrderNo=<salesOrderNo>The update method removes the Sales Order and creates a new entry with the same Sales Order Number
createPOST/salesOrders?method=createThe Create method creates a new Sales Order Quote. The Sales Order Number is returned
submitPOST/salesOrders?method=submitThe Submit method changes the Quote to a Sales Order. The Sales Order Number is returned
deletePOST/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 NameDescriptionTypeLength
SalesOrderNoSales Order NumberString7
OrderDateOrder DateString8
OrderTypeOrder TypeString1
OrderStatusOrder StatusString1
MasterRepeatingOrderNoMaster Repeating Order NumberString7
ShipExpireDateShip Expire DateString8
ARDivisionNoAR Division NumberString2
CustomerNoCustomer NumberString20
BillToDivisionNoBill To Division NumberString2
BillToCustomerNoBill To Customer NumberString20
BillToNameBill To NameString30
BillToAddress1Bill To Address Line 1String30
BillToAddress2Bill To Address Line 2String30
BillToAddress3Bill To Address Line 3String30
BillToCityBill To CityString20
BillToStateBill To StateString2
BillToZipCodeBill To Zip CodeString10
BillToCountryCodeBill To Country CodeString3
ShipToCodeShip-To CodeString4
ShipToNameShip To NameString30
ShipToAddress1Ship To Address Line 1String30
ShipToAddress2Ship To Address Line 2String30
ShipToAddress3Ship To Address Line 3String30
ShipToCityShip To CityString20
ShipToStateShip To StateString2
ShipToZipCodeShip To Zip CodeString10
ShipToCountryCodeShip To Country CodeString3
ShipViaShip ViaString15
ShipZoneShip ZoneString5
ShipZoneActualShip Zone ActualString5
ShipWeightShip WeightString5
CustomerPONoCustomer PO NumberString15
FOBF.O.B.String15
WarehouseCodeWarehouse CodeString3
ConfirmToConfirm ToString30
CommentCommentString30
TermsCodeTerms CodeString2
TaxScheduleTax ScheduleString9
TaxExemptNoTax Exempt NumberString15
InvalidTaxCalcInvalid Tax CalculationString1
PrintSalesOrdersPrint Sales OrdersString1
SalesOrderPrintedSales Order PrintedString1
PrintPickingSheetsPrint Picking SheetsString1
PickingSheetPrintedPicking Sheet PrintedString1
LastInvoiceOrderDateLast Invoice Order DateString8
LastInvoiceOrderNoLast Invoice Order NumberString7
CurrentInvoiceNoCurrent Invoice NumberString7
CheckNoForDepositCheck Number For DepositString10
CycleCodeCycle CodeString2
FaxNoFax NumberString17
BatchFaxBatch FaxString1
BatchEmailBatch EmailString1
EmailAddressEmail AddressString250
FreightCalculationMethodFreight Calculation MethodString1
LotSerialLinesExistLot/Serial Lines ExistString1
SalespersonDivisionNoSalesperson Division NumberString2
SalespersonNoSalesperson NumberString4
SplitCommissionsSplit CommissionsString1
SalespersonDivisionNo2Salesperson Division Number 2String2
SalespersonNo2Salesperson Number 2String4
SalespersonDivisionNo3Salesperson Division Number 3String2
SalespersonNo3Salesperson Number 3String4
SalespersonDivisionNo4Salesperson Division Number 4String2
SalespersonNo4Salesperson Number 4String4
SalespersonDivisionNo5Salesperson Division Number 5String2
SalespersonNo5Salesperson Number 5String4
EBMUserTypeEBM Internet User TypeString1
EBMSubmissionTypeEBM Internet Submission TypeString1
EBMUserIDSubmittingThisOrderEBM Internet User ID Submittting This OrderString15
PaymentTypePayment TypeString5
OtherPaymentTypeRefNoOther Payment Type Reference NumberString24
PaymentTypeCategoryPayment Type CategoryString1
CancelReasonCodeCancellation Reason CodeString5
RMANoRMA NumberString7
JobNoJob NumberString7
ResidentialAddressResidential AddressString1
CRMUserIDCRM User IDString11
CRMPersonIDCRM Person IDString11
CRMOpportunityIDCRM Opportunity IDString11
CRMCompanyIDCRM Company IDString11
CRMProspectIDCRM Prospect IDString11
TaxableSubjectToDiscountTaxable Subject To DiscountNumeric13.2
NonTaxableSubjectToDiscountNon-Taxable Subject To DiscountNumeric13.2
TaxSubjToDiscPrcntOfTotSubjToTax-Subj-To-Disc % Of Total-Subj-To-DiscNumeric7.2
DiscountRateDiscount RateNumeric8.3
DiscountAmtDiscount AmountNumeric12.2
TaxableAmtTaxable AmountNumeric13.2
NonTaxableAmtNon-Taxable AmountNumeric13.2
SalesTaxAmtSales Tax AmountNumeric12.2
WeightWeightNumeric12.2
FreightAmtFreight AmountNumeric12.2
DepositAmtDeposit AmountNumeric13.2
CommissionRateCommission RateNumeric9.3
SplitCommRate2Split Commission Rate 2Numeric9.3
SplitCommRate3Split Commission Rate 3Numeric9.3
SplitCommRate4Split Commission Rate 4Numeric9.3
SplitCommRate5Split Commission Rate 5Numeric9.3
NumberOfShippingLabelsNumber Of Shipping LabelsNumeric2
LastNoOfShippingLabelsLast Number Of Shipping LabelsNumeric2
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

Sales Order Detail

Element NameDescriptionTypeLength
SalesOrderNoSales Order NumberString7
LineKeyLine KeyString6
LineSeqNoLine Sequence NumberString14
ItemCodeItem CodeString30
ItemTypeItemTypeString1
ItemCodeDescItem Code DescriptionString30
ExtendedDescriptionKeyExtended Description KeyString10
DiscountDiscountString1
CommissionableCommissionableString1
SubjectToExemptionSubject To ExemptionString1
WarehouseCodeWarehouse CodeString3
ValuationValuationString1
PriceLevelPrice LevelString1
MasterOrderLineKeyMaster Order Line KeyString6
UnitOfMeasureUnit Of MeasureString4
DropShipDrop ShipString1
LotSerialFullyDistributedLot/Serial Fully DistributedString1
PrintDropShipmentPrint Drop ShipmentString1
SalesKitLineKeySales Kit Line KeyString6
CostOfGoodsSoldAcctKeyCost of Goods Sold Account KeyString9
SalesAcctKeySales Account KeyString9
PriceOverriddenHas Price Been OverriddenString1
ExplodedKitItemExploded Kit ItemString1
StandardKitBillStandard/Kit BillString1
RevisionBill Revision CodeString3
BillOption1Bill Option 1String2
BillOption2Bill Option 2String2
BillOption3Bill Option 3String2
BillOption4Bill Option 4String2
BillOption5Bill Option 5String2
BillOption6Bill Option 6String2
BillOption7Bill Option 7String2
BillOption8Bill Option 8String2
BillOption9Bill Option 9String2
BackorderKitCompLineBackorder Kit Component LineString1
SkipPrintCompLineSkip Printing Of This ComponentString1
PromiseDatePromise DateString8
AliasItemNoAlias Item NumberString30
SOHistoryDetlSeqNoSales Order History Detail Sequence NumberString14
TaxClassTax ClassString2
CustomerActionCustomer ActionString1
ItemActionItem ActionString1
WarrantyCodeWarranty CodeString10
ExpirationDateExpiration DateString8
ExpirationOverriddenExpiration OverriddenString1
CostOverriddenCost OverriddenString1
CostCodeCost CodeString9
CostTypeCost TypeString1
CommentTextComment TextString2048
APDivisionNoAP Division NumberString2
VendorNoVendor NumberString7
PurchaseOrderNoPurchase Order NumberString7
PurchaseOrderRequiredDatePurchase Order Required DateString8
QuantityOrderedQuantity OrderedNumeric16.6
QuantityShippedQuantity ShippedNumeric16.6
QuantityBackorderedQuantity BackorderedNumeric16.6
MasterOriginalQtyMaster Original QuantityNumeric16.6
MasterQtyBalanceMaster Quantity BalanceNumeric16.6
MasterQtyOrderedToDateMaster Quantity Ordered To DateNumeric16.6
RepeatingQtyShippedToDateRepeating Quantity Shipped To DateNumeric16.6
UnitPriceUnit PriceNumeric16.6
UnitCostUnit CostNumeric16.6
ExtensionAmtExtension AmountNumeric12.2
UnitOfMeasureConvFactorUnit Of Measure Conversion FactorNumeric12.4
QuantityPerBillQuantity Per BillNumeric16.6
LineDiscountPercentLine Discount PercentNumeric9.3
LineWeightLine WeightNumeric12.2

AR Customer

Element NameDescriptionTypeLength
ARDivisionNoAR Division NumberString2
CustomerNoCustomer NumberString20
CustomerNameCustomer NameString30
AddressLine1Address Line 1String30
AddressLine2Address Line 2String30
AddressLine3Address Line 3String30
CityCityString20
StateStateString2
ZipCodeZip CodeString10
CountryCodeCountry CodeString3
TelephoneNoTelephone NumberString17
TelephoneExtTelephone ExtensionString5
FaxNoFax NumberString17
EmailAddressEmail AddressString250
URLAddressURL AddressString50
EBMEnabledeBusiness Manager EnabledString1
EBMConsumerUserIDeBusiness Manager Consumer User IDString15
BatchFaxBatch FaxString1
DefaultCreditCardPmtTypeDefault Credit Card Payment TypeString5
ContactCodeContact CodeString10
ShipMethodShip MethodString15
TaxScheduleTax ScheduleString9
TaxExemptNoTax Exempt NumberString15
TermsCodeTerms CodeString2
SalespersonDivisionNoSalesperson Division NumberString2
SalespersonNoSalesperson NumberString4
SalespersonDivisionNo2Salesperson Division Number 2String2
SalespersonNo2Salesperson Number 2String4
SalespersonDivisionNo3Salesperson Division Number 3String2
SalespersonNo3Salesperson Number 3String4
SalespersonDivisionNo4Salesperson Division Number 4String2
SalespersonNo4Salesperson Number 4String4
SalespersonDivisionNo5Salesperson Division Number 5String2
SalespersonNo5Salesperson Number 5String4
CommentCustomer CommentString30
SortFieldSort FieldString10
TemporaryCustomerObsolete 5.00String1
CustomerStatusCustomer StatusString1
InactiveReasonCodeInactive Reason CodeString5
OpenItemCustomerOpen Item CustomerString1
ResidentialAddressResidential AddressString1
StatementCycleStatement CycleString1
PrintDunningMessagePrint Dunning Message On StatementString1
CustomerTypeCustomer TypeString4
PriceLevelPrice LevelString1
DateLastActivityDate Of Last ActivityString8
DateLastPaymentDate Of Last PaymentString8
DateLastStatementDate Of Last StatementString8
DateLastFinanceChrgDate Of Last Finance ChargeString8
DateLastAgingDate Of Last AgingString8
DefaultItemCodeDefault Item CodeString30
DefaultCostCodeDefault Cost CodeString9
DefaultCostTypeDefault Cost TypeString1
CreditHoldCustomer On Credit HoldString1
PrimaryShipToCodePrimary Ship To CodeString4
DateEstablishedDate EstablishedString8
CreditCardGUIDSage Exchange vault credit card identifierString32
DefaultPaymentTypeDefault Payment TypeString5
EmailStatementsObsolete 4.30String1
NumberOfInvToUseInCalcNumber Of Invoices To Use In Days CalcNumeric2
AvgDaysPaymentInvoiceAvg Days For Payment From Invoice DateNumeric3
AvgDaysOverDueAvg Days Overdue (Pay Date - Due Date)Numeric3
CustomerDiscountRateCustomer Discount RateNumeric13.3
ServiceChargeRateService Charge RateNumeric13.3
CreditLimitCredit LimitNumeric14.2
LastPaymentAmtLast Payment AmountNumeric14.2
HighestStmntBalanceHighest Statement BalanceNumeric14.2
UnpaidServiceChrgUnpaid Service ChargeNumeric14.2
BalanceForwardBalance ForwardNumeric14.2
CurrentBalanceCurrent BalanceNumeric14.2
AgingCategory1Aging Category 1Numeric14.2
AgingCategory2Aging Category 2Numeric14.2
AgingCategory3Aging Category 3Numeric14.2
AgingCategory4Aging Category 4Numeric14.2
OpenOrderAmtOpen Order AmountNumeric14.2
RetentionCurrentRetention CurrentNumeric14.2
RetentionAging1Retention Aging 1Numeric14.2
RetentionAging2Retention Aging 2Numeric14.2
RetentionAging3Retention Aging 3Numeric14.2
RetentionAging4Retention Aging 4Numeric14.2
SplitCommRate2Split Commission Rate 2Numeric9.3
SplitCommRate3Split Commission Rate 3Numeric9.3
SplitCommRate4Split Commission Rate 4Numeric9.3
SplitCommRate5Split Commission Rate 5Numeric9.3
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

AR Division

Element NameDescriptionTypeLength
TermsCodeAR Terms CodeString2
TermsCodeDescTerms Code DescriptionString30
DueDateADayOfTheMonthDue Date a Day of The MonthString1
DiscountDateADayOfTheMoDiscount Date a Day of The MonthString1
DiscountCalculationMethodDiscount Calculation MethodString1
DaysBeforeDueDays Before DueNumeric3
MinimumDaysAllowedInvMinimum Days Allowed Before Invoice is DueNumeric3
DaysBeforeDiscountDueDays Before Discount DueNumeric3
MinimumDaysAllowedDiscMinimum Days Allowed Before Discount DueNumeric3
DiscountRateDiscount RateNumeric9.3
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10


Get

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

List

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

Update

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

Create

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.

Submit

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.

Delete

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.