Global API
...
Requests
Invoice
Read
2min
To read Invoices, 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 Invoice. 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=readInvoice,
3 timestamp=1657006553277,
4 validRequest=true,
5 version=1.0,
6 responseJSON={
7 "currentPageRecords": null,
8 "totalRecords": 2,
9 "totalPages": 1,
10 "searchId": "WEBSERVICES_5333445_SB1_07052022850827757644992188_17adb3bb3",
11 "pageIndex": 1,
12 "errors": [
13
14 ],
15 "customParamters": {
16 "where": {
17 "value": null,
18 "keyValueMap": {
19 "internalId": "94209,94308"
20 }
21 }
22 },
23 "status": "200""invoices": [
24 {
25 "undepFunds": null,
26 "tranId": "INV439",
27 "tranDate": 1642752000,
28 "total": 1.18,
29 "terms": null,
30 "taxTotal": 0.18,
31 "subTotal": 1.0,
32 "subsidiary": {
33 "type": null,
34 "name": "Atlanta",
35 "internalId": "20",
36 "externalId": null
37 },
38 "status": "Paid In Full",
39 "shippingCost": null,
40 "shippingAddress": null,
41 "salesRep": null,
42 "salesforceID": null,
43 "otherRefNum": null,
44 "nullFieldList": null,
45 "memo": "3",
46 "location": {
47 "type": null,
48 "name": "Testing",
49 "internalId": "14",
50 "externalId": null
51 },
52 "lastModifiedDate": 1645105569,
53 "itemList": {
54 "replaceAll": null,
55 "item": [
56 {
57 "unitsDisplay": null,
58 "taxRate1": "18.0",
59 "taxCode": {
60 "type": null,
61 "name": "VAT_IN:GST 18",
62 "internalId": "36",
63 "externalId": null
64 },
65 "tax1Amt": 0.18,
66 "shipMethod": null,
67 "shipGroup": null,
68 "serialNumbers": null,
69 "revRecStartDate": null,
70 "revRecSchedule": null,
71 "revRecEndDate": null,
72 "rate": "1.00",
73 "quantityRemaining": null,
74 "quantityReceived": null,
75 "quantityBilled": null,
76 "quantity": 1.0,
77 "price": null,
78 "poNum": null,
79 "orderLine": null,
80 "onHand": null,
81 "location": null,
82 "line": 1,
83 "jobName": null,
84 "itemReceive": null,
85 "itemName": null,
86 "itemIsFulfilled": null,
87 "item": {
88 "type": null,
89 "name": "Touch Pad Pro",
90 "internalId": "570",
91 "externalId": null
92 },
93 "grossAmt": 1.18,
94 "expectedReceiptDate": null,
95 "description": "linedesc",
96 "department": null,
97 "customFieldList": {
98 "customField": [
99 {
100 "valueLookup": null,
101 "value": "false",
102 "scriptId": "custcol_checkbox",
103 "internalId": "443",
104 "fieldType": null
105 },
106 {
107 "valueLookup": null,
108 "value": "1",
109 "scriptId": "custcol_gh_line_no",
110 "internalId": "175",
111 "fieldType": null
112 }
113 ]
114 },
115 "createPo": null,
116 "costEstimateType": null,
117 "costEstimate": null,
118 "classification": null,
119 "amount": 1.0
120 }
121 ]
122 },
123 "internalId": "94209",
124 "handlingCost": null,
125 "externalId": null,
126 "exchangeRate": 0.02,
127 "entity": {
128 "type": null,
129 "name": "CUST975AT Test Account62105",
130 "internalId": "72596",
131 "externalId": null
132 },
133 "dueDate": 1623567600,
134 "discountTotal": null,
135 "discountRate": null,
136 "discountItem": null,
137 "department": {
138 "type": null,
139 "name": "test",
140 "internalId": "3",
141 "externalId": null
142 },
143 "customForm": null,
144 "customFieldList": {
145 "customField": [
146 {
147 "valueLookup": null,
148 "value": " - ",
149 "scriptId": "custbody_breadwinner_pc_internal_id",
150 "internalId": "588",
151 "fieldType": null
152 },
153 {
154 "valueLookup": null,
155 "value": "false",
156 "scriptId": "custbody_checkbox",
157 "internalId": "272",
158 "fieldType": null
159 },
160 {
161 "valueLookup": null,
162 "value": "false",
163 "scriptId": "custbody_edoc_gen_trans_pdf",
164 "internalId": "925",
165 "fieldType": null
166 },
167 {
168 "valueLookup": null,
169 "value": "false",
170 "scriptId": "custbody_ei_ds_txn_identifier",
171 "internalId": "932",
172 "fieldType": null
173 }
174 ]
175 },
176 "currencyRecord": {
177 "type": null,
178 "name": "SGD",
179 "internalId": "6",
180 "externalId": null
181 },
182 "currencyName": "SGD",
183 "createdFrom": null,
184 "createdDate": 1642770141,
185 "classification": {
186 "type": null,
187 "name": "Testing",
188 "internalId": "3",
189 "externalId": null
190 },
191 "billingAddress": {
192 "zip": "500081",
193 "state": "Telangana",
194 "internalId": "79380",
195 "country": "_india",
196 "city": "Hyderabad",
197 "attention": null,
198 "addrPhone": null,
199 "addressee": "Test Account62105",
200 "addr3": null,
201 "addr2": null,
202 "addr1": "Nehrunagar"
203 },
204 "account": {
205 "type": null,
206 "name": "Accounts Receivable",
207 "internalId": "122",
208 "externalId": null
209 }
210 },
211 {
212 "undepFunds": null,
213 "tranId": "INV440",
214 "tranDate": 1643011200,
215 "total": 1.18,
216 "terms": null,
217 "taxTotal": 0.18,
218 "subTotal": 1.0,
219 "subsidiary": {
220 "type": null,
221 "name": "Atlanta",
222 "internalId": "20",
223 "externalId": null
224 },
225 "status": "Pending Approval",
226 "shippingCost": null,
227 "shippingAddress": null,
228 "salesRep": null,
229 "salesforceID": null,
230 "otherRefNum": null,
231 "nullFieldList": null,
232 "memo": "3",
233 "location": {
234 "type": null,
235 "name": "Testing",
236 "internalId": "14",
237 "externalId": null
238 },
239 "lastModifiedDate": 1643008927,
240 "itemList": {
241 "replaceAll": null,
242 "item": [
243 {
244 "unitsDisplay": null,
245 "taxRate1": "18.0",
246 "taxCode": {
247 "type": null,
248 "name": "VAT_IN:GST 18",
249 "internalId": "36",
250 "externalId": null
251 },
252 "tax1Amt": 0.18,
253 "shipMethod": null,
254 "shipGroup": null,
255 "serialNumbers": null,
256 "revRecStartDate": null,
257 "revRecSchedule": null,
258 "revRecEndDate": null,
259 "rate": "1.00",
260 "quantityRemaining": null,
261 "quantityReceived": null,
262 "quantityBilled": null,
263 "quantity": 1.0,
264 "price": null,
265 "poNum": null,
266 "orderLine": null,
267 "onHand": null,
268 "location": null,
269 "line": 1,
270 "jobName": null,
271 "itemReceive": null,
272 "itemName": null,
273 "itemIsFulfilled": null,
274 "item": {
275 "type": null,
276 "name": "Touch Pad Pro",
277 "internalId": "570",
278 "externalId": null
279 },
280 "grossAmt": 1.18,
281 "expectedReceiptDate": null,
282 "description": "linedesc",
283 "department": null,
284 "customFieldList": {
285 "customField": [
286 {
287 "valueLookup": null,
288 "value": "false",
289 "scriptId": "custcol_checkbox",
290 "internalId": "443",
291 "fieldType": null
292 }
293 ]
294 },
295 "createPo": null,
296 "costEstimateType": null,
297 "costEstimate": null,
298 "classification": null,
299 "amount": 1.0
300 }
301 ]
302 },
303 "internalId": "94308",
304 "handlingCost": null,
305 "externalId": null,
306 "exchangeRate": 0.02,
307 "entity": {
308 "type": null,
309 "name": "CUST980AT Test Account62105",
310 "internalId": "72888",
311 "externalId": null
312 },
313 "dueDate": 1623567600,
314 "discountTotal": null,
315 "discountRate": null,
316 "discountItem": null,
317 "department": {
318 "type": null,
319 "name": "test",
320 "internalId": "3",
321 "externalId": null
322 },
323 "customForm": null,
324 "customFieldList": {
325 "customField": [
326 {
327 "valueLookup": null,
328 "value": " - ",
329 "scriptId": "custbody_breadwinner_pc_internal_id",
330 "internalId": "588",
331 "fieldType": null
332 },
333 {
334 "valueLookup": null,
335 "value": "false",
336 "scriptId": "custbody_checkbox",
337 "internalId": "272",
338 "fieldType": null
339 },
340 {
341 "valueLookup": null,
342 "value": "false",
343 "scriptId": "custbody_edoc_gen_trans_pdf",
344 "internalId": "925",
345 "fieldType": null
346 },
347 {
348 "valueLookup": null,
349 "value": "false",
350 "scriptId": "custbody_ei_ds_txn_identifier",
351 "internalId": "932",
352 "fieldType": null
353 }
354 ]
355 },
356 "currencyRecord": {
357 "type": null,
358 "name": "SGD",
359 "internalId": "6",
360 "externalId": null
361 },
362 "currencyName": "SGD",
363 "createdFrom": null,
364 "createdDate": 1643008927,
365 "classification": {
366 "type": null,
367 "name": "Testing",
368 "internalId": "3",
369 "externalId": null
370 },
371 "billingAddress": {
372 "zip": "500081",
373 "state": "Telangana",
374 "internalId": "79672",
375 "country": "_india",
376 "city": "Hyderabad",
377 "attention": null,
378 "addrPhone": null,
379 "addressee": "Test Account62105",
380 "addr3": null,
381 "addr2": null,
382 "addr1": "Nehrunagar"
383 },
384 "account": {
385 "type": null,
386 "name": "Accounts Receivable",
387 "internalId": "122",
388 "externalId": null
389 }
390 }
391 ],
392 },
393}
