Documentation - enhancements:sage100:modules:sde:api

SDE API Resources

Anonymous (anonymous@undisclosed.example.com) — 2021-09-07T22:54:58+00:00

SDE API Resources

Categories Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-07T14:51:35+00:00

Categories Resource

Categories are maintained in the Sage Data Exchange application. The Categories Resource returns the Category and, optionally, the Products within the Category.

Categories can also return the column names that represent the properties of the products. For example, the Category “Mens Shoes” may contain properties like “Color” and “Size”. The Category response would contain a array, “properties”, with the two values “Color” and “Size”.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/categories[?category=<category>]		Retrieve Category and, optionally, Product data for one or more Categories
list	GET	/categories		Retrieve Category and, optionally, Product data for one or more Categories

Resource Table List
Click on the table to view detail.

Element Name	Description	Type	Length
category	Category	String	64
categoryRID	Category Reference ID	String	8
categoryDescription	Category Description	String	64
categoryImage	Category Image	String	64
categoryShortDescription	Category Short Description	String	2048
categoryLongDescription	Category Long Description	String	4096
mainNavigation	Main Navigation	Numeric	1
categoryEnabled	Category Enabled	Numeric	1
parentCategory	Parent Category	String	64

Category Detail

Element Name	Description	Type	Length
categoryRID	Category Reference ID	String	8
sequence	Sequence	String	3
itemCode	Item Code	String	30
itemDescription	Item Description	String	30

Resource Methods

Get

Users and Administrators can retrieve Category data which can optionally contain the Product data within each Category. Select the columns to be returned in Return Maintenance.

List

Users and Administrators can retrieve Category data which can optionally contain the Product data within each Category. Select the columns to be returned in Return Maintenance.

CategoryTrees Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-07T14:51:47+00:00

CategoryTrees Resource

Category Trees are maintained in the Sage Data Exchange application. The Category Trees Resource returns one of the Category Trees. If the request does not specify a Category Tree, then the default Category Tree is returned. Multiple Category Trees give you the flexibility to create different experiences for different users or customers.

Unlike the other resources, this resource's return can't be modified.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	categoryTrees[?categoryTree=<categoryTree>]		Retrieve a Category Tree

Resource Table List
Click on the table to view detail.

Category Tree

Element Name	Description	Type	Length
categoryTree	Category Tree	String	32
categoryTreeRID	Category Tree Reference ID	String	8
categoryTreeDescription	Category Tree Description	String	64
defaultCategoryTree	Default Category Tree	Numeric	1

Resource Methods

Get

Users and Administrators can retrieve Category Tree.

CustomerContacts Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-07T14:48:10+00:00

CustomerContacts Resource

The Customer Contacts Resource allows read/write access to the Sage 100 Customer Contacts table for Customer linked Users, and read access to the other Resource Tables.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/customerContacts		Retrieve Customer Contact data for the currently logged in user
list	GET	/customerContacts[?ARDivisionNo=<ARDivisionNo>&vendorNo=<CustomerNo>&contactCode=<contactCode>]	Only	Administrators can retrieve data from one or many Customer Contacts
update	POST	/customerContacts[?ARDivisionNo=<ARDivisionNo>&customerNo =<CustomerNo>&contactCode=<contactCode>]	Yes	Update Customer Contact information
create	POST	/customerContacts	Only	Create a new Customer Contact

Resource Table List
Click on the table to view detail.

AR Customer Contact

Element Name	Description	Type	Length
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
ContactCode	Contact Code	String	10
ContactName	Contact Name	String	30
AddressLine1	Contact Address Line 1	String	30
AddressLine2	Contact Address Line 2	String	30
AddressLine3	Contact Address Line 3	String	30
City	Contact City	String	20
State	Contact State	String	2
ZipCode	Contact Zip Code	String	10
CountryCode	Contact Country Code	String	3
Salutation	Contact Salutation	String	10
ContactTitle	Contact Title	String	15
TelephoneNo1	Contact Telephone Number 1	String	17
TelephoneExt1	Contact Telephone Extension 1	String	5
TelephoneNo2	Contact Telephone Number 2	String	17
TelephoneExt2	Contact Telephone Extension 2	String	5
FaxNo	Fax Number	String	17
EmailAddress	Contact Email Address	String	50
ContactNotes	Contact Notes	String	256
EBMUserID	eBusiness Manager User ID	String	15
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 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

SY Country Code

Element Name	Description	Type	Length
CountryCode	Country Code	String	3
CountryName	Country Name	String	30
PhoneCode	Phone Area Code	String	3

SY ZipCode

Element Name	Description	Type	Length
ZipCode	Zip Code	String	10
City	City	String	20
StateCode	State Code	String	2
CountryCode	Country Code	String	3

Resource Methods

Get

Users can retrieve their own data from the Customer Contacts Resource. This can include data from any of the tables associated with the resource.

List

Administrators can retrieve any customer contact data from the Customer Contact Resource by specifying the ARDivisonNo, CustomerNo and ContactCode in the URI. If the Administrator leaves those three fields off the URI, then a list of all Customer Contacts is returned.

Update

The Customer Contact table can be updated through the Customer Contact Resource. Users can update their contact data, while Administrators can update any Customer Contact data.

Create

Only an Administrator can create a new Customer Contact.

Customers Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-06T17:19:08+00:00

Customers Resource

The Customers Resource allows read/write access to the Sage 100 Customer table for Customer linked Users, read access to the other Resource Tables.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/customers		Retrieve Customer data for the currently logged in User
list	GET	/customers[?ARDivisionNo=<ARDivisionNo>&customerNo=<CustomerNo>]	Only	Administrators can retrieve Customer data from one or many Customers
update	POST	/customers[?ARDivisionNo=<ARDivisionNo>&customerNo=<CustomerNo>]	Yes	Update Customer information
create	POST	/customers	Only	Create a new Customer

Resource Table List
Click on the table to view detail.

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

AR Terms Code

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

AR Customer Primary Contact

Element Name	Description	Type	Length
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
ContactCode	Contact Code	String	10
ContactName	Contact Name	String	30
AddressLine1	Contact Address Line 1	String	30
AddressLine2	Contact Address Line 2	String	30
AddressLine3	Contact Address Line 3	String	30
City	Contact City	String	20
State	Contact State	String	2
ZipCode	Contact Zip Code	String	10
CountryCode	Contact Country Code	String	3
Salutation	Contact Salutation	String	10
ContactTitle	Contact Title	String	15
TelephoneNo1	Contact Telephone Number 1	String	17
TelephoneExt1	Contact Telephone Extension 1	String	5
TelephoneNo2	Contact Telephone Number 2	String	17
TelephoneExt2	Contact Telephone Extension 2	String	5
FaxNo	Fax Number	String	17
EmailAddress	Contact Email Address	String	50
ContactNotes	Contact Notes	String	256
EBMUserID	eBusiness Manager User ID	String	15
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 Salesperson

