Get document info

GET

https://api.invofox.com/documents/:id

GET

/documents/:id

1 const url = 'https://api.invofox.com/documents/id';
2 const options = {
3   method: 'GET',
4   headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "_id": "52543ec6d13ac7000bb90823",
3   "company": "54aadbb7e79e2aba5d25f3e3",
4   "clientData": {},
5   "type": "invoice",
6   "name": "Invoice_INVCZ4761199.pdf",
7   "isGroundTruth": false,
8   "creation": "2022-04-11T14:44:22.785Z",
9   "images": [
10     "https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-1.png",
11     "https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-2.png",
12     "https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-3.png",
13     "https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-4.png",
14     "https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-5.png",
15     "https://kinequo.blob.core.windows.net/midas/invoices/images/63f34163e8a7430008b38007-6.png"
16   ],
17   "original": "https://kinequo.blob.core.windows.net/midas/invoices/originals/52543ec6d13ac7000bb90823?st=2022-04-29T07%3A16%3A58Z&se=2022-04-29T07%3A46%3A58Z&sp=r&sv=2018-03-28&sr=b&sig=%2FmjG8fY516G2E5qrKhGhg269uuNdq94CJKznssYYxDvI%3D",
18   "mimetype": "application/pdf",
19   "data": {
20     "currency": {
21       "value": "EUR",
22       "confidence": 1
23     },
24     "language": {
25       "value": "es",
26       "confidence": 1
27     },
28     "isCreditNote": {},
29     "numberFormat": {
30       "value": [
31         ".,"
32       ],
33       "confidence": 1
34     },
35     "seriesCode": {
36       "value": "",
37       "confidence": 0
38     },
39     "invoiceRef": {
40       "value": "",
41       "confidence": 0
42     },
43     "taxClass": {
44       "value": "IGIC",
45       "confidence": 1
46     },
47     "issuerCountry": {
48       "value": "ES",
49       "confidence": 1
50     },
51     "recipientCountry": {
52       "value": "ES",
53       "confidence": 0.9909
54     },
55     "issuerAddressDetails": {
56       "value": {
57         "text": "Avenida de América 115, 28042, Alameda de Osuna, Madrid, Comunidad de Madrid, ESP",
58         "addressNumber": "115",
59         "country": "ES",
60         "municipality": "Madrid",
61         "neighborhood": "Alameda de Osuna",
62         "postalCode": "28042",
63         "region": "Comunidad de Madrid",
64         "street": "Avenida de América",
65         "subRegion": "Madrid"
66       },
67       "confidence": 1
68     },
69     "recipientAddressDetails": {
70       "value": {
71         "text": "Calle de Bravo Murillo 102, 28020, Cuatro Caminos, Madrid, Comunidad de Madrid, ESP",
72         "addressNumber": "102",
73         "country": "ES",
74         "municipality": "Madrid",
75         "neighborhood": "Cuatro Caminos",
76         "postalCode": "28020",
77         "region": "Comunidad de Madrid",
78         "street": "Calle de Bravo Murillo",
79         "subRegion": "Madrid"
80       },
81       "confidence": 0.9909
82     },
83     "exchangeRate": {},
84     "companyActsLike": {
85       "value": "recipient",
86       "confidence": 1
87     },
88     "incoterms": {
89       "value": null,
90       "confidence": 0
91     },
92     "bankSortCode": {
93       "value": null,
94       "confidence": 0
95     },
96     "bankAccountNumber": {
97       "value": null,
98       "confidence": 0
99     },
100     "bankRoutingNumber": {
101       "value": null,
102       "confidence": 0
103     },
104     "bankAccountName": {
105       "value": null,
106       "confidence": 0
107     },
108     "paymentTerms": {
109       "value": null,
110       "confidence": 0
111     },
112     "additionalData": [
113       {
114         "_id": {
115           "$oid": "63f341716985fe00080a925f",
116           "values": {}
117         }
118       }
119     ],
120     "additionalDataMode": "global",
121     "lines": {
122       "group": {
123         "value": "",
124         "confidence": 0
125       },
126       "identifier": {
127         "value": "",
128         "confidence": 0
129       },
130       "description": {
131         "value": "Vodafone One Ilimitada Super (Fibra 600Mb) (681166545 - 912873472) Jun. a 21 Jul.)",
132         "confidence": 1
133       },
134       "date": {
135         "value": null,
136         "confidence": 0
137       },
138       "quantity": {
139         "value": 0.82,
140         "confidence": 1
141       },
142       "unitOfMeasurement": {
143         "value": "",
144         "confidence": 0
145       },
146       "grossUnitPrice": {
147         "value": 70.24,
148         "confidence": 1
149       },
150       "taxBaseUnitPrice": {
151         "value": null,
152         "confidence": 0
153       },
154       "totalUnitPrice": {
155         "value": null,
156         "confidence": 0
157       },
158       "discountAmount": {
159         "value": null,
160         "confidence": 0
161       },
162       "discountRate": {
163         "value": null,
164         "confidence": 0
165       },
166       "taxRate": {
167         "value": 21,
168         "confidence": 0.7125
169       },
170       "taxAmount": {
171         "value": 12.15,
172         "confidence": 0.85625
173       },
174       "taxBaseAmount": {
175         "value": 57.84,
176         "confidence": 1
177       },
178       "totalAmount": {
179         "value": 69.99,
180         "confidence": 0.928125
181       },
182       "grossAmount": {
183         "value": null,
184         "confidence": 0
185       },
186       "feesAmount": {
187         "value": null,
188         "confidence": 0
189       },
190       "feesRate": {
191         "value": null,
192         "confidence": 0
193       }
194     },
195     "breakdowns": {
196       "taxRate": {
197         "value": 21,
198         "confidence": 0.7916666666666666
199       },
200       "taxBaseAmount": {
201         "value": 99.56,
202         "confidence": 0.7916666666666666
203       },
204       "taxAmount": {
205         "value": 20.91,
206         "confidence": 0.7916666666666666
207       },
208       "totalAmount": {
209         "value": 120.47,
210         "confidence": 0.7916666666666666
211       },
212       "grossAmount": {
213         "value": 99.56,
214         "confidence": 0.7916666666666666
215       },
216       "RERate": {
217         "value": 0,
218         "confidence": 0.7916666666666666
219       },
220       "REAmount": {
221         "value": 0,
222         "confidence": 0.7916666666666666
223       },
224       "discountBaseAmount": {
225         "value": 0,
226         "confidence": 0.7916666666666666
227       },
228       "discountAmount": {
229         "value": 0,
230         "confidence": 0.7916666666666666
231       },
232       "discountRate": {
233         "value": 0,
234         "confidence": 0.7916666666666666
235       },
236       "feesBaseAmount": {
237         "value": 0,
238         "confidence": 0.7916666666666666
239       },
240       "feesAmount": {
241         "value": 0,
242         "confidence": 0.7916666666666666
243       },
244       "feesRate": {
245         "value": 0,
246         "confidence": 0.7916666666666666
247       }
248     },
249     "dues": {
250       "date": {
251         "value": "2023-01-31",
252         "confidence": 1
253       },
254       "amount": {
255         "value": null,
256         "confidence": 0
257       }
258     },
259     "IBAN": {},
260     "SWIFT": {},
261     "additionalNotes": {
262       "value": null,
263       "confidence": 0
264     },
265     "totalDueAmount": {
266       "value": 120.47,
267       "confidence": 0.7916666666666666
268     },
269     "clientCode": {
270       "value": null,
271       "confidence": 0
272     },
273     "contractRef": {
274       "value": null,
275       "confidence": 0
276     },
277     "deliveryNoteRef": {
278       "value": null,
279       "confidence": 0
280     },
281     "documentNumber": {
282       "value": "ZI20-002898113",
283       "confidence": 1
284     },
285     "documentReference": {},
286     "documentSeries": {
287       "value": null,
288       "confidence": 0
289     },
290     "documentType": {
291       "value": "normal",
292       "confidence": 1
293     },
294     "additionalChargesAmount": {
295       "value": 0,
296       "confidence": 0.7916666666666666
297     },
298     "additionalDiscountsAmount": {
299       "value": 0,
300       "confidence": 0.7916666666666666
301     },
302     "issueDate": {
303       "value": "2023-01-31",
304       "confidence": 1
305     },
306     "issuerAddress": {
307       "value": "Avenida de América 115, 28042, Madrid",
308       "confidence": 1
309     },
310     "issuerEmail": {
311       "value": null,
312       "confidence": 0
313     },
314     "issuerFax": {
315       "value": null,
316       "confidence": 0
317     },
318     "issuerName": {
319       "value": "VODAFONE SERVICIOS SLU",
320       "confidence": 0.9318181818181819
321     },
322     "issuerPhoneNumber": {
323       "value": null,
324       "confidence": 0
325     },
326     "issuerTaxId": {
327       "value": "ESB87539284",
328       "confidence": 0.9318181818181819
329     },
330     "issuerWebsite": {
331       "value": "vodafone.es",
332       "confidence": 1
333     },
334     "legalNotes": {
335       "value": null,
336       "confidence": 0
337     },
338     "orderRef": {
339       "value": null,
340       "confidence": 0
341     },
342     "paymentMethod": {
343       "value": "Domiciliación bancaria",
344       "confidence": 1
345     },
346     "recipientAddress": {
347       "value": "CL BRAVO MURILLO 102 2º IZ 28020 MADRID MADRID España",
348       "confidence": 1
349     },
350     "recipientEmail": {
351       "value": null,
352       "confidence": 0
353     },
354     "recipientFax": {
355       "value": null,
356       "confidence": 0
357     },
358     "recipientName": {
359       "value": "KINEQUO SL",
360       "confidence": 1
361     },
362     "recipientPhoneNumber": {
363       "value": null,
364       "confidence": 0
365     },
366     "shippingAddress": {
367       "value": null,
368       "confidence": 0
369     },
370     "recipientTaxId": {
371       "value": "ESB87334876",
372       "confidence": 1
373     },
374     "recipientWebsite": {
375       "value": null,
376       "confidence": 0
377     },
378     "withholdingTaxAmount": {
379       "value": 0,
380       "confidence": 0.7916666666666666
381     },
382     "withholdingTaxRate": {
383       "value": 0,
384       "confidence": 0.7916666666666666
385     },
386     "totalGrossAmount": {
387       "value": 99.56,
388       "confidence": 0.7916666666666666
389     },
390     "reimbursableExpensesAmount": {
391       "value": 0,
392       "confidence": 0.7916666666666666
393     },
394     "totalTaxBaseAmount": {
395       "value": 99.56,
396       "confidence": 0.7916666666666666
397     },
398     "totalAmount": {
399       "value": 120.47,
400       "confidence": 0.7916666666666666
401     },
402     "totalDiscountAmount": {
403       "value": 0,
404       "confidence": 0.7916666666666666
405     },
406     "totalFeesAmount": {
407       "value": 0,
408       "confidence": 0.7916666666666666
409     },
410     "totalTaxAmount": {
411       "value": 20.91,
412       "confidence": 0.7916666666666666
413     },
414     "serviceAddress": {
415       "values": "",
416       "confidence": 0
417     },
418     "supplyNumber": {
419       "value": 0,
420       "confidence": 0
421     },
422     "meterNumber": {
423       "value": 0,
424       "confidence": 0
425     },
426     "totalUsage": {
427       "value": "0,",
428       "confidence": 0
429     },
430     "usageUnitOfMeasurement": {
431       "value": 0,
432       "confidence": 0
433     },
434     "readings": {
435       "previous": {
436         "value": 0,
437         "confidence": 0
438       },
439       "current": {
440         "value": 0,
441         "confidence": 0
442       },
443       "usage": {
444         "value": 0,
445         "confidence": 0
446       }
447     }
448   },
449   "publicState": "approved",
450   "confidence": "high",
451   "validationInfo": {
452     "errors": []
453   },
454   "approvalInfo": {
455     "beginning": "2024-01-15T09:30:00Z",
456     "result": "approved",
457     "steps": []
458   },
459   "import": {
460     "_id": "62547ec6d13ac7000b590822"
461   },
462   "exports": [],
463   "deleted": true,
464   "user": null
465 }

