E-File Magic

Orders

Preview an order

Check eligible recipients, services and current pricing before submitting an order.

POST
/api/v1/orders/preview
Authentication
OAuth 2.0 access token
Required scopes
orders.preview
Idempotency key
Not required
Rate-limit cost
10 units

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

Response fields

13 fields
blocked_released_recipientsMay be omittedinteger

Minimum: 0.

blocked_tin_matched_recipientsMay be omittedinteger

Minimum: 0.

blocked_unvalidated_recipientsMay be omittedinteger

Minimum: 0.

currencyAlways returned"USD"

Value: "USD".

eligible_recipientsMay be omittedinteger

Minimum: 0.

estimated_payment_due_minorMay be omittedinteger

Minimum: 0.

expected_total_minorAlways returnedinteger

Minimum: 0.

filer_idAlways returnedstring (uuid)

Type: string (uuid).

funding_kindAlways returnedstring

Allowed values: "deposit", "terms", "vaulted_instrument".

policy_versionAlways returnedinteger

Minimum: 1.

pricing_basisMay be omittedobject

Unknown fields are rejected.

Nested fields (3)

modeAlways returnedstring

Allowed values: "per_order", "cumulative_tax_year".

starting_recipient_countAlways returnedinteger

Minimum: 0.

tax_yearAlways returnedinteger

Type: integer.

servicesAlways returnedarray<object>

Type: array<object>.

Complete response schema: ApiV1OrderPreviewResponse

Structure · HTTP 200
{
  "data": {
    "blocked_released_recipients": "integer",
    "blocked_tin_matched_recipients": "integer",
    "blocked_unvalidated_recipients": "integer",
    "currency": "\"USD\"",
    "eligible_recipients": "integer",
    "estimated_payment_due_minor": "integer",
    "expected_total_minor": "integer",
    "filer_id": "string (uuid)",
    "funding_kind": "string",
    "policy_version": "integer",
    "pricing_basis": "object",
    "services": "array<object>",
    "tax_year": "integer | null"
  },
  "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.