Update document information

PUT

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

PUT

/documents/:id

const url = 'https://api.invofox.com/documents/id';
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "_id": "000000000000000000000001",
  "company": "000000000000000000000002",
  "clientData": {},
  "type": "invoice",
  "name": "Invoice_INVCZ4761199.pdf",
  "isGroundTruth": false,
  "creation": "2022-04-11T14:44:22.785Z",
  "images": [
    "https://storage.example.com/invoices/images/000000000000000000000004-1.png",
    "https://storage.example.com/invoices/images/000000000000000000000004-2.png",
    "https://storage.example.com/invoices/images/000000000000000000000004-3.png",
    "https://storage.example.com/invoices/images/000000000000000000000004-4.png",
    "https://storage.example.com/invoices/images/000000000000000000000004-5.png",
    "https://storage.example.com/invoices/images/000000000000000000000004-6.png"
  ],
  "original": "https://storage.example.com/invoices/originals/000000000000000000000001",
  "mimetype": "application/pdf",
  "data": {
    "IBAN": {},
    "SWIFT": {},
    "additionalChargesAmount": {
      "confidence": 0.7916666666666666,
      "value": 0
    },
    "additionalData": [
      {
        "_id": {
          "$oid": "000000000000000000000005",
          "values": {}
        }
      }
    ],
    "additionalDataMode": "global",
    "additionalDiscountsAmount": {
      "confidence": 0.7916666666666666,
      "value": 0
    },
    "additionalNotes": {
      "confidence": 0,
      "value": null
    },
    "bankAccountName": {
      "confidence": 0,
      "value": null
    },
    "bankAccountNumber": {
      "confidence": 0,
      "value": null
    },
    "bankRoutingNumber": {
      "confidence": 0,
      "value": null
    },
    "bankSortCode": {
      "confidence": 0,
      "value": null
    },
    "breakdowns": {
      "REAmount": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "RERate": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "discountAmount": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "discountBaseAmount": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "discountRate": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "feesAmount": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "feesBaseAmount": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "feesRate": {
        "confidence": 0.7916666666666666,
        "value": 0
      },
      "grossAmount": {
        "confidence": 0.7916666666666666,
        "value": 99.56
      },
      "taxAmount": {
        "confidence": 0.7916666666666666,
        "value": 20.91
      },
      "taxBaseAmount": {
        "confidence": 0.7916666666666666,
        "value": 99.56
      },
      "taxRate": {
        "confidence": 0.7916666666666666,
        "value": 21
      },
      "totalAmount": {
        "confidence": 0.7916666666666666,
        "value": 120.47
      }
    },
    "clientCode": {
      "confidence": 0,
      "value": null
    },
    "companyActsLike": {
      "confidence": 1,
      "value": "recipient"
    },
    "contractRef": {
      "confidence": 0,
      "value": null
    },
    "currency": {
      "confidence": 1,
      "value": "EUR"
    },
    "deliveryNoteRef": {
      "confidence": 0,
      "value": null
    },
    "documentNumber": {
      "confidence": 1,
      "value": "ZI20-002898113"
    },
    "documentReference": {},
    "documentSeries": {
      "confidence": 0,
      "value": null
    },
    "documentType": {
      "confidence": 1,
      "value": "normal"
    },
    "dues": {
      "amount": {
        "confidence": 0,
        "value": null
      },
      "date": {
        "confidence": 1,
        "value": "2023-01-31"
      }
    },
    "exchangeRate": {},
    "incoterms": {
      "confidence": 0,
      "value": null
    },
    "invoiceRef": {
      "confidence": 0,
      "value": ""
    },
    "isCreditNote": {},
    "issueDate": {
      "confidence": 1,
      "value": "2023-01-31"
    },
    "issuerAddress": {
      "confidence": 1,
      "value": "Avenida de América 115, 28042, Madrid"
    },
    "issuerAddressDetails": {
      "confidence": 1,
      "value": {
        "addressNumber": "115",
        "country": "ES",
        "municipality": "Madrid",
        "neighborhood": "Alameda de Osuna",
        "postalCode": "28042",
        "region": "Comunidad de Madrid",
        "street": "Avenida de América",
        "subRegion": "Madrid",
        "text": "Avenida de América 115, 28042, Alameda de Osuna, Madrid, Comunidad de Madrid, ESP"
      }
    },
    "issuerCountry": {
      "confidence": 1,
      "value": "ES"
    },
    "issuerEmail": {
      "confidence": 0,
      "value": null
    },
    "issuerFax": {
      "confidence": 0,
      "value": null
    },
    "issuerName": {
      "confidence": 0.9318181818181819,
      "value": "VODAFONE SERVICIOS SLU"
    },
    "issuerPhoneNumber": {
      "confidence": 0,
      "value": null
    },
    "issuerTaxId": {
      "confidence": 0.9318181818181819,
      "value": "ESB87539284"
    },
    "issuerWebsite": {
      "confidence": 1,
      "value": "vodafone.es"
    },
    "language": {
      "confidence": 1,
      "value": "es"
    },
    "legalNotes": {
      "confidence": 0,
      "value": null
    },
    "lines": {
      "date": {
        "confidence": 0,
        "value": null
      },
      "description": {
        "confidence": 1,
        "value": "Vodafone One Ilimitada Super (Fibra 600Mb) (681166545 - 912873472) Jun. a 21 Jul.)"
      },
      "discountAmount": {
        "confidence": 0,
        "value": null
      },
      "discountRate": {
        "confidence": 0,
        "value": null
      },
      "feesAmount": {
        "confidence": 0,
        "value": null
      },
      "feesRate": {
        "confidence": 0,
        "value": null
      },
      "grossAmount": {
        "confidence": 0,
        "value": null
      },
      "grossUnitPrice": {
        "confidence": 1,
        "value": 70.24
      },
      "group": {
        "confidence": 0,
        "value": ""
      },
      "identifier": {
        "confidence": 0,
        "value": ""
      },
      "quantity": {
        "confidence": 1,
        "value": 0.82
      },
      "taxAmount": {
        "confidence": 0.85625,
        "value": 12.15
      },
      "taxBaseAmount": {
        "confidence": 1,
        "value": 57.84
      },
      "taxBaseUnitPrice": {
        "confidence": 0,
        "value": null
      },
      "taxRate": {
        "confidence": 0.7125,
        "value": 21
      },
      "totalAmount": {
        "confidence": 0.928125,
        "value": 69.99
      },
      "totalUnitPrice": {
        "confidence": 0,
        "value": null
      },
      "unitOfMeasurement": {
        "confidence": 0,
        "value": ""
      }
    },
    "meterNumber": {
      "confidence": 0,
      "value": 0
    },
    "numberFormat": {
      "confidence": 1,
      "value": [
        ".,"
      ]
    },
    "orderRef": {
      "confidence": 0,
      "value": null
    },
    "paymentMethod": {
      "confidence": 1,
      "value": "Domiciliación bancaria"
    },
    "paymentTerms": {
      "confidence": 0,
      "value": null
    },
    "readings": {
      "current": {
        "confidence": 0,
        "value": 0
      },
      "previous": {
        "confidence": 0,
        "value": 0
      },
      "usage": {
        "confidence": 0,
        "value": 0
      }
    },
    "recipientAddress": {
      "confidence": 1,
      "value": "CL BRAVO MURILLO 102 2º IZ 28020 MADRID MADRID España"
    },
    "recipientAddressDetails": {
      "confidence": 0.9909,
      "value": {
        "addressNumber": "102",
        "country": "ES",
        "municipality": "Madrid",
        "neighborhood": "Cuatro Caminos",
        "postalCode": "28020",
        "region": "Comunidad de Madrid",
        "street": "Calle de Bravo Murillo",
        "subRegion": "Madrid",
        "text": "Calle de Bravo Murillo 102, 28020, Cuatro Caminos, Madrid, Comunidad de Madrid, ESP"
      }
    },
    "recipientCountry": {
      "confidence": 0.9909,
      "value": "ES"
    },
    "recipientEmail": {
      "confidence": 0,
      "value": null
    },
    "recipientFax": {
      "confidence": 0,
      "value": null
    },
    "recipientName": {
      "confidence": 1,
      "value": "EXAMPLE CORP SL"
    },
    "recipientPhoneNumber": {
      "confidence": 0,
      "value": null
    },
    "recipientTaxId": {
      "confidence": 1,
      "value": "ESB87334876"
    },
    "recipientWebsite": {
      "confidence": 0,
      "value": null
    },
    "reimbursableExpensesAmount": {
      "confidence": 0.7916666666666666,
      "value": 0
    },
    "seriesCode": {
      "confidence": 0,
      "value": ""
    },
    "serviceAddress": {
      "confidence": 0,
      "values": ""
    },
    "shippingAddress": {
      "confidence": 0,
      "value": null
    },
    "supplyNumber": {
      "confidence": 0,
      "value": 0
    },
    "taxClass": {
      "confidence": 1,
      "value": "IGIC"
    },
    "totalAmount": {
      "confidence": 0.7916666666666666,
      "value": 120.47
    },
    "totalDiscountAmount": {
      "confidence": 0.7916666666666666,
      "value": 0
    },
    "totalDueAmount": {
      "confidence": 0.7916666666666666,
      "value": 120.47
    },
    "totalFeesAmount": {
      "confidence": 0.7916666666666666,
      "value": 0
    },
    "totalGrossAmount": {
      "confidence": 0.7916666666666666,
      "value": 99.56
    },
    "totalTaxAmount": {
      "confidence": 0.7916666666666666,
      "value": 20.91
    },
    "totalTaxBaseAmount": {
      "confidence": 0.7916666666666666,
      "value": 99.56
    },
    "totalUsage": {
      "confidence": 0,
      "value": "0,"
    },
    "usageUnitOfMeasurement": {
      "confidence": 0,
      "value": 0
    },
    "withholdingTaxAmount": {
      "confidence": 0.7916666666666666,
      "value": 0
    },
    "withholdingTaxRate": {
      "confidence": 0.7916666666666666,
      "value": 0
    }
  },
  "publicState": "approved",
  "confidence": "high",
  "validationInfo": {
    "errors": []
  },
  "approvalInfo": {
    "beginning": "2024-01-15T09:30:00Z",
    "result": "approved",
    "steps": []
  },
  "import": {
    "_id": "000000000000000000000003"
  },
  "exports": [],
  "deleted": true,
  "user": null
}

