E-File Magic

Imports

Delete an import

Remove an import submission when its current state allows deletion.

POST
/api/v1/imports/submissions/delete
Authentication
OAuth 2.0 access token
Required scopes
imports.writeimports.delete
Idempotency key
Required
Rate-limit cost
5 units

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

37 fields
chunk_checksumsMay be omittedarray<object>

Type: array<object>.

completed_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

content_typeAlways returnedstring

Maximum characters: 128.

created_atAlways returnedstring (date-time)

Type: string (date-time).

created_byAlways returnedobject

Type: object.

created_by_user_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

default_form_idMay be omittedstring | null

Type: string | null.

default_schema_revMay be omittedinteger | null

Type: integer | null.

default_tax_yearMay be omittedinteger | null

Type: integer | null.

detected_import_kindAlways returnedstring

Determined from uploaded file contents. Native Publication 1220 uses pub1220. Allowed values: "unknown", "standard_template", "inline_filer_template", "pub1220", "advanced_mapping".

file_nameAlways returnedstring

Maximum characters: 180.

filer_idMay be omittedstring (uuid) | null

Type: string (uuid) | null.

Complete response schema: ApiV1ImportSubmission

Structure · HTTP 200
{
  "data": {
    "chunk_checksums": "array<object>",
    "completed_at": "string (date-time) | null",
    "content_type": "string",
    "created_at": "string (date-time)",
    "created_by": "object",
    "created_by_user_id": "string (uuid) | null",
    "default_form_id": "string | null",
    "default_schema_rev": "integer | null",
    "default_tax_year": "integer | null",
    "detected_import_kind": "string",
    "file_name": "string",
    "filer_id": "string (uuid) | null",
    "final_checksum_sha256": "string | null",
    "imported_count": "integer",
    "last_error": "string | null",
    "mapping": "object | null",
    "next_row_number": "integer",
    "notification_sent_at": "string (date-time) | null",
    "notify_email": "string (email) | null",
    "provider": "string",
    "pub1220_corrections_skipped": "integer",
    "pub1220_counts_complete": "boolean",
    "pub1220_mode": "string",
    "rolling_checksum_sha256": "string | null",
    "row_count_processed": "integer",
    "row_count_total": "integer",
    "rows_per_chunk": "integer",
    "sha256": "string | null",
    "size_bytes": "integer",
    "skip_reason_counts": "object | null",
    "skipped_count": "integer",
    "status": "string",
    "submission_id": "string (uuid)",
    "target_scope": "string",
    "updated_at": "string (date-time)",
    "validation_issue_count": "integer",
    "version": "integer"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.