Upload broker files to import

Send multipart/form-data with one or more parts named files, up to 100 MB in total. A single part may be named file instead; any other part name is refused, and any other content type answers 415. A PDF is read as a contract note; any other file as a broker statement or trade export. Optional fields: importMode, providerId and targetCashAccountId (the cash account cash rows land on). providerId only names the broker the import is attributed to; the format is always detected from the file, so it never chooses the parser. importMode is Review (the default: trades stage and wait for the commit call) or AutoImport (trades commit by themselves, but only when every file stages with no errors and every row reconciles against the file's own totals; otherwise the import is held for review). A file with no total or net column cannot be reconciled, so an AutoImport of it is always held — it still needs the commit call. Poll the Location until stage is ready_for_review, held, completed or failed; an AutoImport never passes ready_for_review.

Access

OAuth scope: transactions:write

Available on: every plan, including free trials

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢202Accepted

application/json

The files were accepted and are being read; Retry-After says how long to wait before the first poll

Bodyapplication/json

Example

{
    "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
    "files": [
        {
            "fileName": "string",
            "processId": "9e0ad09b-5150-48c0-aded-707587048fd9",
            "route": "string",
            "error": "string"
        }
    ],
    "message": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠415

🟠429