Update document information

PUT

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

PUT

/documents/:id

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

Update the extracted data or custom metadata of a document. The document must be in pendingCorrection state. Documents in other states (such as approved) cannot be modified through this endpoint — a 403 error will be returned.

To change a document’s state, use the dedicated Update document public state endpoint.

Update the extracted data or custom metadata of a document. The document must be in `pendingCorrection` state. Documents in other states (such as `approved`) cannot be modified through this endpoint — a `403` error will be returned. To change a document's state, use the dedicated [Update document public state](/api-reference/main-reference/documents/change-the-public-state-of-a-document) endpoint.

Autenticación

x-api-keystring

Autenticación con clave API vía encabezado

Parámetros de ruta

idstringRequerido

id of the document to modify

Solicitud

This endpoint expects an object.

datamap from strings to objectsOpcional

Document data to update. Can contain any field extracted from the document.

clientDatamap from strings to anyOpcional

Custom metadata object for your application's use. This data is stored with the document but not processed by Invofox.

Respuesta

Updated document

_idstringformat: "DocumentId"

accountstringformat: "AccountId"

Account the document belongs to.

environmentstringformat: "EnvironmentId"

Environment the document belongs to.

companystringformat: "CompanyId"

Company the document belongs to.

creatorstringformat: "UserId"

User that uploaded the document

clientDataobject

“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> } ].”

typeenum

namestring

Original name of the uploaded file

isGroundTruthboolean

Indicates the document is marked as Ground Truth (GT)

creationstringformat: "date-time"

Upload timestamp

imageslist of strings

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

originalstringformat: "URL"

Azure Storage URL (SAS) to access the original file

mimetypestring

datamap from strings to any

Extracted document data. Structure varies by document type.

publicStateenumValor predeterminado: processing

confidenceenum

processInfoobject

validationInfoobject

approvalInfoobject

importobject

exportslist of objects

geometryobject

deletedboolean

Indicates whether the document has been logically deleted

duplicatedbooleanDeprecated

Errores

400

Bad Request Error

403

Forbidden Error

410

Gone Error

429

Too Many Requests Error

500

Internal Server Error