Download Multiple Documents Data

POST

https://api.staple.io/v2/documents/download/data

POST

/v2/documents/download/data

$ curl -X POST https://api.staple.io/v2/documents/download/data \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "docIds": [
>     1,
>     2,
>     3
>   ],
>   "docType": "JSON",
>   "language": "EN"
> }'

200Download Multiple Documents Data

1 {
2   "downloadDataByDocIds": {
3     "data": [
4       {
5         "Account Name": "",
6         "Account Number": "",
7         "Additional PO Numbers": "PO 3330",
8         "Advance Tax": "",
9         "BIR Number": "",
10         "Bank Name": "",
11         "Billing Address": "PAYMENT ADVICE     T / A Vistalite Central 19 Manuka Street  TAUPO 3330",
12         "Comments": [],
13         "Currency": "NZD",
14         "Customer GST Number": "",
15         "Customer Name": "Great Lake Aluminium & Glass Limited",
16         "Delivery Order Number": "",
17         "Description Text": "",
18         "Discount": "",
19         "Discount Percent": "",
20         "Email": "admin@vistalitetaupo.co.nz - admin@vistalitetaupo.co",
21         "Exchange Currency From": "NZD",
22         "Exchange Currency To": "",
23         "FX Rate": "",
24         "File Name": "i4.pdf",
25         "Form Number": "",
26         "Freight": "",
27         "Govt. Verification": "",
28         "HSN SAC": "",
29         "IBAN": "",
30         "ISOCountryCode": "NZ",
31         "Invoice Date": "2019-02-21",
32         "Invoice Number": "INV-1441",
33         "Invoice Type": "Tax Invoice",
34         "Items": [
35           {
36             "Description": "Manufacture and install of 1 x bi fold",
37             "Quantity": "1.00",
38             "TableTitle": "Default Table",
39             "UnitAmount": "2,000.00",
40             "unmapped-text: Amount NZD0": "2,000.00"
41           }
42         ],
43         "Less Amount Paid": "450.0",
44         "Line Rows Check": "",
45         "NTN": "",
46         "Other Date": "",
47         "PO Number": "",
48         "Payment Date": "2019-03-08",
49         "Payment Term": "07",
50         "Project Name": "",
51         "Public Lighting Tax": "",
52         "Public Lighting Tax Percent": "",
53         "Registered Vendor Name": "",
54         "Registered Vendor Status": "",
55         "RubberStamp": "",
56         "Sales Order Number": "",
57         "Sales Tax": "",
58         "Sales Tax Percent": "",
59         "Serial Number": "",
60         "Shipping Address": "",
61         "Signature": "",
62         "Specific Tax": "",
63         "Specific Tax Percent": "",
64         "Subtotal": "2000.0",
65         "Subtotal Check": "",
66         "Swift Code": "",
67         "Tax Percent": "15%",
68         "Tax Total": "300.0",
69         "Total": "2300.0",
70         "Total Check": "",
71         "Total Rounding": "",
72         "URL": "",
73         "Unique Stamp": "",
74         "Vendor Address": "Great Lake Aluminium & Glass Limited T / A Vistalite Central 19 Manuka Street  TAUPO 3330 admin@vistalitetaupo.co.n",
75         "Vendor Fax Number": "",
76         "Vendor GST Number": "112-572-457",
77         "Vendor Name": "Glass Limited T/A",
78         "Vendor Name Check": "",
79         "Vendor Phone Number": "",
80         "Withholding Tax Total": ""
81       },
82       {
83         "Account Name": "",
84         "Account Number": "",
85         "Additional PO Numbers": "PO 3330",
86         "Advance Tax": "",
87         "BIR Number": "",
88         "Bank Name": "",
89         "Billing Address": "PAYMENT ADVICE     T / A Vistalite Central 19 Manuka Street  TAUPO 3330",
90         "Comments": [
91           {
92             "createdAt": "2022-11-30T04:13:06.765Z",
93             "message": "Message 1",
94             "receivers": [
95               {
96                 "receiver": "staple@staple.io"
97               }
98             ],
99             "sender": "staple@staple.io"
100           },
101           {
102             "createdAt": "2022-11-30T04:15:43.958Z",
103             "message": "Message 2",
104             "receivers": [
105               {
106                 "receiver": "staple@staple.io"
107               }
108             ],
109             "sender": "staple@staple.io"
110           },
111           {
112             "createdAt": "2022-11-30T04:17:51.142Z",
113             "message": "Message 3",
114             "receivers": [
115               {
116                 "receiver": "staple@staple.io"
117               }
118             ],
119             "sender": "staple@staple.io"
120           }
121         ],
122         "Currency": "NZD",
123         "Customer GST Number": "",
124         "Customer Name": "Great Lake Aluminium & Glass Limited",
125         "Delivery Order Number": "",
126         "Description Text": "",
127         "Discount": "",
128         "Discount Percent": "",
129         "Email": "admin@vistalitetaupo.co.nz - admin@vistalitetaupo.co",
130         "Exchange Currency From": "NZD",
131         "Exchange Currency To": "",
132         "FX Rate": "",
133         "File Name": "i4.pdf",
134         "Form Number": "",
135         "Freight": "",
136         "Govt. Verification": "",
137         "HSN SAC": "",
138         "IBAN": "",
139         "ISOCountryCode": "NZ",
140         "Invoice Date": "2019-02-21",
141         "Invoice Number": "INV-1441",
142         "Invoice Type": "Tax Invoice",
143         "Items": [
144           {
145             "Description": "Manufacture and install of 1 x bi fold",
146             "Quantity": "1.00",
147             "TableTitle": "Default Table",
148             "UnitAmount": "2,000.00",
149             "unmapped-text: Amount NZD0": "2,000.00"
150           }
151         ],
152         "Less Amount Paid": "450.0",
153         "Line Rows Check": "",
154         "NTN": "",
155         "Other Date": "",
156         "PO Number": "",
157         "Payment Date": "2019-03-08",
158         "Payment Term": "07",
159         "Project Name": "",
160         "Public Lighting Tax": "",
161         "Public Lighting Tax Percent": "",
162         "Registered Vendor Name": "",
163         "Registered Vendor Status": "",
164         "RubberStamp": "",
165         "Sales Order Number": "",
166         "Sales Tax": "",
167         "Sales Tax Percent": "",
168         "Serial Number": "",
169         "Shipping Address": "",
170         "Signature": "",
171         "Specific Tax": "",
172         "Specific Tax Percent": "",
173         "Subtotal": "2000.0",
174         "Subtotal Check": "",
175         "Swift Code": "",
176         "Tax Percent": "15%",
177         "Tax Total": "300.0",
178         "Total": "2300.0",
179         "Total Check": "",
180         "Total Rounding": "",
181         "URL": "",
182         "Unique Stamp": "",
183         "Vendor Address": "Great Lake Aluminium & Glass Limited T / A Vistalite Central 19 Manuka Street  TAUPO 3330 admin@vistalitetaupo.co.n",
184         "Vendor Fax Number": "",
185         "Vendor GST Number": "112-572-457",
186         "Vendor Name": "Glass Limited T/A",
187         "Vendor Name Check": "",
188         "Vendor Phone Number": "",
189         "Withholding Tax Total": ""
190       },
191       {
192         "Account Name": "",
193         "Account Number": "",
194         "Additional PO Numbers": "",
195         "Advance Tax": "",
196         "BIR Number": "",
197         "Bank Name": "",
198         "Billing Address": "",
199         "Comments": [],
200         "Currency": "USD",
201         "Customer GST Number": "",
202         "Customer Name": "",
203         "Delivery Order Number": "",
204         "Description Text": "",
205         "Discount": "",
206         "Discount Percent": "",
207         "Email": "herve@quod.ai",
208         "Exchange Currency From": "USD",
209         "Exchange Currency To": "",
210         "FX Rate": "",
211         "File Name": "re-in.pdf",
212         "Form Number": "",
213         "Freight": "",
214         "Govt. Verification": "",
215         "HSN SAC": "",
216         "IBAN": "",
217         "ISOCountryCode": "US",
218         "Invoice Date": "2019-08-22",
219         "Invoice Number": "21640",
220         "Invoice Type": "Invoice",
221         "Items": [
222           {
223             "TableTitle": "Default Table",
224             "TaxRate": "USD 35",
225             "UnitAmount": "USD 160.30",
226             "unmapped-text: Hours1": "4.58 h",
227             "unmapped-text: Projects0": "37972-Improve Existing Presentation Date: 22/Aug/2019-02/Sep/2019 Customer: herve@quod.ai"
228           },
229           {
230             "LineAmount": "USD 160.30",
231             "Other": "CREDITCARD Date: 03/09/2019",
232             "TableTitle": "Default Table"
233           }
234         ],
235         "Less Amount Paid": "",
236         "Line Rows Check": "",
237         "NTN": "",
238         "Other Date": "2019-08-22",
239         "PO Number": "",
240         "Payment Date": "2019-09-17",
241         "Payment Term": "",
242         "Project Name": "",
243         "Public Lighting Tax": "",
244         "Public Lighting Tax Percent": "",
245         "Registered Vendor Name": "",
246         "Registered Vendor Status": "",
247         "RubberStamp": "",
248         "Sales Order Number": "",
249         "Sales Tax": "",
250         "Sales Tax Percent": "",
251         "Serial Number": "",
252         "Shipping Address": "",
253         "Signature": "",
254         "Specific Tax": "",
255         "Specific Tax Percent": "",
256         "Subtotal": "",
257         "Subtotal Check": "",
258         "Swift Code": "",
259         "Tax Percent": "",
260         "Tax Total": "",
261         "Total": "160.3",
262         "Total Check": "",
263         "Total Rounding": "",
264         "URL": "",
265         "Unique Stamp": "",
266         "Vendor Address": "Konsus Inc  EIN : 61-1776321 470 Ramona Street Palo Alto CA 94301 United States",
267         "Vendor Fax Number": "",
268         "Vendor GST Number": "",
269         "Vendor Name": "",
270         "Vendor Name Check": "",
271         "Vendor Phone Number": "",
272         "Withholding Tax Total": ""
273       }
274     ],
275     "message": "Downloaded document successfully."
276   }
277 }

Select the download format and specify the doc IDs in an array to get the downloaded information.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Request

This endpoint expects an object.

docIdslist of integersOptional

docTypestringOptional

languagestringOptional

includeConfidencebooleanOptionalDefaults to false

JSON and XML only — adds a “Confidence” block per document with scores for document fields, table column headers, table cells and each table (complex tables only). Has no effect on CSV and TXT. Must be true or false; any other value returns HTTP 400. Scores are 0–1 rounded to 2 decimals; null means unmeasured. Documents with no measured scores (predefined models such as Invoice, or documents scanned before confidence scoring existed) return “Confidence”: null in JSON and an empty <Confidence/> element in XML — integrations must handle both forms. “Confidence” is a reserved key name.

JSON and XML only — adds a "Confidence" block per document with scores for document fields, table column headers, table cells and each table (complex tables only). Has no effect on CSV and TXT. Must be true or false; any other value returns HTTP 400. Scores are 0–1 rounded to 2 decimals; null means unmeasured. Documents with no measured scores (predefined models such as Invoice, or documents scanned before confidence scoring existed) return "Confidence": null in JSON and an empty `<Confidence/>` element in XML — integrations must handle both forms. "Confidence" is a reserved key name.

Authentication

Request

Response