List an import's documents
One per document found, from newest to oldest. Filter by result=skipped or result=failed to see those that need attention.
Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.
In: header
Path Parameters
uuidQuery Parameters
How many per page, from 1 to 100.
1 <= value <= 10020The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.
length <= 200Value in
- "pending"
- "imported"
- "duplicate"
- "skipped"
- "failed"
Value in
- "confirmed_by_sri"
- "listed_by_sri"
- "signature_only"
- "issuer_signature_only"
- "already_exists"
- "evidence_added"
- "wrong_issuer"
- "wrong_environment"
- "unsupported_version"
- "annulled"
- "not_authorized"
- "no_sri_in_sandbox"
- "canceled"
- "unreadable_xml"
- "not_a_document"
- "unknown_code"
- "entry_too_large"
- "invalid_access_key"
- "invalid_signature"
- "certificate_mismatch"
- "certificate_expired"
- "authorization_mismatch"
- "unknown_to_sri"
- "xml_unavailable"
- "number_taken"
- "not_importable"
- "sri_unavailable"
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/ec/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/items"{ "object": "list", "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "import_item", "import_id": "13230382-dadc-41f2-963d-e123bd5c0585", "file": "string", "entry": "string", "line": 0, "access_key": "string", "document_type": "invoice", "number": "string", "issue_date": "string", "result": "pending", "code": "confirmed_by_sri", "message": "string", "params": { "property1": "string", "property2": "string" }, "verification": "sri", "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string", "prev_cursor": "string"}Retrieve an import GET
The import with its status, the files you uploaded and how many documents were found, imported, repeated, skipped or failed. To see what happened to each one, use `GET /v1/ec/imports/{id}/items`.
Cancel an import POST
Stops a `queued` or `processing` import: what is not yet decided becomes `skipped` with `canceled`, and what was already imported stays.