E-File Magic

Orders

List orders

Find orders and track their filing and delivery progress.

GET
/api/v1/orders/list
Authentication
OAuth 2.0 access token
Required scopes
orders.read
Idempotency key
Not required
Rate-limit cost
1 unit

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

Response fields

3 fields
itemsAlways returnedarray<object>

Maximum items: 100.

Nested fields (33)

balance_due_minorAlways returnedinteger

Minimum: 0.

created_atAlways returnedstring (date-time)

Type: string (date-time).

currencyAlways returned"USD"

Value: "USD".

customer_deposit_applied_minorAlways returnedinteger

Minimum: 0.

customer_deposit_reserved_minorAlways returnedinteger

Minimum: 0.

filer_idAlways returnedstring (uuid)

Type: string (uuid).

from_importAlways returnedboolean

Type: boolean.

fulfillment_statusAlways returnedstring

Type: string.

holdAlways returnedobject

Type: object.

import_run_idMay be omittedstring | null

Type: string | null.

import_sourceMay be omittedstring | null

Type: string | null.

imported_atMay be omittedstring (date-time) | null

Type: string (date-time) | null.

last_errorMay be omittedstring | null

Type: string | null.

order_idAlways returnedstring (uuid)

Type: string (uuid).

payment_due_minorAlways returnedinteger

Minimum: 0.

payment_statusAlways returnedstring

Type: string.

public_order_refMay be omittedstring | null

Type: string | null.

snapshot_chunk_completedAlways returnedinteger

Minimum: 0.

snapshot_chunk_totalAlways returnedinteger

Minimum: 0.

snapshot_copied_recipientsAlways returnedinteger

Minimum: 0.

snapshot_statusAlways returnedstring

Type: string.

snapshot_total_recipientsAlways returnedinteger

Minimum: 0.

source_digestMay be omittedstring | null

Type: string | null.

source_external_idMay be omittedstring | null

Type: string | null.

source_external_refMay be omittedstring | null

Type: string | null.

source_filing_systemMay be omittedstring | null

Type: string | null.

source_platformMay be omittedstring | null

Type: string | null.

statusAlways returnedstring

Type: string.

tax_yearMay be omittedinteger | null

Type: integer | null.

tenant_idAlways returnedstring (uuid)

Type: string (uuid).

total_minorAlways returnedinteger

Minimum: 0.

updated_atAlways returnedstring (date-time)

Type: string (date-time).

versionAlways returnedinteger

Minimum: 1.

next_cursorMay be omittedstring | null

Maximum characters: 4096.

total_countMay be omittedinteger | null

Minimum: 0.

Complete response schema: ApiV1OrderListResponse

Example · HTTP 200
{
  "data": {
    "items": [],
    "next_cursor": null,
    "total_count": null
  },
  "meta": {
    "api_version": "v1",
    "request_id": "example-request-id"
  }
}

No matching records. Synthetic empty-page example. Follow a non-null next_cursor even when items is empty. A null total_count means no count was supplied.