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
ActionHTTPURIAdmin?Description
getGET/customersRetrieve Customer data for the currently logged in User
listGET/customers[?ARDivisionNo=<ARDivisionNo>&customerNo=<CustomerNo>]OnlyAdministrators can retrieve Customer data from one or many Customers
updatePOST/customers[?ARDivisionNo=<ARDivisionNo>&customerNo=<CustomerNo>]YesUpdate Customer information
createPOST/customersOnlyCreate a new Customer

Resource Table List
Click on the table to view detail.

AR Customer

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

AR Division

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

AR Terms Code

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

AR Customer Primary Contact

Element NameDescriptionTypeLength
ARDivisionNoAR Division NumberString2
CustomerNoCustomer NumberString20
ContactCodeContact CodeString10
ContactNameContact NameString30
AddressLine1Contact Address Line 1String30
AddressLine2Contact Address Line 2String30
AddressLine3Contact Address Line 3String30
CityContact CityString20
StateContact StateString2
ZipCodeContact Zip CodeString10
CountryCodeContact Country CodeString3
SalutationContact SalutationString10
ContactTitleContact TitleString15
TelephoneNo1Contact Telephone Number 1String17
TelephoneExt1Contact Telephone Extension 1String5
TelephoneNo2Contact Telephone Number 2String17
TelephoneExt2Contact Telephone Extension 2String5
FaxNoFax NumberString17
EmailAddressContact Email AddressString50
ContactNotesContact NotesString256
EBMUserIDeBusiness Manager User IDString15
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

AR Salesperson

Element NameDescriptionTypeLength
SalespersonDivisionNoSalesperson Division NumberString2
SalespersonNoSalesperson NumberString4
SalespersonNameSalesperson NameString30
AddressLine1Address Line 1String30
AddressLine2Address Line 2String30
AddressLine3Address Line 3String30
CityCityString20
StateStateString2
ZipCodeZip CodeString10
CountryCodeCountry CodeString3
TelephoneNoTelephone NumberString17
TelephoneExtTelephone ExtString5
EmailAddressEmail AddressString50
SalesManagerDivisionNoSales Manager AR Division NumberString2
SalesManagerNoSales Manager NumberString4
CRMUserIDCRM User IDString11
UserKeyUser KeyString10
CommissionRateSalesperson Commission RateNumeric9.3
SalesManagerCommRateSales Manager Commission RateNumeric9.3
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

AR Payment Type

Element NameDescriptionTypeLength
PaymentTypePayment TypeString5
PaymentDescPayment DescriptionString30
PaymentMethodPayment MethodString1
AssetAcctKeyAsset Account KeyString9
CreditCardAccrualAcctKeyCredit Card Accrual Account KeyString9
DefaultTransactionDefaultTransactionString1
EBMInternetEnabledeBusiness Manager Internet EnabledString1
CreditCardSetupTestedCredit Card Setup TestedString1
MerchantIDMerchant IDString32
DisplayAVSCVVResponseDisplay AVS and CVV ResponseString1
AllowCorporateCardsAllow Corporate CardsString1
VirtualTerminalIDVirtual Terminal IDString13
MerchantKeyMerchant KeyString13
DiscountPercentageDiscount Percentage RateNumeric8.3
PerTransactionFeePer Transaction Fee AmountNumeric10.2
PreAuthorizationTermDays Authorizations Are ValidNumeric5
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

AR Customer Credit Card

Element NameDescriptionTypeLength
ARDivisionNoAR Division NumberString2
CustomerNoCustomer NumberString20
CreditCardGUIDSage Exchange vault credit card identifierString32
PaymentTypePayment TypeString5
CreditCardIDCredit Card IDString10
ExpirationDateYearExpiration Date YearString4
ExpirationDateMonthExpiration Date MonthString2
CardTypeCard TypeString1
BankAccountTypeBank Account TypeString1
CorporateCustIDPurchOrderCorporate Customer ID / Purchase OrderString17
CardholderNameCardholder NameString30
BankNameBank NameString30
AVSAddressLine1AVS Address Line 1String30
AVSAddressLine2AVS Address Line 2String30
AVSCityAVS CityString20
AVSStateAVS StateString2
AVSCountryCodeAVS Country CodeString3
EmailAddressCredit Card Email AddressString250
AVSZipCodeAVS Zip CodeString10
CreditCardCommentCredit Card CommentString30
EBMEnabledeBusiness Manager EnabledString1
Last4UnencryptedCreditCardNosLast 4 Unencrypted Credit Card NumbersString4
Last4BankRoutingNosLast 4 Bank Routing NumbersString4
Last4BankAccountNosLast 4 Bank Account NumbersString4
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

