Read

2 min

To read Vendors, please use the below parameters.

Supported “where” Filters

Field Name	Data Type	Description
created	Long	This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.
lastModifiedDate	Long	This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates.
subsidiary	String	Internal ID of Subsidiary (Primary). Do Not Use this in additonalFilter. Multiple IDs can be passed in a comma-separated string Ex: 1,2
additonalFilter	String	construct the additional filter with a combination of the above fields using ‘+and+’ separator and pass it as a single string. Make sure to wrap the whole string using EncodingUtil.urlEncode
active	String	To filter the records based using Active value.

Example

{
  action=readVendor,
  responseJSON={
    "vendors": [
      {
        "vatRegNumber": null,
        "url": "http://www.abc.com",
        "title": null,
        "terms": null,
        "taxItem": null,
        "taxIdNum": null,
        "subsidiary": {
          "type": null,
          "name": "Parent Company",
          "internalId": "1",
          "externalId": null
        },
        "salutation": null,
        "salesforceID": null,
        "phone": null,
        "payablesAccount": null,
        "nullFieldList": null,
        "mobilePhone": null,
        "middleName": null,
        "legalName": null,
        "lastName": null,
        "lastModifiedDate": 1629796523,
        "isPerson": false,
        "isJobResourceVend": false,
        "isInactive": false,
        "isAccountant": null,
        "is1099Eligible": null,
        "internalId": "63490",
        "incoterm": null,
        "homePhone": null,
        "firstName": null,
        "fax": null,
        "externalId": null,
        "expenseAccount": null,
        "entityId": "GS Solutions420",
        "email": null,
        "dateCreated": 1629796522,
        "customForm": null,
        "customFieldList": {
          "customField": [
            {
              "valueLookup": null,
              "value": " - ",
              "scriptId": "custentity_breadwinner_pc_internal_id",
              "internalId": "504",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_checkbox",
              "internalId": "432",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_edoc_gen_trans_pdf",
              "internalId": "920",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_edoc_use_sender_list",
              "internalId": "915",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "true",
              "scriptId": "custentity_f3_mm_send_wf_sms",
              "internalId": "428",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_mm_iskeylinkentity",
              "internalId": "426",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_mm_stopsendingsms",
              "internalId": "424",
              "fieldType": null
            },
            {
              "valueLookup": null,
              "value": "false",
              "scriptId": "custentity_psg_ei_auto_select_temp_sm",
              "internalId": "922",
              "fieldType": null
            }
          ]
        },
        "currencyRecord": {
          "type": null,
          "name": "US Dollars",
          "internalId": "2",
          "externalId": null
        },
        "currencyList": {
          "vendorCurrency": [
            {
              "currencyRecord": {
                "type": null,
                "name": "US Dollars",
                "internalId": "2",
                "externalId": null
              }
            }
          ],
          "currencyRecord": null
        },
        "creditLimit": null,
        "companyName": "GS Solutions420",
        "category": null,
        "bcn": null,
        "addressbookList": {
          "replaceAll": null,
          "addressbook": [
            {
              "label": "Add 13434 Add 2",
              "isResidential": null,
              "internalId": "66910",
              "defaultShipping": false,
              "defaultBilling": true,
              "addressbookAddress": {
                "zip": "0123654",
                "state": "MI",
                "overrideValue": false,
                "internalId": null,
                "country": "_india",
                "city": "City 1",
                "attention": null,
                "addrText": "GS Solutions420<br>Add 13434 Add 2<br>City 1 MI 0123654<br>India",
                "addrPhone": null,
                "addressee": "GS Solutions420",
                "addr3": null,
                "addr2": null,
                "addr1": "Add 13434 Add 2"
              }
            }
          ]
        },
        "accountNumber": null
      }
    ],
    "customParamters": {
      "where": {
        "value": null,
        "keyValueMap": {
          "subsidiary": "1,2",
          "additionalFilter": "lastModifiedDate%3E1628930520%2Band%2BlastModifiedDate%3C1634200920"
        }
      }
    },
    "currentPageRecords": 1,
    "totalRecords": 1,
    "totalPages": 1,
    "searchId": "WEBSERVICES_5333445_SB1_0414202321297677971045791901_cbc7ebd",
    "pageIndex": 1,
    "errors": [
      
    ],
    "status": "200"
  },
  timestamp=1681461981947,
  validRequest=true,
  version=1.0
}