Update the extracted data or custom metadata of a document — for example, to submit corrections or feedback on the extracted fields. Documents in pendingCorrection or approved state can be updated through this endpoint.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

idstringRequired

id of the document to modify

Request

This endpoint expects an object.

datamap from strings to objectsOptional

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

clientDatamap from strings to anyOptional

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

The object is merged into the stored clientData: keys you omit are kept, keys you send are added or overwritten, and a key set to null is stored as null. Keys cannot be removed. Nested objects are merged the same way; arrays are replaced as a whole. Sending clientData: null leaves the stored value unchanged.

Response

Updated document

_idstringOptionalformat: "DocumentId"

accountstringOptionalformat: "AccountId"

Account the document belongs to.

environmentstringOptionalformat: "EnvironmentId"

Environment the document belongs to.

companystringOptionalformat: "CompanyId"

Company the document belongs to.

creatorstringOptionalformat: "UserId"

User that uploaded the document

clientDataobjectOptional

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

typeenumOptional

Allowed values:

namestringOptional

Original name of the uploaded file

isGroundTruthbooleanOptional

Indicates the document is marked as Ground Truth (GT)

creationstringOptionalformat: "date-time"

Upload timestamp

imageslist of stringsOptional

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

originalstringOptionalformat: "URL"

Azure Storage URL (SAS) to access the original file

mimetypestringOptional

datamap from strings to anyOptional

Extracted document data. Structure varies by document type.

publicStateenumOptionalDefaults to processing

confidenceenumOptional

Allowed values:

processInfoobjectOptional

validationInfoobjectOptional

approvalInfoobjectOptional

importobjectOptional

exportslist of objectsOptional

geometryobjectOptional

deletedbooleanOptional

Indicates whether the document has been logically deleted

duplicatedbooleanOptionalDeprecated

Errors

400

Bad Request Error

403

Forbidden Error

410

Gone Error

429

Too Many Requests Error

500

Internal Server Error