Upload a document
Uploads one invoice (PDF, or XML e-invoice such as XRechnung or ZUGFeRD), other document (PDF or XML) or bank statement (PDF), up to 50 MB. Tabula reads the file after the request returns; poll the upload until its status is completed or failed.
apiKeyAuthorizationBearer <token>A company API key created in Tabula.
multipart/form-data- body
file*stringThe document. PDF or XML, up to 50 MB.
documentType?stringWhat the file is. auto lets Tabula tell supplier invoices, customer invoices and other documents apart; it does not detect bank statements. other_document files the file in other documents without booking it.
"auto""auto""supplier_invoice""customer_invoice""bank_statement""other_document"externalId?stringYour ID for the file. A repeated request with the same externalId returns the original upload. Without one, a repeated file with the same document type returns the original upload.
1 <= length <= 200Accepted
application/json- response
id*stringUpload ID.
uuidbatchId*|ID of the upload batch the file came in. Null for a single upload.
externalId*|The externalId sent with the upload.
fileName*stringFile name. For a file from a ZIP archive, its path in the archive.
documentType*string"auto""supplier_invoice""customer_invoice""bank_statement""other_document"status*stringqueued: waiting to be read. processing: being read. completed: the result is in Tabula. failed: see error. deleted: the result was deleted in Tabula.
"queued""processing""completed""failed""deleted"result*|nullerror*|nullcreatedAt*stringdate-timecurl -X POST "https://example.com/v1/uploads" \ -F file="string"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "externalId": "string", "fileName": "string", "documentType": "auto", "status": "queued", "result": { "type": "invoice", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "http://example.com" }, "error": { "code": "unsupported_file_type", "message": "string" }, "createdAt": "2019-08-24T14:15:22Z"}Inspect the API key GET
Returns the API key that authenticated the request and the company it belongs to. Use it to verify that a key works.
Upload a ZIP archive POST
Uploads a ZIP archive of up to 100 documents, 200 MB unpacked and 50 MB per file. Every file becomes an upload with the batch's document type. Files of an unsupported type are listed as failed uploads. Poll the batch until its status is no longer processing.