Global API
...
Requests
Return Authorization
Read
2min
To read Return Authorizations, 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 RMA. 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=readReturnAuthorization,
3 timestamp=1657007708584,
4 validRequest=true,
5 version=1.0,
6 responseJSON={
7 "currentPageRecords": null,
8 "totalRecords": 2,
9 "totalPages": 1,
10 "searchId": "WEBSERVICES_5333445_SB1_070520228496699151186859035_be248925",
11 "pageIndex": 1,
12 "errors": [
13
14 ],
15 "customParamters": {
16 "where": {
17 "value": null,
18 "keyValueMap": {
19 "internalId": "94809,95012"
20 }
21 }
22 },
23 "status": "200""returnAuthorizations": [
24 {
25 "tranId": "147",
26 "tranDate": 1623567600,
27 "totalCostEstimate": null,
28 "total": 1.18,
29 "taxTotal": 0.18,
30 "subTotal": 1.0,
31 "subsidiary": {
32 "type": null,
33 "name": "Atlanta",
34 "internalId": "20",
35 "externalId": null
36 },
37 "status": "Pending Receipt",
38 "source": "Web Services",
39 "salesRep": null,
40 "salesforceID": null,
41 "salesEffectiveDate": 1623567600,
42 "otherRefNum": null,
43 "orderStatus": null,
44 "nullFieldList": null,
45 "memo": "3",
46 "location": null,
47 "lastModifiedDate": 1643036958,
48 "itemList": {
49 "replaceAll": null,
50 "item": [
51 {
52 "unitsDisplay": null,
53 "taxRate1": "18.0",
54 "taxCode": {
55 "type": null,
56 "name": "VAT_IN:GST 18",
57 "internalId": "36",
58 "externalId": null
59 },
60 "tax1Amt": 0.18,
61 "shipMethod": null,
62 "shipGroup": null,
63 "serialNumbers": null,
64 "revRecStartDate": null,
65 "revRecSchedule": null,
66 "revRecEndDate": null,
67 "rate": "1.00",
68 "quantityRemaining": null,
69 "quantityReceived": 0.0,
70 "quantityBilled": 0.0,
71 "quantity": 1.0,
72 "price": null,
73 "poNum": null,
74 "orderLine": null,
75 "onHand": null,
76 "location": null,
77 "line": 1,
78 "jobName": null,
79 "itemReceive": null,
80 "itemName": null,
81 "itemIsFulfilled": null,
82 "item": {
83 "type": null,
84 "name": "Touch Pad Pro",
85 "internalId": "570",
86 "externalId": null
87 },
88 "grossAmt": 1.18,
89 "expectedReceiptDate": null,
90 "description": "linedesc",
91 "department": null,
92 "customFieldList": {
93 "customField": [
94 {
95 "valueLookup": null,
96 "value": "false",
97 "scriptId": "custcol_checkbox",
98 "internalId": "443",
99 "fieldType": null
100 }
101 ]
102 },
103 "createPo": null,
104 "costEstimateType": null,
105 "costEstimate": null,
106 "classification": null,
107 "amount": 1.0
108 }
109 ]
110 },
111 "internalId": "94809",
112 "externalId": null,
113 "entity": {
114 "type": null,
115 "name": "CUST1010AT Test Account62117",
116 "internalId": "73691",
117 "externalId": null
118 },
119 "discountTotal": null,
120 "discountRate": null,
121 "discountItem": null,
122 "department": {
123 "type": null,
124 "name": "test",
125 "internalId": "3",
126 "externalId": null
127 },
128 "customForm": null,
129 "customFieldList": {
130 "customField": [
131 {
132 "valueLookup": null,
133 "value": " - ",
134 "scriptId": "custbody_breadwinner_pc_internal_id",
135 "internalId": "588",
136 "fieldType": null
137 },
138 {
139 "valueLookup": null,
140 "value": "false",
141 "scriptId": "custbody_checkbox",
142 "internalId": "272",
143 "fieldType": null
144 },
145 {
146 "valueLookup": null,
147 "value": "false",
148 "scriptId": "custbody_edoc_gen_trans_pdf",
149 "internalId": "925",
150 "fieldType": null
151 },
152 {
153 "valueLookup": null,
154 "value": "false",
155 "scriptId": "custbody_ei_ds_txn_identifier",
156 "internalId": "932",
157 "fieldType": null
158 }
159 ]
160 },
161 "currencyRecord": {
162 "type": null,
163 "name": "SGD",
164 "internalId": "6",
165 "externalId": null
166 },
167 "currencyName": "SGD",
168 "createdFrom": null,
169 "createdDate": 1643036958,
170 "classification": {
171 "type": null,
172 "name": "Testing",
173 "internalId": "3",
174 "externalId": null
175 }
176 },
177 {
178 "tranId": "148",
179 "tranDate": 1623567600,
180 "totalCostEstimate": null,
181 "total": 1.18,
182 "taxTotal": 0.18,
183 "subTotal": 1.0,
184 "subsidiary": {
185 "type": null,
186 "name": "Atlanta",
187 "internalId": "20",
188 "externalId": null
189 },
190 "status": "Pending Receipt",
191 "source": "Web Services",
192 "salesRep": null,
193 "salesforceID": null,
194 "salesEffectiveDate": 1623567600,
195 "otherRefNum": null,
196 "orderStatus": null,
197 "nullFieldList": null,
198 "memo": "3",
199 "location": null,
200 "lastModifiedDate": 1643369750,
201 "itemList": {
202 "replaceAll": null,
203 "item": [
204 {
205 "unitsDisplay": null,
206 "taxRate1": "18.0",
207 "taxCode": {
208 "type": null,
209 "name": "VAT_IN:GST 18",
210 "internalId": "36",
211 "externalId": null
212 },
213 "tax1Amt": 0.18,
214 "shipMethod": null,
215 "shipGroup": null,
216 "serialNumbers": null,
217 "revRecStartDate": null,
218 "revRecSchedule": null,
219 "revRecEndDate": null,
220 "rate": "1.00",
221 "quantityRemaining": null,
222 "quantityReceived": 0.0,
223 "quantityBilled": 0.0,
224 "quantity": 1.0,
225 "price": null,
226 "poNum": null,
227 "orderLine": null,
228 "onHand": null,
229 "location": null,
230 "line": 1,
231 "jobName": null,
232 "itemReceive": null,
233 "itemName": null,
234 "itemIsFulfilled": null,
235 "item": {
236 "type": null,
237 "name": "Touch Pad Pro",
238 "internalId": "570",
239 "externalId": null
240 },
241 "grossAmt": 1.18,
242 "expectedReceiptDate": null,
243 "description": "linedesc",
244 "department": null,
245 "customFieldList": {
246 "customField": [
247 {
248 "valueLookup": null,
249 "value": "false",
250 "scriptId": "custcol_checkbox",
251 "internalId": "443",
252 "fieldType": null
253 }
254 ]
255 },
256 "createPo": null,
257 "costEstimateType": null,
258 "costEstimate": null,
259 "classification": null,
260 "amount": 1.0
261 }
262 ]
263 },
264 "internalId": "95012",
265 "externalId": null,
266 "entity": {
267 "type": null,
268 "name": "CUST1034AT Test Account65117",
269 "internalId": "74092",
270 "externalId": null
271 },
272 "discountTotal": null,
273 "discountRate": null,
274 "discountItem": null,
275 "department": {
276 "type": null,
277 "name": "test",
278 "internalId": "3",
279 "externalId": null
280 },
281 "customForm": null,
282 "customFieldList": {
283 "customField": [
284 {
285 "valueLookup": null,
286 "value": " - ",
287 "scriptId": "custbody_breadwinner_pc_internal_id",
288 "internalId": "588",
289 "fieldType": null
290 },
291 {
292 "valueLookup": null,
293 "value": "false",
294 "scriptId": "custbody_checkbox",
295 "internalId": "272",
296 "fieldType": null
297 },
298 {
299 "valueLookup": null,
300 "value": "false",
301 "scriptId": "custbody_edoc_gen_trans_pdf",
302 "internalId": "925",
303 "fieldType": null
304 },
305 {
306 "valueLookup": null,
307 "value": "false",
308 "scriptId": "custbody_ei_ds_txn_identifier",
309 "internalId": "932",
310 "fieldType": null
311 }
312 ]
313 },
314 "currencyRecord": {
315 "type": null,
316 "name": "SGD",
317 "internalId": "6",
318 "externalId": null
319 },
320 "currencyName": "SGD",
321 "createdFrom": null,
322 "createdDate": 1643369750,
323 "classification": {
324 "type": null,
325 "name": "Testing",
326 "internalId": "3",
327 "externalId": null
328 }
329 }
330 ],
331 },
332}
Updated 20 Jun 2023
Did this page help you?