Element Name	Description	Type	Length
SalespersonDivisionNo	Salesperson Division Number	String	2
SalespersonNo	Salesperson Number	String	4
SalespersonName	Salesperson 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 Ext	String	5
EmailAddress	Email Address	String	50
SalesManagerDivisionNo	Sales Manager AR Division Number	String	2
SalesManagerNo	Sales Manager Number	String	4
CRMUserID	CRM User ID	String	11
UserKey	User Key	String	10
CommissionRate	Salesperson Commission Rate	Numeric	9.3
SalesManagerCommRate	Sales Manager Commission 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

AR Payment Type

Element Name	Description	Type	Length
PaymentType	Payment Type	String	5
PaymentDesc	Payment Description	String	30
PaymentMethod	Payment Method	String	1
AssetAcctKey	Asset Account Key	String	9
CreditCardAccrualAcctKey	Credit Card Accrual Account Key	String	9
DefaultTransaction	DefaultTransaction	String	1
EBMInternetEnabled	eBusiness Manager Internet Enabled	String	1
CreditCardSetupTested	Credit Card Setup Tested	String	1
MerchantID	Merchant ID	String	32
DisplayAVSCVVResponse	Display AVS and CVV Response	String	1
AllowCorporateCards	Allow Corporate Cards	String	1
VirtualTerminalID	Virtual Terminal ID	String	13
MerchantKey	Merchant Key	String	13
DiscountPercentage	Discount Percentage Rate	Numeric	8.3
PerTransactionFee	Per Transaction Fee Amount	Numeric	10.2
PreAuthorizationTerm	Days Authorizations Are Valid	Numeric	5
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 Customer Credit Card

Element Name	Description	Type	Length
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
CreditCardGUID	Sage Exchange vault credit card identifier	String	32
PaymentType	Payment Type	String	5
CreditCardID	Credit Card ID	String	10
ExpirationDateYear	Expiration Date Year	String	4
ExpirationDateMonth	Expiration Date Month	String	2
CardType	Card Type	String	1
BankAccountType	Bank Account Type	String	1
CorporateCustIDPurchOrder	Corporate Customer ID / Purchase Order	String	17
CardholderName	Cardholder Name	String	30
BankName	Bank Name	String	30
AVSAddressLine1	AVS Address Line 1	String	30
AVSAddressLine2	AVS Address Line 2	String	30
AVSCity	AVS City	String	20
AVSState	AVS State	String	2
AVSCountryCode	AVS Country Code	String	3
EmailAddress	Credit Card Email Address	String	250
AVSZipCode	AVS Zip Code	String	10
CreditCardComment	Credit Card Comment	String	30
EBMEnabled	eBusiness Manager Enabled	String	1
Last4UnencryptedCreditCardNos	Last 4 Unencrypted Credit Card Numbers	String	4
Last4BankRoutingNos	Last 4 Bank Routing Numbers	String	4
Last4BankAccountNos	Last 4 Bank Account Numbers	String	4
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 BillTo SoldTo

Element Name	Description	Type	Length
SoldToDivisionNo	Sold To Division Number	String	2
SoldToCustomerNo	Sold To Customer Number	String	20
BillToDivisionNo	Bill To Division Number	String	2
BillToCustomerNo	Bill To Customer Number	String	20
CreditHold	Credit Hold	String	1
CreditLimit	Credit Limit	String	1
DefaultAddress	Default Address	String	1
CustomerPricing	Customer Pricing	String	1
TermsCode	Terms Code	String	1
UserCreatedKey	User Created Key	String	10
DateCreated	Date Created	String	8
TimeCreated	Time Created	String	8
UserUpdatedKey	User Updated Key	String	10
DateUpdated	Date Updated	String	8
TimeUpdated	Time Updated	String	8

SO Shipping Rate

Element Name	Description	Type	Length
ShippingCode	Shipping Code	String	15
ShippingCodeDesc	Shipping Code Description	String	30
FreightCalculationMethod	Freight Calculation Method	String	1
UseShipZone	Use Ship Zone	String	1
UseZipCodeAsShipZone	Use Zip Code As Ship Zone	String	1
UsePriorRangeOfZipCodes	Use Prior Range of Zip Codes	String	1
WeightCalculation	Weight Calculation	String	1
LineType	Line Type	String	1
EBMEnabled	eBusiness Manager Enabled	String	1
BaseAmt	Base Amount	Numeric	12.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

SO Customer Primary Ship To Address

Element Name	Description	Type	Length
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
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
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
BatchFax	Batch Fax	String	1
BatchEmail	Batch Email	String	1
EmailAddress	Email Address	String	50
ContactCode	Contact Code	String	10
SalespersonDivisionNo	Salesperson Division Number	String	2
SalespersonNo	Salesperson Number	String	4
WarehouseCode	Warehouse Code	String	3
TaxSchedule	Tax Schedule	String	9
ResidentialAddress	Residential Address	String	1
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

CI Inactive Reason Code

Element Name	Description	Type	Length
InactiveReasonCode	Inactive Reason Code	String	5
InactiveReasonCodeDesc	Inactive Reason Code Description	String	30
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

SY Sales Tax Schedule

Element Name	Description	Type	Length
TaxSchedule	Tax Schedule	String	9
TaxScheduleDesc	Tax Schedule Description	String	30
PrintTaxCodeOnForms	Print Tax Code On Forms	String	1

SY Sales Tax Class

Element Name	Description	Type	Length
TaxClass	Tax Class	String	2
TaxClassDesc	Tax Class Description	String	30
TaxClassType	Tax Class Type	String	1

SY Country Code

Element Name	Description	Type	Length
CountryCode	Country Code	String	3
CountryName	Country Name	String	30
PhoneCode	Phone Area Code	String	3

SY ZipCode

Element Name	Description	Type	Length
ZipCode	Zip Code	String	10
City	City	String	20
StateCode	State Code	String	2
CountryCode	Country Code	String	3

Resource Methods

Get

Users can retrieve their own data from the Customer Resource. This can include data from any of the tables associated with the resource.

List

Administrators can retrieve any Customer data from the Customer Resource by specifying an ARDivisionNo and CustomerNo in the URI. If the Administrator leaves those fields off the URI, then a list of all Customers is returned.

Update

The Customer table can be updated through the Customer Resource. Users can update their own Customer data, while Administrators can update any Customers data.

Create

Only an Administrator can create a new Customer. On a successful Create, the key values, Division Number and Customer Number, are returned.

FAQ / Notes

