api/Vendor/Query (POST)

Queries existing Vendors using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Vendors.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing Vendor query data.

Query Single Vendor Using Key Fields Example:
{
  "VENDOR_ID": "XYZCORP"
}
Returns 1 Vendor if successful.
This is like 'Find' in Expandable.

Query Multiple Vendors Using Other Fields Example:
{
  "COUNTRY": "USA",
  "STATE": "FL"
}
Returns 1 or more Vendors if successful.
This is like 'QBE' in Expandable.

Query Multiple Vendors Using QBE Conditional Notation Example:
{
  "COUNTRY": "USA",
  "STATE": "IN 'FL','GA'"
}
Returns 1 or more Vendors if successful.
This is like 'QBE' in Expandable.

Accepted Vendor Fields:
ACCT_TYPE, ACH_GEN_1, ACH_GEN_2, ACH_GEN_3, 
ACH_GEN_4, ACH_SEC, ADDRESS_1, ADDRESS_2, 
ADDRESS_3, AL_VEND_NAME, AP_CONTACT, AP_PHONE_NO, 
AUTO_PO_HOLD, BANK_CODE, BANK_ROUT_NO, BUSINESS_TYPE, 
BUYER_ID, CITY, COMMENT_1, COMMENT_2, 
COMMENT_3, COMMENT_4, COMMENT_5, COMMENT_6, 
COMMENT_7, COMMENT_8, COMMENT_ID, COMPANY_ID, 
COUNTRY, CREATED_BY, CURR_CODE, CURRENT_BALANCE, 
DATE_CREATED, DATE_LAST_CHECK, DATE_LAST_PO, DATE_LAST_UPDT, 
DATE_MODIFIED, DAYS_LATE, DISC_LOST_YTD, DISCOUNTS_YTD, 
DUNS_NUM, EARLY_RECEIPT, EXP_ACCOUNT, EXP_DEPT, 
FAX_NO, FOB, FREIGHT_CODE, LANGUAGE, 
LAST_CHECK_AMT, LAST_YR_DISC, LAST_YR_LOST, LAST_YR_PAID, 
LC_CURRENT_BAL, MAX_PAYMENT, MODIFIED_BY, NAICS_CODE, 
NUMBER_PO_YTD, OPERATOR_ID, ORDER_DISC_PCT, PARTIAL_SHIP, 
PAY_METHOD, PAY_TO_VENDOR, PAYMENTS_YTD, PO_CONTACT, 
PO_PHONE_NO, POFVM_USER_1, POFVM_USER_2, POFVM_USER_3, 
POFVM_USER_4, POFVM_USER_5, POFVM_USER_6, POFVM_USER_7, 
POFVM_USER_8, POFVM_USER_9, POFVM_USER_10, POFVM_USER_11, 
POFVM_USER_12, POFVM_USER_13, POFVM_USER_14, POFVM_USER_15, 
POFVM_USER_16, POFVM_USER_17, POFVM_USER_18, POFVM_USER_19, 
POFVM_USER_20, POFVM_USER_21, POFVM_USER_22, POFVM_USER_23, 
POFVM_USER_24, POFVM_USER_25, POFVM_USER_26, POFVM_USER_27, 
POFVM_USER_28, POFVM_USER_29, POFVM_USER_30, POFVM_USER_31, 
POFVM_USER_32, PURCHASES_YTD, SEARCH_NAME, SHIP_METHOD, 
SIC_CODE, STATE, TAX_1099_NO, TAX_1099_TYPE, 
TAX_CODE, TERMS_CODE, TIME_LAST_UPDT, TRANS_CODE, 
VAR_RECV_QTY, VARIANCE_AMT, VARIANCE_PCT, VENDOR_ID, 
VENDOR_NAME, VENDOR_STATUS, VENDOR_TYPE, ZIP_CODE

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON array with found Vendors.

Error:
400/Request JSON is invalid.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned Vendor Fields:
ATTACHMENTS, ACCT_TYPE, ACH_GEN_1, ACH_GEN_2, ACH_GEN_3, ACH_GEN_4, ACH_SEC, ADDRESS_1, ADDRESS_2, ADDRESS_3, AL_VEND_NAME, AP_CONTACT, AP_PHONE_NO, AUTO_PO_HOLD, BANK_CODE, BANK_ROUT_NO, BUSINESS_TYPE, BUYER_ID, CITY, COMMENT_1, COMMENT_2, COMMENT_3, COMMENT_4, COMMENT_5, COMMENT_6, COMMENT_7, COMMENT_8, COMMENT_ID, COMPANY_ID, COUNTRY, CREATED_BY, CURR_CODE, CURRENT_BALANCE, DATE_CREATED, DATE_LAST_CHECK, DATE_LAST_PO, DATE_LAST_UPDT, DATE_MODIFIED, DAYS_LATE, DISC_LOST_YTD, DISCOUNTS_YTD, DUNS_NUM, EARLY_RECEIPT, EXP_ACCOUNT, EXP_DEPT, FAX_NO, FOB, FREIGHT_CODE, LANGUAGE, LAST_CHECK_AMT, LAST_YR_DISC, LAST_YR_LOST, LAST_YR_PAID, LC_CURRENT_BAL, MAX_PAYMENT, MODIFIED_BY, NAICS_CODE, NOTES, NUMBER_PO_YTD, OPERATOR_ID, ORDER_DISC_PCT, PARTIAL_SHIP, PAY_METHOD, PAY_TO_VENDOR, PAYMENTS_YTD, PO_CONTACT, PO_PHONE_NO, POFVM_USER_1, POFVM_USER_2, POFVM_USER_3, POFVM_USER_4, POFVM_USER_5, POFVM_USER_6, POFVM_USER_7, POFVM_USER_8, POFVM_USER_9, POFVM_USER_10, POFVM_USER_11, POFVM_USER_12, POFVM_USER_13, POFVM_USER_14, POFVM_USER_15, POFVM_USER_16, POFVM_USER_17, POFVM_USER_18, POFVM_USER_19, POFVM_USER_20, POFVM_USER_21, POFVM_USER_22, POFVM_USER_23, POFVM_USER_24, POFVM_USER_25, POFVM_USER_26, POFVM_USER_27, POFVM_USER_28, POFVM_USER_29, POFVM_USER_30, POFVM_USER_31, POFVM_USER_32, PURCHASES_YTD, SEARCH_NAME, SHIP_METHOD, SIC_CODE, STATE, TAX_1099_NO, TAX_1099_TYPE, TAX_CODE, TERMS_CODE, TIME_LAST_UPDT, TRANS_CODE, VAR_RECV_QTY, VARIANCE_AMT, VARIANCE_PCT, VENDOR_ID, VENDOR_NAME, VENDOR_STATUS, VENDOR_TYPE, ZIP_CODE