Tabula API

Get an upload

GET
/v1/uploads/{uploadId}

Returns the upload's status. Once completed, result links to what Tabula made of the file; once failed, error says why. While the upload is queued or processing, the Retry-After header suggests when to poll again.

Authorization

apiKey
headerAuthorizationBearer <token>

A company API key created in Tabula.

Path Parameters

uploadId*string

Upload ID.

Formatuuid

Response Body

OK

application/json
  1. response
id*string

Upload ID.

Formatuuid
batchId*|

ID of the upload batch the file came in. Null for a single upload.

externalId*|

The externalId sent with the upload.

fileName*string

File name. For a file from a ZIP archive, its path in the archive.

documentType*string
Value in"auto""supplier_invoice""customer_invoice""bank_statement""other_document"
status*string

queued: waiting to be read. processing: being read. completed: the result is in Tabula. failed: see error. deleted: the result was deleted in Tabula.

Value in"queued""processing""completed""failed""deleted"
result*|null
error*|null
createdAt*string
Formatdate-time
curl -X GET "https://example.com/v1/uploads/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"}

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.

Get an upload batch GET

Returns the batch's status, counts per upload status and every upload in it. While the batch is processing, the Retry-After header suggests when to poll again.