Anonymous (anonymous@undisclosed.example.com) — 2021-11-03T18:48:11+00:00

FAQ / Notes

This section was created to document some of the behavior in SDE.

How are Batches handled in SDE?

If Batch Entry is enabled for a data entry program in Sage 100, SDE will retrieve and assign the next batch for that data entry program. For example, if your Resource is associated with the business object “AR_Invoice_BUS”, and batches are enabled in Accounts Receivable Options, then SDE will assign the next batch number to your post.

Only one batch per day is created for a given data entry program. So if your website is creating several invoices a day through SDE, they will all be posted into a single batch. The batch will have the current date and the comment “SDE”.

What happens when a post to Sales Order contains an item that doesn't exist in Sage 100?

If the item does not exist in your Sage 100 system, then the Sales Order line will not be created. Most SDE users want to accept that line on the order though, and correct it themselves in Sales Order Entry. An option can be turned on in the SDE Configuration file, “SY106_SDE.INI”, in the MAS90\SY folder. The “convertToSpecialItem” item should be set to “true”. This will change the item being posted to a Special Item, which can be changed later.

What can I do if my customer constantly posts address lines that are longer than Sage allows?

An option can be turned on in the SDE Configuration file, “SY106_SDE.INI”, in the MAS90\SY folder. The “checkStringLength” item can be set to “true” for any field in the business objects' main table. This will change the trim the incoming string, address lines in this case, to the length allowed by Sage 100.

Overview

Anonymous (anonymous@undisclosed.example.com) — 2021-11-29T13:27:15+00:00

Overview

The Overview will cover the four developer maintenance programs in SDE, Resource, Request, Default, and Return. As you will see, it doesn't take much to start pulling data from Sage 100!

Resource Maintenance

SDE uses Sage 100 Business Objects to post data so that data integrity remains intact. Resource Maintenance creates the links to Sage 100 Business Objects. Many Resources can point to the same Sage 100 Business Object. A Resource and SDE credentials, are all you need to get a return from the SDE API.

For example, create a Resource “SalesOrders” for the “SO_SalesOrder_BUS” Sage 100 Business Object. See the image below.

Full List

Enter the Resource name “SalesOrders”, and then the Sage business Object “SO_SalesOrder_BUS”. After entering the Sage Business Object, the SDE gets all the data sources from the object and lists them in the read-only grid. The Sales Order Business Object includes Lines, which you will see in the Full List link above. Save the entry.

Next, let's request for a list of Sales Orders from SDE. We can post a JSON or XML query to SDE using a tool like Fiddler or Postman. The JSON request is listed below.

{ “user”:“admin”, “password”:“admin”, “resource”:“salesorders” }

Simple requests can also be passed in the URL, as in this example.

http://[yourDomain]:[yourPort]?user=admin&password=admin&resource=salesorders

SDE returns the key values to the entire list of Sales Orders from the Default Sage Company entered in SDE Application Setup. In fact, if no returns are created in Return Maintenance, any Resource will return the key values for each record.

{“salesorders”:[{“salesorderno”:“0000103”},{“salesorderno”:“0000104”}, … {“salesorderno”:“0000174”}]}

for Sage Developers

The Resources' Sage Business Object can be one of your custom business objects, allowing read and write access from the internet through SDE. The Data Sources listed above are directly from the Business Object. The Data Sources added by your class overrides will appear on this list, allowing read access from the internet.

Return Maintenance

Sage Data Exchange (SDE)

Products Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-06T20:10:09+00:00

Products Resource

The Products Resource allows read access to the Sage 100 Products table.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/products?itemCode=<itemCode>		Retrieve product data for one product
list	GET	/products /products?offset=<offset>&limit=<limit> /products?itemType=<1\|2\|3\|4\|5>	Only	Retrieve a list of products

Resource Table List
Click on the table to view detail.

Element Name	Description	Type	Length
category	Category	String	64
categoryRID	Category Reference ID	String	8
categoryDescription	Category Description	String	64
categoryImage	Category Image	String	64
categoryShortDescription	Category Short Description	String	2048
categoryLongDescription	Category Long Description	String	4096
mainNavigation	Main Navigation	Numeric	1
categoryEnabled	Category Enabled	Numeric	1
parentCategory	Parent Category	String	64

CI Item

Element Name	Description	Type	Length
ItemCode	Item Code	String	30
ItemType	Item Type	String	1
ItemCodeDesc	Item Code Description	String	30
ExtendedDescriptionKey	Extended Description Key	String	10
UseInAR	Use In AR	String	1
UseInSO	Use In SO	String	1
UseInPO	Use In PO	String	1
UseInBM	Use In BM	String	1
CalculateCommission	Calculate Commission	String	1
DropShip	Drop Ship	String	1
EBMEnabled	eBusiness Manager Enabled	String	1
AllowBackOrders	Allow Back Orders	String	1
AllowReturns	Allow Returns	String	1
PriceCode	Price Code	String	4
AllowTradeDiscount	Allow Trade Discount	String	1
PrintReceiptLabels	Print Receipt Labels	String	1
AllocateLandedCost	Allocate Landed Cost	String	1
InactiveItem	Inactive Item	String	1
ConfirmCostIncrInRcptOfGoods	Confirm Cost Increase in Receipt Of Goods	String	1
WarrantyCode	Warranty Code	String	10
SalesUnitOfMeasure	Sales Unit of Measure	String	4
PurchaseUnitOfMeasure	Purchase Unit of Measure	String	4
StandardUnitOfMeasure	Standard Unit of Measure	String	4
PostToGLByDivision	Post to G/L By Division	String	1
SalesAcctKey	Sales Account Key	String	9
CostOfGoodsSoldAcctKey	Cost Of Goods Sold Account Key	String	9
InventoryAcctKey	Inventory Account Key	String	9
PurchaseAcctKey	Purchase Account Key	String	9
ManufacturingCostAcctKey	Manufacturing Cost Account Key	String	9
TaxClass	Tax Class	String	2
PurchasesTaxClass	Purchases Tax Class	String	2
ProductLine	Product Line	String	4
ProductType	Product Type	String	1
Valuation	Valuation	String	1
DefaultWarehouseCode	Default Warehouse Code	String	3
PrimaryAPDivisionNo	Primary AP Division Number	String	2
PrimaryVendorNo	Primary Vendor Number	String	7
ImageFile	Image File	String	30
LastSoldDate	Last Sold Date	String	8
LastReceiptDate	Last Receipt Date	String	8
Category1	Category 1	String	10
Category2	Category 2	String	10
Category3	Category 3	String	10
Category4	Category 4	String	10
SalesPromotionCode	Sales Promotion Code	String	10
SaleStartingDate	Sale Starting Date	String	8
SaleEndingDate	Sale Ending Date	String	8
SaleMethod	Sale Method	String	1
ExplodeKitItems	Explode Kit Items	String	1
ShipWeight	Ship Weight	String	10
CommentText	Comment Text	String	2048
RestockingMethod	Restocking Method	String	1
NextLotSerialNo	Next Lot/Serial Number	String	15
InventoryCycle	Inventory Cycle	String	1
RoutingNo	Routing Number	String	20
ProcurementType	Procurement Type	String	1
PlannerCode	Planner Code	String	3
BuyerCode	Buyer Code	String	3
LowLevelCode	Low Level Code	String	2
PlannedByMRP	Planned By Mrp	String	1
VendorItemCode	Vendor Item Code	String	30
SetupCharge	Setup Charge	String	1
AttachmentFileName	Attachment File Name	String	30
ItemImageWidthInPixels	Item Image Width In Pixels	Numeric	4
ItemImageHeightInPixels	Item Image Height In Pixels	Numeric	4
StandardUnitCost	Standard Unit Cost	Numeric	16.6
StandardUnitPrice	Standard Unit Price	Numeric	16.6
LastTotalUnitCost	Last Total Unit Cost	Numeric	16.6
AverageUnitCost	Average Unit Cost	Numeric	16.6
SalesPromotionPrice	Sales Promotion Price	Numeric	16.6
SuggestedRetailPrice	Suggested Retail Price	Numeric	16.6
SalesPromotionDiscountPercent	Sales Promotion Discount Percentage	Numeric	12.3
TotalQuantityOnHand	Total Quantity On Hand	Numeric	16.6
AverageBackOrderFillDays	Average Back Order Fill Days	Numeric	5
LastAllocatedUnitCost	Last Allocated Unit Cost	Numeric	16.6
CommissionRate	Commission Rate	Numeric	9.3
BaseCommAmt	Base Commission Amount	Numeric	12.2
PurchaseUMConvFctr	Purchase Unit of Measure Conversion Factor	Numeric	12.4
SalesUMConvFctr	Sales Unit of Measure Conversion Factor	Numeric	12.4
Volume	Volume	Numeric	11.4
RestockingCharge	Restocking Charge	Numeric	11.3
TotalInventoryValue	Total Inventory Value	Numeric	15.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

