Global API
...
Requests
Credit Memo
Read
2min
To read Credit Memos, 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 Customer. 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=readCreditMemo,
3 timestamp= 1682507750255,
4 validRequest=true,
5 version=1.0,
6 responseJSON={
7 "currentPageRecords": 2,
8 "totalRecords": 2,
9 "totalPages": 1,
10 "searchId": "WEBSERVICES_5333445_042620231119430988205277638_1320f0b19719",
11 "pageIndex": 1,
12 "errors": [],
13 "customParamters": {
14 "where": {
15 "value": null,
16 "keyValueMap": {
17 "subsidiary": "1,2",
18 "additionalFilter": "lastModifiedDate%3E1682507614%2Band%2BlastModifiedDate%3C1682507708"
19 }
20 }
21 },
22 "status": "200",
23 "creditMemos": [
24 {
25 "tranId": "171",
26 "tranDate": 1682478000,
27 "total": 4183.64,
28 "taxTotal": 638.19,
29 "subTotal": 3545.45,
30 "subsidiary": {
31 "type": null,
32 "name": "Parent Company",
33 "internalId": "1",
34 "externalId": null
35 },
36 "status": "Open",
37 "shippingCost": null,
38 "salesRep": null,
39 "salesforceID": null,
40 "refundCheck": null,
41 "otherRefNum": null,
42 "memo": null,
43 "location": {
44 "type": null,
45 "name": "test 1",
46 "internalId": "13",
47 "externalId": null
48 },
49 "lastModifiedDate": 1682507663,
50 "job": null,
51 "itemList": {
52 "replaceAll": null,
53 "item": [
54 {
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": 638.19,
64 "shipMethod": null,
65 "shipGroup": null,
66 "serialNumbers": "1",
67 "revRecStartDate": null,
68 "revRecSchedule": null,
69 "revRecEndDate": null,
70 "rate": "3545.45454545",
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": "Alternate Price 2",
85 "internalId": "3",
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": 4183.64,
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 },
120 "createPo": null,
121 "costEstimateType": "_averageCost",
122 "costEstimate": 0.0,
123 "classification": null,
124 "billingSchedule": null,
125 "amount": 3545.45
126 }
127 ]
128 },
129 "internalId": "121663",
130 "handlingCost": null,
131 "externalId": null,
132 "exchangeRate": 0.011,
133 "entity": {
134 "type": null,
135 "name": "12 GS Solutions",
136 "internalId": "46",
137 "externalId": null
138 },
139 "discountTotal": null,
140 "discountRate": null,
141 "discountItem": null,
142 "department": null,
143 "customForm": null,
144 "customFieldList": {
145 "customField": [
146 {
147 "valueLookup": null,
148 "value": "1",
149 "scriptId": "custbody15",
150 "internalId": "182",
151 "fieldType": null
152 },
153 {
154 "valueLookup": null,
155 "value": "3545.45",
156 "scriptId": "custbody42",
157 "internalId": "869",
158 "fieldType": null
159 },
160 {
161 "valueLookup": null,
162 "value": "83890 - test 12223",
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_enableimport",
178 "internalId": "691",
179 "fieldType": null
180 }
181 ]
182 },
183 "currencyRecord": {
184 "type": null,
185 "name": "GBP",
186 "internalId": "5",
187 "externalId": null
188 },
189 "currencyName": "GBP",
190 "createdFrom": null,
191 "createdDate": 1682507663,
192 "classification": null,
193 "applyList": null,
194 "applied": 0.0,
195 "account": {
196 "type": null,
197 "name": "Accounts Receivable",
198 "internalId": "122",
199 "externalId": null
200 }
201 },
202 {
203 "unapplied": 2360.0,
204 "tranId": "172",
205 "tranDate": 1682478000,
206 "total": 2360.0,
207 "taxTotal": 360.0,
208 "subTotal": 2000.0,
209 "subsidiary": {
210 "type": null,
211 "name": "Parent Company",
212 "internalId": "1",
213 "externalId": null
214 },
215 "status": "Open",
216 "shippingCost": null,
217 "salesRep": null,
218 "salesforceID": null,
219 "refundCheck": null,
220 "otherRefNum": null,
221 "memo": null,
222 "location": {
223 "type": null,
224 "name": "Hyderabad : Hi-Tech City",
225 "internalId": "10",
226 "externalId": null
227 },
228 "lastModifiedDate": 1682507702,
229 "job": null,
230 "itemList": {
231 "replaceAll": null,
232 "item": [
233 {
234 "unitsDisplay": null,
235 "taxRate1": "18.0",
236 "taxCode": {
237 "type": null,
238 "name": "VAT_IN:GST 18",
239 "internalId": "36",
240 "externalId": null
241 },
242 "tax1Amt": 360.0,
243 "shipMethod": null,
244 "shipGroup": null,
245 "serialNumbers": null,
246 "revRecStartDate": null,
247 "revRecSchedule": null,
248 "revRecEndDate": null,
249 "rate": null,
250 "quantityRemaining": null,
251 "quantityReceived": null,
252 "quantityPicked": null,
253 "quantityPacked": null,
254 "quantityOnHand": null,
255 "quantityFulfilled": null,
256 "quantityCommitted": null,
257 "quantityBilled": null,
258 "quantityBackOrdered": null,
259 "quantityAvailable": null,
260 "quantity": 1.0,
261 "price": {
262 "type": null,
263 "name": "Custom",
264 "internalId": "-1",
265 "externalId": null
266 },
267 "poNum": null,
268 "percentComplete": null,
269 "orderLine": null,
270 "onHand": null,
271 "location": null,
272 "line": 1,
273 "jobName": null,
274 "itemReceive": null,
275 "itemName": null,
276 "itemIsFulfilled": null,
277 "item": {
278 "type": null,
279 "name": "Apple : Apple 001",
280 "internalId": "11538",
281 "externalId": null
282 },
283 "isClosed": null,
284 "grossAmt": 2360.0,
285 "expectedReceiptDate": null,
286 "description": "A refrigerator",
287 "department": null,
288 "customFieldList": {
289 "customField": [
290 {
291 "valueLookup": null,
292 "value": "false",
293 "scriptId": "custcol_checkbox",
294 "internalId": "443",
295 "fieldType": null
296 }
297 ]
298 },
299 "createPo": null,
300 "costEstimateType": "_averageCost",
301 "costEstimate": 0.0,
302 "classification": null,
303 "billingSchedule": null,
304 "amount": 2000.0
305 }
306 ]
307 },
308 "internalId": "121664",
309 "handlingCost": null,
310 "externalId": null,
311 "exchangeRate": 23.0,
312 "entity": {
313 "type": null,
314 "name": "12:1 GS Solutions : GS Solutions Sub Company",
315 "internalId": "22501",
316 "externalId": null
317 },
318 "discountTotal": null,
319 "discountRate": null,
320 "discountItem": null,
321 "department": null,
322 "customForm": null,
323 "customFieldList": {
324 "customField": [
325 {
326 "valueLookup": null,
327 "value": "1",
328 "scriptId": "custbody15",
329 "internalId": "182",
330 "fieldType": null
331 },
332 {
333 "valueLookup": null,
334 "value": "2000",
335 "scriptId": "custbody42",
336 "internalId": "869",
337 "fieldType": null
338 },
339 {
340 "valueLookup": null,
341 "value": "13730 - GH Contact",
342 "scriptId": "custbody_breadwinner_pc_internal_id",
343 "internalId": "588",
344 "fieldType": null
345 },
346 {
347 "valueLookup": null,
348 "value": "false",
349 "scriptId": "custbody_checkbox",
350 "internalId": "272",
351 "fieldType": null
352 },
353 {
354 "valueLookup": null,
355 "value": "false",
356 "scriptId": "custbody_enableimport",
357 "internalId": "691",
358 "fieldType": null
359 }
360 ]
361 },
362 "currencyRecord": {
363 "type": null,
364 "name": "US Dollars",
365 "internalId": "2",
366 "externalId": null
367 },
368 "currencyName": "US Dollars",
369 "createdFrom": null,
370 "createdDate": 1682507702,
371 "classification": null,
372 "applyList": null,
373 "applied": 0.0,
374 "account": {
375 "type": null,
376 "name": "Accounts Receivable",
377 "internalId": "122",
378 "externalId": null
379 }
380 }
381 ]
382 }
383}
