Global API
...
Requests
Vendor
Read
2min
To read Vendors, please use the below parameters.
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. |
Request
Response
1{
2 action=readVendor,
3 responseJSON={
4 "vendors": [
5 {
6 "vatRegNumber": null,
7 "url": "http://www.abc.com",
8 "title": null,
9 "terms": null,
10 "taxItem": null,
11 "taxIdNum": null,
12 "subsidiary": {
13 "type": null,
14 "name": "Parent Company",
15 "internalId": "1",
16 "externalId": null
17 },
18 "salutation": null,
19 "salesforceID": null,
20 "phone": null,
21 "payablesAccount": null,
22 "nullFieldList": null,
23 "mobilePhone": null,
24 "middleName": null,
25 "legalName": null,
26 "lastName": null,
27 "lastModifiedDate": 1629796523,
28 "isPerson": false,
29 "isJobResourceVend": false,
30 "isInactive": false,
31 "isAccountant": null,
32 "is1099Eligible": null,
33 "internalId": "63490",
34 "incoterm": null,
35 "homePhone": null,
36 "firstName": null,
37 "fax": null,
38 "externalId": null,
39 "expenseAccount": null,
40 "entityId": "GS Solutions420",
41 "email": null,
42 "dateCreated": 1629796522,
43 "customForm": null,
44 "customFieldList": {
45 "customField": [
46 {
47 "valueLookup": null,
48 "value": " - ",
49 "scriptId": "custentity_breadwinner_pc_internal_id",
50 "internalId": "504",
51 "fieldType": null
52 },
53 {
54 "valueLookup": null,
55 "value": "false",
56 "scriptId": "custentity_checkbox",
57 "internalId": "432",
58 "fieldType": null
59 },
60 {
61 "valueLookup": null,
62 "value": "false",
63 "scriptId": "custentity_edoc_gen_trans_pdf",
64 "internalId": "920",
65 "fieldType": null
66 },
67 {
68 "valueLookup": null,
69 "value": "false",
70 "scriptId": "custentity_edoc_use_sender_list",
71 "internalId": "915",
72 "fieldType": null
73 },
74 {
75 "valueLookup": null,
76 "value": "true",
77 "scriptId": "custentity_f3_mm_send_wf_sms",
78 "internalId": "428",
79 "fieldType": null
80 },
81 {
82 "valueLookup": null,
83 "value": "false",
84 "scriptId": "custentity_mm_iskeylinkentity",
85 "internalId": "426",
86 "fieldType": null
87 },
88 {
89 "valueLookup": null,
90 "value": "false",
91 "scriptId": "custentity_mm_stopsendingsms",
92 "internalId": "424",
93 "fieldType": null
94 },
95 {
96 "valueLookup": null,
97 "value": "false",
98 "scriptId": "custentity_psg_ei_auto_select_temp_sm",
99 "internalId": "922",
100 "fieldType": null
101 }
102 ]
103 },
104 "currencyRecord": {
105 "type": null,
106 "name": "US Dollars",
107 "internalId": "2",
108 "externalId": null
109 },
110 "currencyList": {
111 "vendorCurrency": [
112 {
113 "currencyRecord": {
114 "type": null,
115 "name": "US Dollars",
116 "internalId": "2",
117 "externalId": null
118 }
119 }
120 ],
121 "currencyRecord": null
122 },
123 "creditLimit": null,
124 "companyName": "GS Solutions420",
125 "category": null,
126 "bcn": null,
127 "addressbookList": {
128 "replaceAll": null,
129 "addressbook": [
130 {
131 "label": "Add 13434 Add 2",
132 "isResidential": null,
133 "internalId": "66910",
134 "defaultShipping": false,
135 "defaultBilling": true,
136 "addressbookAddress": {
137 "zip": "0123654",
138 "state": "MI",
139 "overrideValue": false,
140 "internalId": null,
141 "country": "_india",
142 "city": "City 1",
143 "attention": null,
144 "addrText": "GS Solutions420<br>Add 13434 Add 2<br>City 1 MI 0123654<br>India",
145 "addrPhone": null,
146 "addressee": "GS Solutions420",
147 "addr3": null,
148 "addr2": null,
149 "addr1": "Add 13434 Add 2"
150 }
151 }
152 ]
153 },
154 "accountNumber": null
155 }
156 ],
157 "customParamters": {
158 "where": {
159 "value": null,
160 "keyValueMap": {
161 "subsidiary": "1,2",
162 "additionalFilter": "lastModifiedDate%3E1628930520%2Band%2BlastModifiedDate%3C1634200920"
163 }
164 }
165 },
166 "currentPageRecords": 1,
167 "totalRecords": 1,
168 "totalPages": 1,
169 "searchId": "WEBSERVICES_5333445_SB1_0414202321297677971045791901_cbc7ebd",
170 "pageIndex": 1,
171 "errors": [
172
173 ],
174 "status": "200"
175 },
176 timestamp=1681461981947,
177 validRequest=true,
178 version=1.0
179}