CI Extended Description

Element Name	Description	Type	Length
ExtendedDescriptionKey	Extended Description Key	String	10
ExtendedDescriptionText	Extended Description Text	String	4096
CreationModuleCode	Creation Module Code	String	3
UpdatedModuleCode	Updated Module Code	String	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

IM Warehouse

Element Name	Description	Type	Length
WarehouseCode	Warehouse Code	String	3
WarehouseDesc	Warehouse Description	String	30
WarehouseName	Warehouse Name	String	30
WarehouseAddress1	Warehouse Address Line 1	String	30
WarehouseAddress2	Warehouse Address Line 2	String	30
WarehouseAddress3	Warehouse Address Line 3	String	30
WarehouseCity	Warehouse City	String	20
WarehouseState	Warehouse State	String	2
WarehouseZipCode	Warehouse Zip Code	String	10
WarehouseCountryCode	Warehouse Country Code	String	3
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
EmailAddress	Email Address	String	50
ContactName	Contact Name	String	30
PostToGLSubAcct	Post To G/L Sub Account	String	15
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

AP Vendor Contact

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
ContactCode	Contact Code	String	10
ContactName	Contact Name	String	30
AddressLine1	Contact Address Line 1	String	30
AddressLine2	Contact Address Line 2	String	30
AddressLine3	Contact Address Line 3	String	30
City	Contact City	String	20
State	Contact State	String	2
ZipCode	Contact Zip Code	String	10
CountryCode	Contact Country Code	String	3
Salutation	Contact Salutation	String	10
ContactTitle	Contact Title	String	15
TelephoneNo1	Contact Telephone Number 1	String	17
TelephoneExt1	Contact Telephone Extension 1	String	5
TelephoneNo2	Contact Telephone Number 2	String	17
TelephoneExt2	Contact Telephone Extension 2	String	5
FaxNo	Fax Number	String	17
EmailAddress	Contact Email Address	String	50
ContactNotes	Contact Notes	String	256
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

AP Division

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
APDivisionDesc	AP Division Description	String	30
AccountsPayableAcctKey	Accounts Payable Account Key	String	9
DiscountsEarnedOrTakenAcctKey	Discounts Earned Or Taken Account Key	String	9
CashAcctKey	Cash Account Key	String	9
DiscountsLostAcctKey	Discounts Lost Account Key	String	9
RetentionPayableAcctKey	Retention Payable Account Key	String	9
FreightAcctKey	Freight Account Key	String	9
SalesTaxAcctKey	Sales Tax Account Key	String	9
NonRecoverableTaxAcctKey	Non-Recoverable Tax Account Key	String	9
UseTaxAcctKey	Use Tax Account Key	String	9
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
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

IM Warranty Code

Element Name	Description	Type	Length
WarrantyCode	Warranty Code	String	10
WarrantyCodeDesc	Warranty Code Description	String	30
WarrantyDays	Warranty Days	Numeric	4
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

IM Product Line

