Skip to main content
POST
Open an upload

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
datasource
string
required
doc_type
string
required

Declared document type for every record in this upload. invoice and purchase_order are mapped types; other names must match ^[a-z][a-z0-9_]{2,40}$. Custom types are stored for Pascal-side processing and are not searchable. Record IDs are unique across all doc types in a datasource; re-sending an ID under a different type moves the record to that type.

mode
enum<string>
required
Available options:
incremental,
full
dry_run
boolean
default:false

Response

Successful Response

created_at
string<date-time>
required
datasource
string
required
doc_type
string
required
dry_run
boolean
required
mode
string
required
status
enum<string>
required
Available options:
in_progress,
done,
failed,
expired,
rejected
upload_id
string
required