AR BillTo SoldTo

Element NameDescriptionTypeLength
SoldToDivisionNoSold To Division NumberString2
SoldToCustomerNoSold To Customer NumberString20
BillToDivisionNoBill To Division NumberString2
BillToCustomerNoBill To Customer NumberString20
CreditHoldCredit HoldString1
CreditLimitCredit LimitString1
DefaultAddressDefault AddressString1
CustomerPricingCustomer PricingString1
TermsCodeTerms CodeString1
UserCreatedKeyUser Created KeyString10
DateCreatedDate CreatedString8
TimeCreatedTime CreatedString8
UserUpdatedKeyUser Updated KeyString10
DateUpdatedDate UpdatedString8
TimeUpdatedTime UpdatedString8

SO Shipping Rate

Element NameDescriptionTypeLength
ShippingCodeShipping CodeString15
ShippingCodeDescShipping Code DescriptionString30
FreightCalculationMethodFreight Calculation MethodString1
UseShipZoneUse Ship ZoneString1
UseZipCodeAsShipZoneUse Zip Code As Ship ZoneString1
UsePriorRangeOfZipCodesUse Prior Range of Zip CodesString1
WeightCalculationWeight CalculationString1
LineTypeLine TypeString1
EBMEnabledeBusiness Manager EnabledString1
BaseAmtBase AmountNumeric12.2
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

SO Customer Primary Ship To Address

Element NameDescriptionTypeLength
ARDivisionNoAR Division NumberString2
CustomerNoCustomer NumberString20
ShipToCodeShip-To CodeString4
ShipToNameShip To NameString30
ShipToAddress1Ship To Address Line 1String30
ShipToAddress2Ship To Address Line 2String30
ShipToAddress3Ship To Address Line 3String30
ShipToCityShip To CityString20
ShipToStateShip To StateString2
ShipToZipCodeShip To Zip CodeString10
ShipToCountryCodeShip To Country CodeString3
TelephoneNoTelephone NumberString17
TelephoneExtTelephone ExtensionString5
FaxNoFax NumberString17
BatchFaxBatch FaxString1
BatchEmailBatch EmailString1
EmailAddressEmail AddressString50
ContactCodeContact CodeString10
SalespersonDivisionNoSalesperson Division NumberString2
SalespersonNoSalesperson NumberString4
WarehouseCodeWarehouse CodeString3
TaxScheduleTax ScheduleString9
ResidentialAddressResidential AddressString1
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

CI Inactive Reason Code

Element NameDescriptionTypeLength
InactiveReasonCodeInactive Reason CodeString5
InactiveReasonCodeDescInactive Reason Code DescriptionString30
DateCreatedCreation DateString8
TimeCreatedCreation TimeString8
UserCreatedKeyCreation User IDString10
DateUpdatedLast Update DateString8
TimeUpdatedLast Update TimeString8
UserUpdatedKeyLast Update User IDString10

SY Sales Tax Schedule

Element NameDescriptionTypeLength
TaxScheduleTax ScheduleString9
TaxScheduleDescTax Schedule DescriptionString30
PrintTaxCodeOnFormsPrint Tax Code On FormsString1

SY Sales Tax Class

Element NameDescriptionTypeLength
TaxClassTax ClassString2
TaxClassDescTax Class DescriptionString30
TaxClassTypeTax Class TypeString1

SY Country Code

Element NameDescriptionTypeLength
CountryCodeCountry CodeString3
CountryNameCountry NameString30
PhoneCodePhone Area CodeString3

SY ZipCode

Element NameDescriptionTypeLength
ZipCodeZip CodeString10
CityCityString20
StateCodeState CodeString2
CountryCodeCountry CodeString3


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.