Cancel an import
Stops a queued or processing import: what is not yet decided becomes skipped with canceled, and what was already imported stays.
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
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/ec/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "import", "country": "ec", "environment": "sandbox", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "status": "queued", "status_transitions": { "queued": "2019-08-24T14:15:22Z", "processing": "2019-08-24T14:15:22Z", "completed": "2019-08-24T14:15:22Z", "failed": "2019-08-24T14:15:22Z", "canceled": "2019-08-24T14:15:22Z" }, "files": [ { "name": "string", "kind": "xml", "size": 0, "sha256": "string", "ignored_entries": 0 } ], "counts": { "found": 0, "pending": 0, "imported": 0, "duplicate": 0, "skipped": 0, "failed": 0 }, "verification": { "sri": 0, "listed": 0, "signature": 0, "unconfirmed": 0 }, "currency": "string", "sales_total": "string", "upgraded": { "signature": 0, "unconfirmed": 0 }, "numbering": [ { "series_id": "0f6582ac-1e7e-41dc-a63a-24fccd074d0c", "document_type": "invoice", "establishment": "string", "emission_point": "string", "highest_imported": 0, "highest_reserved": 0, "next_number": 0, "active": true, "created": true } ], "failure": { "code": "unreadable_archive", "message": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}List an import's documents GET
One per document found, from newest to oldest. Filter by `result=skipped` or `result=failed` to see those that need attention.
Search your business's recipients GET
The people and companies your key's business has issued documents to in its environment, most recent first: they are added on their own when you issue or import. `q` searches by name or identification; `counts` counts its recipients without filtering.