Element Name	Description	Type	Length
ProductLine	Product Line	String	4
ProductLineDesc	Product Line Description	String	25
ProductType	Product Type	String	1
Valuation	Valuation	String	1
PriceCode	Price Code	String	4
AllowBackOrders	Allow Back Orders	String	1
ExplodeKitItems	Explode Kit Items	String	1
CalculateCommission	Calculate Commission	String	1
StandardUnitOfMeasure	Standard Unit Of Measure	String	4
PurchaseUnitOfMeasure	Purchase Unit Of Measure	String	4
SalesUnitOfMeasure	Sales Unit Of Measure	String	4
ProcurementType	Procurement Type	String	1
InventoryCycle	Inventory Cycle	String	1
AllowTradeDiscount	Allow Trade Discount	String	1
InactiveItem	Inactive Item	String	1
AllocateLandedCost	Allocate Landed Cost	String	1
TaxClass	Tax Class	String	2
PurchasesTaxClass	PurchasesTax Class	String	2
PrintReceiptLabels	Print Receipt Labels	String	1
ConfirmCostIncrInRcptOfGoods	Confirm Cost Increase In Receipt Of Goods	String	1
PostInventoryByWhse	Post Inventory By Warehouse	String	1
PostCostOfGoodsSoldByWhse	Post Cost Of Goods Sold By Warehouse	String	1
PostSalesIncomeByWhse	Post Sales/Income By Warehouse	String	1
PostReturnsByWhse	Post Returns By Warehouse	String	1
PostAdjustmentByWhse	Post Adjustment By Warehouse	String	1
PostPurchaseByWhse	Post Purchases By Warehouse	String	1
PostPOVarianceByWhse	Post Po Variance By Warehouse	String	1
PostMFGVarianceByWhse	Post Manufacturing Variance By Warehouse	String	1
InventoryAcctKey	Inventory Account Key	String	9
CostOfGoodsSoldAcctKey	Cost Of Goods Sold Account Key	String	9
SalesIncomeAcctKey	Sales Income Account Key	String	9
ReturnsAcctKey	Returns Account Key	String	9
AdjustmentAcctKey	Adjustment Account Key	String	9
PurchaseAcctKey	Purchase Account Key	String	9
PurchaseOrderVarianceAcctKey	Purchase Order Variance Account Key	String	9
ManufacturingVarianceAcctKey	Manufacturing Variance Account Key	String	9
WarrantyCode	Warranty Code	String	10
AllowReturns	Allow Returns	String	1
RestockingMethod	Restocking Method	String	1
ScrapAcctKey	Scrap Account Key	String	9
RepairsInProcessAcctKey	Repairs In Process Account Key	String	9
RepairsClearingAcctKey	Repairs Clearing Account Key	String	9
PostScrapByWhse	Post Scrap by Warehouse	String	1
PostRepairsInProcessByWhse	Post Repairs In Process by Warehouse	String	1
PostRepairsClearingByWhse	Post Repairs Clearing by Warehouse	String	1
CommissionRate	Commission Rate	Numeric	9.3
BaseCommAmt	Base Commission Amount	Numeric	12.2
PurchaseUMConvFctr	Purchase Unit Of Measure Conversion Factor	Numeric	12.4
SalesUMConvFctr	Sales Unit Of Measure Conversion Factor	Numeric	12.4
RestockingCharge	Restocking Charge	Numeric	11.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

IM Price Code

Element Name	Description	Type	Length
PriceCodeRecord	Price Code Record	String	1
PriceCode	Price Code	String	4
ItemCode	Item Code	String	30
CustomerPriceLevel	Customer Price Level	String	1
ARDivisionNo	AR Division Number	String	2
CustomerNo	Customer Number	String	20
PriceCodeDesc	Price Code Description	String	25
PricingMethod	Pricing Method	String	1
BreakQuantity1	Break Quantity 1	Numeric	8
BreakQuantity2	Break Quantity 2	Numeric	8
BreakQuantity3	Break Quantity 3	Numeric	8
BreakQuantity4	Break Quantity 4	Numeric	8
BreakQuantity5	Break Quantity 5	Numeric	8
DiscountMarkup1	Discount Markup 1	Numeric	16.6
DiscountMarkup2	Discount Markup 2	Numeric	16.6
DiscountMarkup3	Discount Markup 3	Numeric	16.6
DiscountMarkup4	Discount Markup 4	Numeric	16.6
DiscountMarkup5	Discount Markup 5	Numeric	16.6
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

IM Buyer Planner Code

Element Name	Description	Type	Length
BuyerPlannerCode	Buyer Planner Code	String	3
LastName	Last Name	String	30
FirstName	First Name	String	20
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

IM Sales Promotion

Element Name	Description	Type	Length
SalesPromotionCode	Sales Promotion Code	String	10
SaleStartingDate	Sale Starting Date	String	8
SaleEndingDate	Sale Ending Date	String	8
SaleMethod	Sale Method	String	1
SalePrice	Sale Price	Numeric	16.6
DiscountPercentage	Discount Percentage	Numeric	11.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

IM Item Vendor

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
VendorName	Vendor 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
PrimaryContact	Primary Contact Code	String	10
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
TermsCode	Terms Code	String	2
Reference	Vendor Reference Number	String	15
TemporaryVendor	Obsolete 5.00	String	1
VendorStatus	Vendor Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
CreditCardVendor	Credit Card Vendor	String	1
HoldPayment	Hold Payment	String	1
ElectronicPayment	Electronic Payment Vendor	String	1
StandardEntryClass	Standard Entry Class Code	String	3
ExemptionNoOnFile	Exemption Number On File	String	1
TaxSchedule	Tax Schedule	String	9
TaxClass	Tax Class	String	2
AccountKey	Account Key	String	9
SeparateCheck	Separate Check	String	1
Comment	Vendor Comment	String	30
Sort	Sort Field	String	10
BatchFax	Batch Fax	String	1
UsePOReceiptOfInvForVendor	Use PO Receipt Of Inv For Vendor	String	1
PrimaryPurchaseAddressCode	Purchase Address Code	String	4
VendorType	Vendor Type	String	1
Form1099	Default 1099 Form	String	1
TaxpayerIDSocialSecurityNo	Taxpayer ID/Social Security Number	String	9
Box1099	Default 1099 Box	String	3
MiscBox9	Mark Misc Box 9	String	1
LastPurchaseDate	Last Purchase Date	String	8
LastPaymentDate	Last Payment Date	String	8
LastCheckNo	Last AP Check Number	String	10
LastCheckAmt	Last Check Amount	Numeric	15.2
RetentionRate	Retention Rate	Numeric	7.2
AverageDaysToPay	Average Days To Pay	Numeric	3
AverageDaysOverDue	Average Days Over Due	Numeric	3
BalanceDue	Balance Due	Numeric	16.2
NumberOfInvToUseInCalc	Number Of Invoices To Use In Calculation	Numeric	7
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

GL Account

Element Name	Description	Type	Length
AccountKey	Account Number	String	9
AccountDesc	Account Description	String	50
Account	Fully Formatted Account Number	String	41
RawAccount	Unformatted Account Number	String	32
MainAccountCode	Main Account	String	15
DateStart	Start Date	String	8
DateEnd	End Date	String	8
Status	Status	String	1
ClearBalance	Clear Balance	String	1
AccountType	Account Type	String	2
CashFlowsType	Cash Flows Type	String	1
RollupCode1	Rollup Code 1	String	20
RollupCode2	Rollup Code 2	String	20
RollupCode3	Rollup Code 3	String	20
RollupCode4	Rollup Code 4	String	20
AccountGroup	Account Group	String	15
AccountCategory	Account Category	String	1
CompanyCode	Company Code	String	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

