Get an import's status

stage is one of six states, and every import ends on completed or failed. staging: the files are still being read and their rows are still appearing. ready_for_review: every file finished and its rows are staged; list them, fix them, then call commit. held: an AutoImport did not stage clean, so it did not commit itself; heldForReview says why (a file with no total or net column can never be reconciled, so it is always held), and it waits for the commit call like a Review import. committing: the staged rows are being written into the portfolio. completed: final, every file finished, and failedFileCount and timedOutFileCount say how many of them did not import. failed: final, nothing imported, and failureReason says why. A Review import goes staging, ready_for_review, committing, completed. An AutoImport never passes ready_for_review: it goes staging, committing, completed, or stops at held. isTerminal is true only on completed and failed, so poll until it is true; ready_for_review and held are waiting for your commit call. Poll no more often than once every 2 seconds.

Access

OAuth scope: transactions:read

Available on: every plan, including free trials

Responses

🟢200OK

application/json

The import

Bodyapplication/json

Example

{
    "stage": "staging",
    "isTerminal": true,
    "heldForReview": "string",
    "failureReason": "string",
    "importMode": "Review",
    "fileCount": 0,
    "failedFileCount": 0,
    "timedOutFileCount": 0,
    "tradeCount": 0,
    "committedCount": 0,
    "skippedCount": 0,
    "skippedRows": [
        {
            "stagedTradeId": "a4a20532-26c0-479f-b5c2-1a11f91671f2",
            "symbol": "string",
            "exchange": "string",
            "tradeDate": "string",
            "reason": "string"
        }
    ],
    "files": [
        {
            "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
            "fileName": "string",
            "stage": "staging",
            "tradeCount": 0,
            "failureReason": "string"
        }
    ]
}

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429

Get an import's status

Request

Request Code Samples

Responses