Global API
...
Requests
Cash Refund
Read
2min
To read Cash Refunds, 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 Cash Refund. 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. |
status | String | To filter the records based on the Status value. Ex: Status=active |
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=readCashRefund,
3 timestamp=1682493238557,
4 validRequest=true,
5 version=1.0,
6 responseJSON={
7 {
8 "currentPageRecords": 2,
9 "totalRecords": 2,
10 "totalPages": 1,
11 "searchId": "WEBSERVICES_5333445_042620231133942682604740071_2f24a36e31c8",
12 "pageIndex": 1,
13 "errors": [],
14 "customParamters": {
15 "where": {
16 "value": null,
17 "keyValueMap": {
18 "subsidiary": "1,2",
19 "additionalFilter": "lastModifiedDate%3E1682493097%2Band%2BlastModifiedDate%3C1682493214"
20 }
21 }
22 },
23 "status": "200",
24
25 "cashRefunds": [{
26 "tranId": "14",
27 "tranDate": 1682478000,
28 "total": 18.88,
29 "taxTotal": 2.88,
30 "subTotal": 16.0,
31 "subsidiary": {
32 "type": null,
33 "name": "Parent Company",
34 "internalId": "1",
35 "externalId": null
36 },
37 "status": null,
38 "shippingCost": null,
39 "salesRep": null,
40 "salesforceID": null,
41 "refundCheck": false,
42 "otherRefNum": null,
43 "memo": null,
44 "location": {
45 "type": null,
46 "name": "Hyderabad : Hi-Tech City",
47 "internalId": "10",
48 "externalId": null
49 },
50 "lastModifiedDate": 1682493164,
51 "job": null,
52 "itemList": {
53 "replaceAll": null,
54 "item": [{
55 "unitsDisplay": null,
56 "taxRate1": "18.0%",
57 "taxCode": {
58 "type": null,
59 "name": "VAT_IN:GST 18",
60 "internalId": "36",
61 "externalId": null
62 },
63 "tax1Amt": 2.88,
64 "shipMethod": null,
65 "shipGroup": null,
66 "serialNumbers": "1",
67 "revRecStartDate": null,
68 "revRecSchedule": null,
69 "revRecEndDate": null,
70 "rate": "16.00",
71 "quantityRemaining": null,
72 "quantityReceived": null,
73 "quantityPicked": null,
74 "quantityPacked": null,
75 "quantityOnHand": null,
76 "quantityFulfilled": null,
77 "quantityCommitted": null,
78 "quantityBilled": null,
79 "quantityBackOrdered": null,
80 "quantityAvailable": null,
81 "quantity": 1.0,
82 "price": {
83 "type": null,
84 "name": "Base Price",
85 "internalId": "1",
86 "externalId": null
87 },
88 "poNum": null,
89 "percentComplete": null,
90 "orderLine": null,
91 "onHand": null,
92 "location": null,
93 "line": 1,
94 "jobName": null,
95 "itemReceive": null,
96 "itemName": null,
97 "itemIsFulfilled": null,
98 "item": {
99 "type": null,
100 "name": "Apple",
101 "internalId": "444",
102 "externalId": null
103 },
104 "isClosed": null,
105 "grossAmt": 18.88,
106 "expectedReceiptDate": null,
107 "description": "sales",
108 "department": null,
109 "customFieldList": {
110 "customField": [{
111 "valueLookup": null,
112 "value": "false",
113 "scriptId": "custcol_checkbox",
114 "internalId": "443",
115 "fieldType": null
116 }]
117 },
118 "createPo": null,
119 "costEstimateType": "_averageCost",
120 "costEstimate": 0.0,
121 "classification": null,
122 "billingSchedule": null,
123 "amount": 16.0
124 }]
125 },
126 "internalId": "121457",
127 "handlingCost": null,
128 "externalId": null,
129 "exchangeRate": 23.0,
130 "entity": {
131 "type": null,
132 "name": "12:472 GS Solutions : United Oil & Gas Corp.",
133 "internalId": "65690",
134 "externalId": null
135 },
136 "discountTotal": null,
137 "discountRate": null,
138 "discountItem": null,
139 "department": null,
140 "customForm": null,
141 "customFieldList": {
142 "customField": [{
143 "valueLookup": null,
144 "value": "16",
145 "scriptId": "custbody42",
146 "internalId": "869",
147 "fieldType": null
148 },
149 {
150 "valueLookup": null,
151 "value": " - ",
152 "scriptId": "custbody_breadwinner_pc_internal_id",
153 "internalId": "588",
154 "fieldType": null
155 },
156 {
157 "valueLookup": null,
158 "value": "false",
159 "scriptId": "custbody_checkbox",
160 "internalId": "272",
161 "fieldType": null
162 },
163 {
164 "valueLookup": null,
165 "value": "false",
166 "scriptId": "custbody_enableimport",
167 "internalId": "691",
168 "fieldType": null
169 }
170 ]
171 },
172 "currencyRecord": {
173 "type": null,
174 "name": "US Dollars",
175 "internalId": "2",
176 "externalId": null
177 },
178 "currencyName": "US Dollars",
179 "createdFrom": null,
180 "createdDate": 1682493164,
181 "classification": null,
182 "applyList": null,
183 "applied": null,
184 "account": {
185 "type": null,
186 "name": "Cheque Account",
187 "internalId": "1",
188 "externalId": null
189 }
190 },
191 {
192 "unapplied": null,
193 "tranId": "15",
194 "tranDate": 1682478000,
195 "total": 2.36,
196 "taxTotal": 0.36,
197 "subTotal": 2.0,
198 "subsidiary": {
199 "type": null,
200 "name": "Parent Company",
201 "internalId": "1",
202 "externalId": null
203 },
204 "status": null,
205 "shippingCost": null,
206 "salesRep": null,
207 "salesforceID": null,
208 "refundCheck": false,
209 "otherRefNum": null,
210 "memo": null,
211 "location": {
212 "type": null,
213 "name": "Hyderabad : Hi-Tech City",
214 "internalId": "10",
215 "externalId": null
216 },
217 "lastModifiedDate": 1682493198,
218 "job": null,
219 "itemList": {
220 "replaceAll": null,
221 "item": [{
222 "unitsDisplay": null,
223 "taxRate1": "18.0%",
224 "taxCode": {
225 "type": null,
226 "name": "VAT_IN:GST 18",
227 "internalId": "36",
228 "externalId": null
229 },
230 "tax1Amt": 0.36,
231 "shipMethod": null,
232 "shipGroup": null,
233 "serialNumbers": null,
234 "revRecStartDate": null,
235 "revRecSchedule": null,
236 "revRecEndDate": null,
237 "rate": "2.00",
238 "quantityRemaining": null,
239 "quantityReceived": null,
240 "quantityPicked": null,
241 "quantityPacked": null,
242 "quantityOnHand": null,
243 "quantityFulfilled": null,
244 "quantityCommitted": null,
245 "quantityBilled": null,
246 "quantityBackOrdered": null,
247 "quantityAvailable": null,
248 "quantity": 1.0,
249 "price": {
250 "type": null,
251 "name": "Base Price",
252 "internalId": "1",
253 "externalId": null
254 },
255 "poNum": null,
256 "percentComplete": null,
257 "orderLine": null,
258 "onHand": null,
259 "location": null,
260 "line": 1,
261 "jobName": null,
262 "itemReceive": null,
263 "itemName": null,
264 "itemIsFulfilled": null,
265 "item": {
266 "type": null,
267 "name": "Chair",
268 "internalId": "10030",
269 "externalId": null
270 },
271 "isClosed": null,
272 "grossAmt": 2.36,
273 "expectedReceiptDate": null,
274 "description": null,
275 "department": null,
276 "customFieldList": {
277 "customField": [{
278 "valueLookup": null,
279 "value": "false",
280 "scriptId": "custcol_checkbox",
281 "internalId": "443",
282 "fieldType": null
283 }]
284 },
285 "createPo": null,
286 "costEstimateType": "_averageCost",
287 "costEstimate": 0.0,
288 "classification": null,
289 "billingSchedule": null,
290 "amount": 2.0
291 }]
292 },
293 "internalId": "121458",
294 "handlingCost": null,
295 "externalId": null,
296 "exchangeRate": 1.0,
297 "entity": {
298 "type": null,
299 "name": "139 ABC",
300 "internalId": "2770",
301 "externalId": null
302 },
303 "discountTotal": null,
304 "discountRate": null,
305 "discountItem": null,
306 "department": null,
307 "customForm": null,
308 "customFieldList": {
309 "customField": [{
310 "valueLookup": null,
311 "value": "2",
312 "scriptId": "custbody42",
313 "internalId": "869",
314 "fieldType": null
315 },
316 {
317 "valueLookup": null,
318 "value": " - ",
319 "scriptId": "custbody_breadwinner_pc_internal_id",
320 "internalId": "588",
321 "fieldType": null
322 },
323 {
324 "valueLookup": null,
325 "value": "false",
326 "scriptId": "custbody_checkbox",
327 "internalId": "272",
328 "fieldType": null
329 },
330 {
331 "valueLookup": null,
332 "value": "false",
333 "scriptId": "custbody_enableimport",
334 "internalId": "691",
335 "fieldType": null
336 }
337 ]
338 },
339 "currencyRecord": {
340 "type": null,
341 "name": "INR",
342 "internalId": "1",
343 "externalId": null
344 },
345 "currencyName": "INR",
346 "createdFrom": null,
347 "createdDate": 1682493198,
348 "classification": null,
349 "applyList": null,
350 "applied": null,
351 "account": {
352 "type": null,
353 "name": "Cheque Account",
354 "internalId": "1",
355 "externalId": null
356 }
357 }
358 ]
359}
360}
361