AP Division

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
APDivisionDesc	AP Division Description	String	30
AccountsPayableAcctKey	Accounts Payable Account Key	String	9
DiscountsEarnedOrTakenAcctKey	Discounts Earned Or Taken Account Key	String	9
CashAcctKey	Cash Account Key	String	9
DiscountsLostAcctKey	Discounts Lost Account Key	String	9
RetentionPayableAcctKey	Retention Payable Account Key	String	9
FreightAcctKey	Freight Account Key	String	9
SalesTaxAcctKey	Sales Tax Account Key	String	9
NonRecoverableTaxAcctKey	Non-Recoverable Tax Account Key	String	9
UseTaxAcctKey	Use Tax Account Key	String	9
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
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AP Vendor

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
VendorName	Vendor 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
PrimaryContact	Primary Contact Code	String	10
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
TermsCode	Terms Code	String	2
Reference	Vendor Reference Number	String	15
TemporaryVendor	Obsolete 5.00	String	1
VendorStatus	Vendor Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
CreditCardVendor	Credit Card Vendor	String	1
HoldPayment	Hold Payment	String	1
ElectronicPayment	Electronic Payment Vendor	String	1
StandardEntryClass	Standard Entry Class Code	String	3
ExemptionNoOnFile	Exemption Number On File	String	1
TaxSchedule	Tax Schedule	String	9
TaxClass	Tax Class	String	2
AccountKey	Account Key	String	9
SeparateCheck	Separate Check	String	1
Comment	Vendor Comment	String	30
Sort	Sort Field	String	10
BatchFax	Batch Fax	String	1
UsePOReceiptOfInvForVendor	Use PO Receipt Of Inv For Vendor	String	1
PrimaryPurchaseAddressCode	Purchase Address Code	String	4
VendorType	Vendor Type	String	1
Form1099	Default 1099 Form	String	1
TaxpayerIDSocialSecurityNo	Taxpayer ID/Social Security Number	String	9
Box1099	Default 1099 Box	String	3
MiscBox9	Mark Misc Box 9	String	1
LastPurchaseDate	Last Purchase Date	String	8
LastPaymentDate	Last Payment Date	String	8
LastCheckNo	Last AP Check Number	String	10
LastCheckAmt	Last Check Amount	Numeric	15.2
RetentionRate	Retention Rate	Numeric	7.2
AverageDaysToPay	Average Days To Pay	Numeric	3
AverageDaysOverDue	Average Days Over Due	Numeric	3
BalanceDue	Balance Due	Numeric	16.2
NumberOfInvToUseInCalc	Number Of Invoices To Use In Calculation	Numeric	7
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8

SY Sales Tax Class

Element Name	Description	Type	Length
TaxClass	Tax Class	String	2
TaxClassDesc	Tax Class Description	String	30
TaxClassType	Tax Class Type	String	1

Resource Methods

Get

Users and Administrators can retrieve data for a single Product. This can include data from any of the tables associated with the resource.

List

Users and Administrators can retrieve all product data from the Products Resource. The return can be limited to a number of products by specifying the Limit and Offset. The return can also be limited by passing any non-key column to the resource.

SalesOrders Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-07T14:52:01+00:00

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

Resource Methods

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.

Overview

Anonymous (anonymous@undisclosed.example.com) — 2020-07-29T14:38:56+00:00

Overview

The Users Resource allows read/write access to the Sage Data Exchange User table and for Customer and Vendor linked Users, read access to several Sage 100 ERP tables. Administrators have no direct link to a Customer or Vendor, so only User table columns are returned for Administrators. Data can be posted to the Sage Data Exchange User table and retrieved from any of the Resource Tables listed.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/users		Retrieve user data for the currently logged in user.
list	GET	/users[?user=<user>]	Only	Administrators can retrieve data from one or many users.
login	POST	/users?method=login		Log into the Sage Data Exchange API
update	POST	/users?method=update&user=<user>	Yes	Update user information
deactivate	POST	/users?method=deactivate&user=<user>	Only	Change an exiting user to Inactive
activate	POST	/users?method=activate&user=<user>	Only	Change an exiting user to Active

Resource Table List
Click on the table to view detail.

User

Element Name	Description	Type	Length
user	User	String	32
userRID	User Reference ID	String	8
userName	User Name	String	64
emailAddress	Email Address	String	128
password	Password	String	32
userType	User Type	String	1
status	Status	String	1
ARDivisionNo	AR Division Number	String	2
customerNo	Customer Number	String	20
customerContactCode	Customer Contact Code	String	10
APDivisionNo	AP Division Number	String	2
vendorNo	Vendor Number	String	7
vendorContactCode	Vendor Contact Code	String	10

Resource Methods

Get

Users can retrieve their own data from the Users Resource. Select the columns to be returned in Return Maintenance. Optionally, the Login resource can return the Sage 100 columns selected in Return Maintenance for the CustomerContacts or VendorContacts Resources.

List

Administrators can retrieve any users data from the Users Resource by specifying a user in the URI. If the Administrator leaves the user field off the URI, then a list of all users, not administrators, is returned.

The client must provide credentials In order to access the Sage Data Exchange API. The Users Login method requires the method name in the URI and the User and Password in the document passed. (The User and Password can also be provided on the URI.) Optionally, the Login resource can return the Sage 100 columns selected in Return Maintenance for the CustomerContacts or VendorContacts Resources. A successful login returns a GUID that is used in every subsequent conversation with the API. In addition, the columns selected in Return Maintenance for the Users resource are returned. Optionally, the Login resource can return the Sage 100 columns selected in Return Maintenance for the CustomerContacts or VendorContacts Resources. A failed login attempt will return an HTTP Error 401, Unauthorized.

Update

Users can update their own data, while Administrators can update any users data.

Create

Only an Administrator can create a new User.

Deactivate

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 API.

Activate

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

VendorContacts Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-07T14:47:58+00:00

VendorContacts Resource

The Vendor Contacts Resource allows read/write access to the Sage 100 Vendor Contacts table for Vendor linked Users, and read access to the other Resource Tables.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/vendorContacts		Retrieve Vendor data for the currently logged in User
list	GET	/vendorContacts[?APDivisionNo=<APDivisionNo>&vendorNo=<VendorNo>&contactCode=<contactCode>]	Only	Administrators can retrieve Vendor data from one or many Vendors
update	POST	/vendorContacts[?APDivisionNo=<APDivisionNo>&vendorNo=<VendorNo>&contactCode=<contactCode>]	Yes	Update Vendor information
create	POST	/vendors	Only	Create a new Vendor

Resource Table List
Click on the table to view detail.

AP Vendor Contact

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
ContactCode	Contact Code	String	10
ContactName	Contact Name	String	30
AddressLine1	Contact Address Line 1	String	30
AddressLine2	Contact Address Line 2	String	30
AddressLine3	Contact Address Line 3	String	30
City	Contact City	String	20
State	Contact State	String	2
ZipCode	Contact Zip Code	String	10
CountryCode	Contact Country Code	String	3
Salutation	Contact Salutation	String	10
ContactTitle	Contact Title	String	15
TelephoneNo1	Contact Telephone Number 1	String	17
TelephoneExt1	Contact Telephone Extension 1	String	5
TelephoneNo2	Contact Telephone Number 2	String	17
TelephoneExt2	Contact Telephone Extension 2	String	5
FaxNo	Fax Number	String	17
EmailAddress	Contact Email Address	String	50
ContactNotes	Contact Notes	String	256
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

