Global API
...
Requests
Sales Order
Read
2min
To read Sales Orders, please use the below parameters.
Field Name | Data Type | Description |
|---|---|---|
dateCreated | Long | This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates. |
internalId | String | Internal ID of the Sales Order. Multiple values can be passed in a comma-separated string. |
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 |
tranDate | Long | Transaction date of the record. Use the “additionalFilter” option for a range of dates. |
customer | String | To filter the records based on the Customer. Multiple IDs can be passed in a comma-separated string Ex: 6,7 |
Request
Response
1{
2 action=readSalesOrder,
3 timestamp=1657005610951,
4 validRequest=true,
5 version=1.0,
6 responseJSON={
7 "currentPageRecords": null,
8 "totalRecords": 2,
9 "totalPages": 1,
10 "searchId": "WEBSERVICES_5333445_SB1_070520228517698711005783525_4375fd99",
11 "pageIndex": 1,
12 "errors": [
13
14 ],
15 "customParamters": {
16 "where": {
17 "value": null,
18 "keyValueMap": {
19 "internalId": "61126,61127"
20 }
21 }
22 },
23 "status": "200""salesOrders": [
24 {
25 "tranId": "12320000000000153",
26 "tranDate": 1608796800,
27 "total": 82.6,
28 "terms": null,
29 "taxTotal": 12.6,
30 "subTotal": 70.0,
31 "subsidiary": {
32 "type": null,
33 "name": "Parent Company",
34 "internalId": "1",
35 "externalId": null
36 },
37 "status": "Pending Approval",
38 "startDate": null,
39 "shippingCost": null,
40 "shippingAddress": null,
41 "shipAddressList": null,
42 "salesRep": {
43 "type": null,
44 "name": "Navaneeth.D",
45 "internalId": "4",
46 "externalId": null
47 },
48 "salesforceID": null,
49 "salesEffectiveDate": 1608796800,
50 "otherRefNum": null,
51 "nullFieldList": null,
52 "memo": "Memo testinhg345",
53 "location": null,
54 "lastModifiedDate": 1634561084,
55 "itemList": {
56 "replaceAll": null,
57 "item": [
58 {
59 "unitsDisplay": null,
60 "taxRate1": "18.0",
61 "taxCode": {
62 "type": null,
63 "name": "VAT_IN:GST 18",
64 "internalId": "36",
65 "externalId": null
66 },
67 "tax1Amt": 12.6,
68 "shipMethod": null,
69 "shipGroup": null,
70 "serialNumbers": null,
71 "revRecStartDate": null,
72 "revRecSchedule": null,
73 "revRecEndDate": null,
74 "rate": "70.00",
75 "quantityRemaining": null,
76 "quantityReceived": null,
77 "quantityBilled": 0.0,
78 "quantity": 1.0,
79 "price": {
80 "type": null,
81 "name": "Base Price",
82 "internalId": "1",
83 "externalId": null
84 },
85 "poNum": null,
86 "orderLine": null,
87 "onHand": null,
88 "location": {
89 "type": null,
90 "name": "Hyderabad",
91 "internalId": "6",
92 "externalId": null
93 },
94 "line": 1,
95 "jobName": null,
96 "itemReceive": null,
97 "itemName": null,
98 "itemIsFulfilled": null,
99 "item": {
100 "type": null,
101 "name": "Apple",
102 "internalId": "444",
103 "externalId": null
104 },
105 "grossAmt": 82.6,
106 "expectedReceiptDate": null,
107 "description": "sales",
108 "department": null,
109 "customFieldList": {
110 "customField": [
111 {
112 "valueLookup": null,
113 "value": "false",
114 "scriptId": "custcol_checkbox",
115 "internalId": "443",
116 "fieldType": null
117 },
118 {
119 "valueLookup": null,
120 "value": "1",
121 "scriptId": "custcol_gh_line_no",
122 "internalId": "175",
123 "fieldType": null
124 },
125 {
126 "valueLookup": null,
127 "value": "12320000000000153_80009",
128 "scriptId": "custcol_gh_so_line_id",
129 "internalId": "200",
130 "fieldType": null
131 }
132 ]
133 },
134 "createPo": null,
135 "costEstimateType": null,
136 "costEstimate": null,
137 "classification": null,
138 "amount": 70.0
139 }
140 ]
141 },
142 "internalId": "61126",
143 "handlingCost": null,
144 "externalId": null,
145 "exchangeRate": 1.0,
146 "entity": {
147 "type": null,
148 "name": "CUST541AT Test Customer Deposits",
149 "internalId": "35144",
150 "externalId": null
151 },
152 "endDate": null,
153 "discountTotal": null,
154 "discountRate": null,
155 "discountItem": null,
156 "department": null,
157 "customForm": null,
158 "customFieldList": {
159 "customField": [
160 {
161 "valueLookup": null,
162 "value": " - ",
163 "scriptId": "custbody_breadwinner_pc_internal_id",
164 "internalId": "588",
165 "fieldType": null
166 },
167 {
168 "valueLookup": null,
169 "value": "false",
170 "scriptId": "custbody_checkbox",
171 "internalId": "272",
172 "fieldType": null
173 },
174 {
175 "valueLookup": null,
176 "value": "false",
177 "scriptId": "custbody_edoc_gen_trans_pdf",
178 "internalId": "925",
179 "fieldType": null
180 },
181 {
182 "valueLookup": null,
183 "value": "false",
184 "scriptId": "custbody_ei_ds_txn_identifier",
185 "internalId": "932",
186 "fieldType": null
187 }
188 ]
189 },
190 "currencyRecord": {
191 "type": null,
192 "name": "INR",
193 "internalId": "1",
194 "externalId": null
195 },
196 "currencyName": "INR",
197 "createdFrom": null,
198 "createdDate": 1608797225,
199 "classification": null,
200 "billingAddress": null,
201 "billAddressList": null
202 },
203 {
204 "tranId": "12320000000000154",
205 "tranDate": 1608796800,
206 "total": 77.37,
207 "terms": null,
208 "taxTotal": 11.8,
209 "subTotal": 65.57,
210 "subsidiary": {
211 "type": null,
212 "name": "Parent Company",
213 "internalId": "1",
214 "externalId": null
215 },
216 "status": "Pending Approval",
217 "startDate": null,
218 "shippingCost": null,
219 "shippingAddress": null,
220 "shipAddressList": null,
221 "salesRep": {
222 "type": null,
223 "name": "Navaneeth.D",
224 "internalId": "4",
225 "externalId": null
226 },
227 "salesforceID": null,
228 "salesEffectiveDate": 1608796800,
229 "otherRefNum": null,
230 "nullFieldList": null,
231 "memo": "Memo testinhg345",
232 "location": null,
233 "lastModifiedDate": 1634561084,
234 "itemList": {
235 "replaceAll": null,
236 "item": [
237 {
238 "unitsDisplay": null,
239 "taxRate1": "18.0",
240 "taxCode": {
241 "type": null,
242 "name": "VAT_IN:GST 18",
243 "internalId": "36",
244 "externalId": null
245 },
246 "tax1Amt": 11.8,
247 "shipMethod": null,
248 "shipGroup": null,
249 "serialNumbers": null,
250 "revRecStartDate": null,
251 "revRecSchedule": null,
252 "revRecEndDate": null,
253 "rate": "65.56766557",
254 "quantityRemaining": null,
255 "quantityReceived": null,
256 "quantityBilled": 0.0,
257 "quantity": 1.0,
258 "price": {
259 "type": null,
260 "name": "Base Price",
261 "internalId": "1",
262 "externalId": null
263 },
264 "poNum": null,
265 "orderLine": null,
266 "onHand": null,
267 "location": null,
268 "line": 1,
269 "jobName": null,
270 "itemReceive": null,
271 "itemName": null,
272 "itemIsFulfilled": null,
273 "item": {
274 "type": null,
275 "name": "Bag",
276 "internalId": "34",
277 "externalId": null
278 },
279 "grossAmt": 77.37,
280 "expectedReceiptDate": null,
281 "description": "Blue color Bag<br>Made of Leather",
282 "department": null,
283 "customFieldList": {
284 "customField": [
285 {
286 "valueLookup": null,
287 "value": "false",
288 "scriptId": "custcol_checkbox",
289 "internalId": "443",
290 "fieldType": null
291 },
292 {
293 "valueLookup": null,
294 "value": "1",
295 "scriptId": "custcol_gh_line_no",
296 "internalId": "175",
297 "fieldType": null
298 },
299 {
300 "valueLookup": null,
301 "value": "12320000000000154_80014",
302 "scriptId": "custcol_gh_so_line_id",
303 "internalId": "200",
304 "fieldType": null
305 }
306 ]
307 },
308 "createPo": "_dropShipment",
309 "costEstimateType": null,
310 "costEstimate": null,
311 "classification": null,
312 "amount": 65.57
313 }
314 ]
315 },
316 "internalId": "61127",
317 "handlingCost": null,
318 "externalId": null,
319 "exchangeRate": 1.0,
320 "entity": {
321 "type": null,
322 "name": "CUST541AT Test Customer Deposits",
323 "internalId": "35144",
324 "externalId": null
325 },
326 "endDate": null,
327 "discountTotal": null,
328 "discountRate": null,
329 "discountItem": null,
330 "department": null,
331 "customForm": null,
332 "customFieldList": {
333 "customField": [
334 {
335 "valueLookup": null,
336 "value": " - ",
337 "scriptId": "custbody_breadwinner_pc_internal_id",
338 "internalId": "588",
339 "fieldType": null
340 },
341 {
342 "valueLookup": null,
343 "value": "false",
344 "scriptId": "custbody_checkbox",
345 "internalId": "272",
346 "fieldType": null
347 },
348 {
349 "valueLookup": null,
350 "value": "false",
351 "scriptId": "custbody_edoc_gen_trans_pdf",
352 "internalId": "925",
353 "fieldType": null
354 },
355 {
356 "valueLookup": null,
357 "value": "false",
358 "scriptId": "custbody_ei_ds_txn_identifier",
359 "internalId": "932",
360 "fieldType": null
361 }
362 ]
363 },
364 "currencyRecord": {
365 "type": null,
366 "name": "INR",
367 "internalId": "1",
368 "externalId": null
369 },
370 "currencyName": "INR",
371 "createdFrom": null,
372 "createdDate": 1608797290,
373 "classification": null,
374 "billingAddress": null,
375 "billAddressList": null
376 }
377 ],
378 },
379}
