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

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

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.

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

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