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

Request fields

4 fields
filer_idRequiredstring (uuid)

ID of the filer that owns this operation's records.

funding_aliasRequiredstring

Approved funding alias configured for the connection. Minimum characters: 1. Maximum characters: 64.

service_codesRequiredarray<string>

Services to include in the order. Review availability and pricing with preview first. Must include efile and e_delivery. State E-File is not currently available: new state_efile requests return HTTP 400 invalid_request with message 'State E-File is not currently available.'. State Reporting File (irs_spec_file) remains available. Historical response identities are unchanged. Minimum items: 2. Maximum items: 4. Items must be unique.

tax_yearOptionalinteger | null

Tax year of the filer and forms being processed. Allowed values: 2022, 2023, 2024, 2025, 2026.

Headers (2)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.

Complete request schema: ApiV1OrderPreviewRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/orders/preview' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace placeholders with your own values. Use the API resource origin provided for your environment.

Create request.json using the documented fields. Field descriptions are not sample values.