AP Vendor

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
VendorName	Vendor 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
PrimaryContact	Primary Contact Code	String	10
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
TermsCode	Terms Code	String	2
Reference	Vendor Reference Number	String	15
TemporaryVendor	Obsolete 5.00	String	1
VendorStatus	Vendor Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
CreditCardVendor	Credit Card Vendor	String	1
HoldPayment	Hold Payment	String	1
ElectronicPayment	Electronic Payment Vendor	String	1
StandardEntryClass	Standard Entry Class Code	String	3
ExemptionNoOnFile	Exemption Number On File	String	1
TaxSchedule	Tax Schedule	String	9
TaxClass	Tax Class	String	2
AccountKey	Account Key	String	9
SeparateCheck	Separate Check	String	1
Comment	Vendor Comment	String	30
Sort	Sort Field	String	10
BatchFax	Batch Fax	String	1
UsePOReceiptOfInvForVendor	Use PO Receipt Of Inv For Vendor	String	1
PrimaryPurchaseAddressCode	Purchase Address Code	String	4
VendorType	Vendor Type	String	1
Form1099	Default 1099 Form	String	1
TaxpayerIDSocialSecurityNo	Taxpayer ID/Social Security Number	String	9
Box1099	Default 1099 Box	String	3
MiscBox9	Mark Misc Box 9	String	1
LastPurchaseDate	Last Purchase Date	String	8
LastPaymentDate	Last Payment Date	String	8
LastCheckNo	Last AP Check Number	String	10
LastCheckAmt	Last Check Amount	Numeric	15.2
RetentionRate	Retention Rate	Numeric	7.2
AverageDaysToPay	Average Days To Pay	Numeric	3
AverageDaysOverDue	Average Days Over Due	Numeric	3
BalanceDue	Balance Due	Numeric	16.2
NumberOfInvToUseInCalc	Number Of Invoices To Use In Calculation	Numeric	7
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8

AP Division

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
APDivisionDesc	AP Division Description	String	30
AccountsPayableAcctKey	Accounts Payable Account Key	String	9
DiscountsEarnedOrTakenAcctKey	Discounts Earned Or Taken Account Key	String	9
CashAcctKey	Cash Account Key	String	9
DiscountsLostAcctKey	Discounts Lost Account Key	String	9
RetentionPayableAcctKey	Retention Payable Account Key	String	9
FreightAcctKey	Freight Account Key	String	9
SalesTaxAcctKey	Sales Tax Account Key	String	9
NonRecoverableTaxAcctKey	Non-Recoverable Tax Account Key	String	9
UseTaxAcctKey	Use Tax Account Key	String	9
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
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

SY Country Code

Element Name	Description	Type	Length
CountryCode	Country Code	String	3
CountryName	Country Name	String	30
PhoneCode	Phone Area Code	String	3

SY ZipCode

Element Name	Description	Type	Length
ZipCode	Zip Code	String	10
City	City	String	20
StateCode	State Code	String	2
CountryCode	Country Code	String	3

Resource Methods

Get

Users can retrieve their own data from the Vendor Contacts Resource. This can include data from any of the tables associated with the resource.

List

Administrators can retrieve any vendor contact data from the Vendor Contact Resource by specifying the APDivisonNo, VendorNo and ContactCode in the URI. If the Administrator leaves those three fields off the URI, then a list of all Vendor Contacts is returned.

Update

Only the Vendor Contact table can be updated through the Vendor Contact Resource. Users can update their contact data, while Administrators can update any Vendor Contact data.

Create

Only an Administrator can create a new Vendor Contact.

Vendors Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-06T17:18:34+00:00

Vendors Resource

The Vendors Resource allows read/write access to the Sage 100 Vendor table for Vendor linked Users, read access to the other Resource Tables.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/vendors		Retrieve Vendor data for the currently logged in User
list	GET	/vendors[?APDivisionNo=<APDivisionNo>&vendorNo=<VendorNo>]	Only	Administrators can retrieve Vendor data from one or many Vendors
update	POST	/vendors[?APDivisionNo=<APDivisionNo>&vendorNo=<VendorNo>]	Yes	Update Vendor information
create	POST	/vendors	Only	Create a new Vendor

Resource Table List
Click on the table to view detail.

AP Vendor

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
VendorName	Vendor 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
PrimaryContact	Primary Contact Code	String	10
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
TermsCode	Terms Code	String	2
Reference	Vendor Reference Number	String	15
TemporaryVendor	Obsolete 5.00	String	1
VendorStatus	Vendor Status	String	1
InactiveReasonCode	Inactive Reason Code	String	5
CreditCardVendor	Credit Card Vendor	String	1
HoldPayment	Hold Payment	String	1
ElectronicPayment	Electronic Payment Vendor	String	1
StandardEntryClass	Standard Entry Class Code	String	3
ExemptionNoOnFile	Exemption Number On File	String	1
TaxSchedule	Tax Schedule	String	9
TaxClass	Tax Class	String	2
AccountKey	Account Key	String	9
SeparateCheck	Separate Check	String	1
Comment	Vendor Comment	String	30
Sort	Sort Field	String	10
BatchFax	Batch Fax	String	1
UsePOReceiptOfInvForVendor	Use PO Receipt Of Inv For Vendor	String	1
PrimaryPurchaseAddressCode	Purchase Address Code	String	4
VendorType	Vendor Type	String	1
Form1099	Default 1099 Form	String	1
TaxpayerIDSocialSecurityNo	Taxpayer ID/Social Security Number	String	9
Box1099	Default 1099 Box	String	3
MiscBox9	Mark Misc Box 9	String	1
LastPurchaseDate	Last Purchase Date	String	8
LastPaymentDate	Last Payment Date	String	8
LastCheckNo	Last AP Check Number	String	10
LastCheckAmt	Last Check Amount	Numeric	15.2
RetentionRate	Retention Rate	Numeric	7.2
AverageDaysToPay	Average Days To Pay	Numeric	3
AverageDaysOverDue	Average Days Over Due	Numeric	3
BalanceDue	Balance Due	Numeric	16.2
NumberOfInvToUseInCalc	Number Of Invoices To Use In Calculation	Numeric	7
DateCreated	Creation Date	String	8
TimeCreated	Creation Time	String	8
UserCreatedKey	Creation User ID	String	10
DateUpdated	Last Update Date	String	8

