Upload files [DEPRECATED]

post https://api.invofox.com/documents/bulk

Please check File Ingestion System API under Uploads to view the new methods. Deprecation timeline for this method has not been defined yet, but users will be notified well in advance.
Upload a file or a group of files of the same type (invoice, deliveryNote,promissoryNote,ticket,supplyInvoice,purchaseOrder,bankStatement) to your environment. Each document is then processed asynchronously.
Allowed formats are

images: .jpeg, .jpg, .png, .tiff, .gif
PDFs: .pdf
Compressed files: .zip.

One of the parameters files or urls must be provided and can also be combined.

Body Params

files

array of files

Documents to process.

files

urls

array of strings

length ≤ 100

Documents to download and process. Maximum of 100 urls per call.

urls

type

string

Type of document to be assigned to each uploaded file. Required unless the classifier is enabled. Allowed types depend on environment configuration and include invoice, deliveryNote, promissoryNote, ticket, supplyInvoice, purchaseOrder.

customTypeDefinition

string

ID of the custom model. Required if 'custom' type is selected.

company

string

id of company the uploaded files should be associated to. Required if the environment has more than 1 company.

loadBatch

string

id of the current LoadBatch. If not provided a new one will be created.

closeBatch

boolean

flag to close the loadBatch after uploading the files

useSplitter

boolean

flag to use splitter or not. Only available if you have contracted the splitter functionality

useClassifier

boolean

flag to use classifier or not. Only available if you have contracted the classifier functionality

clientData

string

Additional data to be added to each document. Must be a JSON object or an array of JSON objects. In case only one document is uploaded this parameter introduce data using the format:

{"DataNameField1": value, "DataNameField2": value, ... ,"DataNameFieldX": value}

In case several documents are uploaded, the parameter works as follows:If data to be specified to each document is the same, it uses the format explained before. 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",
        "NameDataField1": value,"NameDataField2": value, ..., "NameDataFieldX": value
      },
       ...
      {
        "_filename": "name of the file to which attach this data",
        "NameDataField1": value, "NameDataField2": value, ..., "NameDataFieldX": value
      }
    ]

knownData

string

Data known for each document. Must be a JSON object or an array of JSON objects. In case only one document is uploaded this parameter introduce data using the format:

{"DataNameField1": value, "DataNameField2": value, ... ,"DataNameFieldX": value}

In case several documents are uploaded, the parameter works as follows: If data to be specified to each document is the same, it uses the format explained before. 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",
      "NameDataField1": value,"NameDataField2": value, ..., "NameDataFieldX": value
    },
     ...
    {
      "_filename": "name of the file to which attach this data",
     "NameDataField1": value, "NameDataField2": value, ..., "NameDataFieldX": value
    }
  ]

Responses

201The files were loaded in the system

400Request error of one of many supported types

404Element was not found

500Unkown server error