Autenticación

x-api-keystring

Autenticación con clave API vía encabezado

Parámetros de ruta

idstringRequerido

id of the document to retrieve

Respuesta

Get documento info

_idstringOpcionalformat: "DocumentId"

accountstringOpcionalformat: "AccountId"

Account the document belongs to.

environmentstringOpcionalformat: "EnvironmentId"

Environment the document belongs to.

companystringOpcionalformat: "CompanyId"

Company the document belongs to.

creatorstringOpcionalformat: "UserId"

User that uploaded the document

clientDataobjectOpcional

“Additional data to be added to each document. Must be an object or an array of objects. If data to be specified to each document is different, this parameter should have the following format: [ \{ _filename: \<name of the file to which attach this data>, <key>: <value> }, ... \{ _filename: \<name of the file to which attach this data>, <key>: <value> } ].”

typeenumOpcional

namestringOpcional

Original name of the uploaded file

isGroundTruthbooleanOpcional

Indicates the document is marked as Ground Truth (GT)

creationstringOpcionalformat: "date-time"

Upload timestamp

imageslist of stringsOpcional

Array of Azure Storage URLs (SAS) to access the document extracted images

originalstringOpcionalformat: "URL"

Azure Storage URL (SAS) to access the original file

mimetypestringOpcional

datamap from strings to anyOpcional

Extracted document data. Structure varies by document type.

publicStateenumOpcionalValor predeterminado: processing

confidenceenumOpcional

processInfoobjectOpcional

validationInfoobjectOpcional

approvalInfoobjectOpcional

importobjectOpcional

exportslist of objectsOpcional

geometryobjectOpcional

deletedbooleanOpcional

Indicates whether the document has been logically deleted

duplicatedbooleanOpcionalDeprecated

Errores

400

Bad Request Error

410

Gone Error

429

Too Many Requests Error

500

Internal Server Error