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
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 |
Users can retrieve their own data from the Vendor Resource. This can include data from any of the tables associated with the resource.
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.
The Vendor table can be updated through the Vendor Resource. Users can update their own Vendor data, while Administrators can update any Vendors data.
Only an Administrator can create a new Vendor. On a successful Create, the key values, Division Number and Vendor Number, are returned.