AP Division

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
APDivisionDesc	AP Division Description	String	30
AccountsPayableAcctKey	Accounts Payable Account Key	String	9
DiscountsEarnedOrTakenAcctKey	Discounts Earned Or Taken Account Key	String	9
CashAcctKey	Cash Account Key	String	9
DiscountsLostAcctKey	Discounts Lost Account Key	String	9
RetentionPayableAcctKey	Retention Payable Account Key	String	9
FreightAcctKey	Freight Account Key	String	9
SalesTaxAcctKey	Sales Tax Account Key	String	9
NonRecoverableTaxAcctKey	Non-Recoverable Tax Account Key	String	9
UseTaxAcctKey	Use Tax Account Key	String	9
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
TimeUpdated	Last Update Time	String	8
UserUpdatedKey	Last Update User ID	String	10

AP Terms Code

Element Name	Description	Type	Length
TermsCode	Terms Code	String	2
TermsCodeDesc	Terms Code Description	String	30
DaysBeforeDue	Days Before Due	Numeric	3
DueDateADayOfTheMonth	Day Of The Month Due Date	String	1
MinimumDaysAllowedInv	Minimum Days Allowed Before Invoice Due	Numeric	3
DaysDiscountAllowed	Days Discount Allowed	Numeric	3
DiscountDateADayOfTheMo	Day Of The Month Discount Date	String	1
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

AP Vendor Primary Contact

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
ContactCode	Contact Code	String	10
ContactName	Contact Name	String	30
AddressLine1	Contact Address Line 1	String	30
AddressLine2	Contact Address Line 2	String	30
AddressLine3	Contact Address Line 3	String	30
City	Contact City	String	20
State	Contact State	String	2
ZipCode	Contact Zip Code	String	10
CountryCode	Contact Country Code	String	3
Salutation	Contact Salutation	String	10
ContactTitle	Contact Title	String	15
TelephoneNo1	Contact Telephone Number 1	String	17
TelephoneExt1	Contact Telephone Extension 1	String	5
TelephoneNo2	Contact Telephone Number 2	String	17
TelephoneExt2	Contact Telephone Extension 2	String	5
FaxNo	Fax Number	String	17
EmailAddress	Contact Email Address	String	50
ContactNotes	Contact Notes	String	256
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

CI Inactive Reason Code

Element Name	Description	Type	Length
InactiveReasonCode	Inactive Reason Code	String	5
InactiveReasonCodeDesc	Inactive Reason Code Description	String	30
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

PO Vendor Primary Purchase Address

Element Name	Description	Type	Length
APDivisionNo	AP Division Number	String	2
VendorNo	Vendor Number	String	7
PurchaseAddressCode	Purchase Address Code	String	4
PurchaseName	Purchase Name	String	30
PurchaseAddress1	Purchase Address 1	String	30
PurchaseAddress2	Purchase Address 2	String	30
PurchaseAddress3	Purchase Address 3	String	30
PurchaseCity	Purchase City	String	20
PurchaseState	Purchase State	String	2
PurchaseZipCode	Purchase Zip Code	String	10
PurchaseCountryCode	Purchase Country Code	String	3
BatchFax	Batch Fax	String	1
TelephoneNo	Telephone Number	String	17
TelephoneExt	Telephone Extension	String	5
FaxNo	Fax Number	String	17
ContactCode	Contact Code	String	10
TaxSchedule	Tax Schedule	String	9
ExemptionNoOnFile	Exemption Number On File	String	1
EmailAddress	Email Address	String	50
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

GL Account

Element Name	Description	Type	Length
AccountKey	Account Number	String	9
AccountDesc	Account Description	String	50
Account	Fully Formatted Account Number	String	41
RawAccount	Unformatted Account Number	String	32
MainAccountCode	Main Account	String	15
DateStart	Start Date	String	8
DateEnd	End Date	String	8
Status	Status	String	1
ClearBalance	Clear Balance	String	1
AccountType	Account Type	String	2
CashFlowsType	Cash Flows Type	String	1
RollupCode1	Rollup Code 1	String	20
RollupCode2	Rollup Code 2	String	20
RollupCode3	Rollup Code 3	String	20
RollupCode4	Rollup Code 4	String	20
AccountGroup	Account Group	String	15
AccountCategory	Account Category	String	1
CompanyCode	Company Code	String	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

SY Sales Tax Schedule

Element Name	Description	Type	Length
TaxSchedule	Tax Schedule	String	9
TaxScheduleDesc	Tax Schedule Description	String	30
PrintTaxCodeOnForms	Print Tax Code On Forms	String	1

SY Sales Tax Class

Element Name	Description	Type	Length
TaxClass	Tax Class	String	2
TaxClassDesc	Tax Class Description	String	30
TaxClassType	Tax Class Type	String	1

SY Country Code

Element Name	Description	Type	Length
CountryCode	Country Code	String	3
CountryName	Country Name	String	30
PhoneCode	Phone Area Code	String	3

SY ZipCode

Element Name	Description	Type	Length
ZipCode	Zip Code	String	10
City	City	String	20
StateCode	State Code	String	2
CountryCode	Country Code	String	3

Resource Methods

Get

Users can retrieve their own data from the Vendor Resource. This can include data from any of the tables associated with the resource.

List

Administrators can retrieve any Vendor data from the Vendor Resource by specifying an APDivisionNo and VendorNo in the URI. If the Administrator leaves those fields off the URI, then a list of all Vendors is returned.

Update

The Vendor table can be updated through the Vendor Resource. Users can update their own Vendor data, while Administrators can update any Vendors data.

Create

Only an Administrator can create a new Vendor. On a successful Create, the key values, Division Number and Vendor Number, are returned.

ZipCodes Resource

Anonymous (anonymous@undisclosed.example.com) — 2018-12-07T15:04:54+00:00

ZipCodes Resource

The ZipCode Resource allows read access to the Sage 100 Zip Code table.

Resource Method List
Action	HTTP	URI	Admin?	Description
get	GET	/zipcodes?zipcode=<zipCode>		Retrieve ZipCode data for one ZipCode
list	GET	/zipcodes		Retrieve a list of ZipCodes

Resource Table List
Click on the table to view detail.

SY ZipCode

Element Name	Description	Type	Length
ZipCode	Zip Code	String	10
City	City	String	20
StateCode	State Code	String	2
CountryCode	Country Code	String	3

SY Country Code

Element Name	Description	Type	Length
CountryCode	Country Code	String	3
CountryName	Country Name	String	30
PhoneCode	Phone Area Code	String	3

Resource Methods

Get

Users and Administrators can retrieve information on a single ZipCode. This can include data from any of the tables associated with the resource.

List

Users and Administrators can retrieve information on all ZipCodes using the ZipCodes Resource.