ASCI API - Quick Entry (ACE QE)

Quick Entry (ACE QE) module page - how it works, an interactive test form, and the endpoint reference, all in one place. Set your tenant API Key in the Setup block below; every request sends the ApiKey header. See All Forms for the combined surface or Home for the module index.

How it works

ACE Quick Entry (ACEQE) end to end.

Quick Entry (ACE QE)

ACE Quick Entry assembles an ACE entry summary: a header plus ACE flags and multi-row tariff lines (max 5), containers / Box-29 (max 10), commercial entities (max 50) and per-line PGA indicators (max 5). The six-step wizard below pre-fills only the populated sample rows; use + Add to add more up to each maximum.

Submit posts to POST /api/AceQe/Submit with reference_no always NEW; the response carries the submission_id you can transmit and poll. MID / product lookups resolve against GET /api/Manufacturers and GET /api/Products.

Setup

API key + base URL used by every request below.

Credentials

API Key

Base URL

Leave Base URL blank to call this same server with relative paths (the normal case). Set it (e.g. https://asci-api.asciofmiami.com) to point the forms at another host. Every request below sends the ApiKey header.

Idempotency Key

Sent on every create / submit POST. Click Generate for a fresh one, or a new one is auto-generated per submit if blank.

Test form

Interactive form - POSTs to the API and shows the JSON response + HTTP status.

Maps to POST /api/AceQe/Submit. Full ACE Quick Entry: header + ACE flags + multi-row tariff lines (max 5), containers / Box-29 (max 10), commercial entities (max 50), and per-line PGA indicators (max 5). Each multi-row section starts pre-filled with only the populated sample rows; use + Add to add more up to each maximum. The MID / product lookups resolve against GET /api/Manufacturers and GET /api/Products. reference_no is always sent as NEW.

1 Entry Header

2 Commercial Entities

3 Tariff Lines

4 Containers & PGA

5 Remarks

6 Submit

Step 1 - Entry Header. Mirrors the legacy ACE Quick Entry header screen (IPACEQEN1): importer / broker, the required ACE entry, transport, ports / origin / goods, the ACE flags and the bond.

Importer / Broker

Metadata (JSON, optional)

Importer of Record (Customer)

Consignee IRS Number

Broker / Sales Rep (Team)

FIRMS Code

FIRMS City

ACE Entry (required)

ACE Entry Type (required)

Statement Status

District / Port Code

Transport

Vessel Name

Flight Number (Air)

AWB Date or Multi

Ports / Origin / Goods

Port of Entry

Country Subdivision (State)

Default Country Code

Goods Description

ACE Flags

AII Filed

Paperless Flag

No Release Requested

Multi Consignee

Multi Manufacturer

Purchased Indicator

ACH Indicator

GSP / CBI / NAFTA

Bond

Bond Type Code

Bond Notation

Step 1 of 6

Step 2 - Commercial Entities. Mirrors the legacy ACE entity screens (IPACEQEN1A): the commercial entities (consignee, manufacturer, seller, buyer, ...) plus the MID / product lookup helper used to populate a tariff line in the next step.

Commercial Entities (max 50)

Manufacturer (MID) / product lookup

Manufacturer ID (MID) Helper

Product (Description / Code)

Optional helpers: the picked MID / product tariff can be copied into a tariff-line row below. Click Apply MID/product to first tariff line.

Step 2 of 6

Step 3 - Tariff Lines. Mirrors the legacy tariff-line screen (IPACEQEN2): up to five tariff lines, each with its HTS number, country of origin, MID and per-line PGA flags.

Tariff Lines (max 5)

Step 3 of 6

Step 4 - Containers & PGA. Mirrors the legacy container / Box-29 screen (IPACEQEN2A): up to ten Box-29 container lines, plus the per-tariff-line PGA indicators (one per tariff line, max five).

Containers / Box 29 (max 10)

PGA Indicators (one per tariff line, max 5)

Step 4 of 6

Step 5 - Remarks. Mirrors the legacy remarks screen (IPACEQEN3): free-text remarks carried on the entry.

Remarks

Remarks Line 1 (max 35)

Step 5 of 6

Step 6 - Submit & Transmit. Choose the submit mode and submit the Quick Entry, transmit a staged draft, or check submission status.

Submit mode

Submit Mode

direct queues the entry for legacy insertion immediately. draft stages it in the API (status draft, no inbox files written) for later Transmit (POST /api/AceQe/{id}/Transmit). The value is sent as submit_mode inside document.

Transmit a draft

Transmit Draft ID

Releases a staged draft into the legacy queue: POST /api/AceQe/{id}/Transmit. Auto-filled after a draft Submit above. Retry-safe.

Check status

Submission ID

Calls GET /api/AceQe/Status/{id}.

Step 6 of 6

Endpoints

ACE QE endpoint family (api/AceQe). Full request schema below.

Quick Entry endpoints

Method	Path	Purpose
POST	`/api/AceQe/Submit`	Submit an ACE QE document. Returns `submission_id`.
POST	`/api/AceQe/{submissionId}/Transmit`	Transmit a built QE to CBP.
GET	`/api/AceQe`	List QE submissions.
GET	`/api/AceQe/{submissionId}`	Fetch one submission.
GET	`/api/AceQe/Status/{submissionId}`	Lifecycle status (used by the form's Check Status button).

Schema

Request body for POST /api/AceQe/Submit. Envelope: { "document": { … } }. Field shapes and widths mirror the IPDFLN record layout; the byte block each field comes from (I1$…I10) is noted. Fields tagged [ACE] are ACE-only. All fields are strings unless typed otherwise; only reference_no is required.

document (root) - identity

Field	Type	Req?	Max	Description
`reference_no`	string	Yes	6	Reference number. Send `NEW` to auto-generate.
`metadata`	object	No	—	Client-supplied key/value bag (string→string, ≤50 entries), echoed on status / webhooks.
`filer_code`	string	No	3	ABI filer code. Enforced only when `Validation:RequireFilerCode` is on.
`ace_entry_type`	string	No	2	[ACE] Entry type; must be one of 23, 24, 25, 28, 31, 51.

I1$ / I2$ - 7501, statement, ACH, bond, NAFTA
Field	Type	Max	Description
`filed_7501`	string	1	"1" = 7501 filed.
`consignee_type_code`	string	3	IRS type code.
`transcargo_indicator`	string	10	Customer-specific indicator.
`consignee_irs_number`	string	12	IRS# of consignee.
`rlf_indicator` / `rlf_qualifier`	string	1 / 4	Remote-location-filing indicator + qualifier.
`default_country_code`	string	5	Default country / port.
`district_port_code`	string	5	Examiner district / port.
`bond_type_indicator`	string	1	Bond / periodic indicator.
`gsp_cbi_nafta`	string	1	Trade-preference indicator.
`statement_status`	string	1	Statement status.
`broker_or_sales_rep`	string	5	Broker / sales-rep code.
`nafta_claim_type`	string	1	NAFTA claim type (entry type 08).
`ach_indicator`	string	1	ACH payment indicator.
`unknown_i2_12` / `cleared_on_new`	string	1	Reserved / cleared on new entry.

I3$ - entry metadata, entity codes, flags
Field	Type	Max	Description
`flight_number`	string	5	Flight / voyage number.
`port_of_entry`	string	4	FIRMS / port of entry.
`firms_code` / `firms_city`	string	4 / 5	Location (exam) code and city.
`unbalanced_indicator`	string	1	"1" = unbalanced entry.
`vessel_name`	string	22	Vessel / carrier name ("FTZ"+# for FTZ).
`weekly_estimated_ind`	string	1	Weekly / periodic indicator.
`wh_indicator`	string	1	Warehouse indicator.
`goods_description`	string	60	Free-text goods description.
`invoice_count`	string	4	Number of invoices.
`no_release_requested`	string	1	[ACE] Suppress automated release request.
`transfer_indicator` / `transfer_agra_ind`	string	1	In-bond / transfer type, AGRA transfer.
`team_code`	string	3	Team code.
`purchased_indicator`	string	1	Goods-purchased flag.
`bond_notation`	string	2	"BN" literal.
`immediate_delivery_ind`	string	1	Immediate-delivery indicator.
`importer_of_record`	string	6	Importer-of-record code.
`awb_date_or_multi`	string	7	AWB/BL date or "MULTI".
`paperless_flag`	string	1	[ACE] Paperless 7501 flag.
`ruling_info_indicator`	string	1	[ACE] Ruling numbers entered.
`secondary_port_code` / `secondary_port_name`	string	4 / 25	Secondary port of lading code + city.
`aii_filed`	string	1	[ACE] Filed-AII indicator.
`split_release`	string	1	[ACE] Split release.
`multi_consignee` / `multi_manufacturer` / `multi_other_entities`	string	1	[ACE] Multiple-entity flags.
`unknown_i3_14` / `unknown_i3_85` / `unknown_i3_198` / `unknown_i3_229` / `cleared_new_entry_195`	string	-	Reserved / TBD bytes (passed through).

I4$ - tariff / CES / supplier / exam
Field	Type	Max	Description
`entry_class_init`	string	11	Entry-type setup field (cleared on new).
`aii_supplier_id`	string	15	[ACE] Supplier ID for AGRA AII.
`ces_transfer_site`	string	4	[ACE] CES exam transfer site (FIRMS).
`district_port_short`	string	2	2-char district port.
`exam_site_data`	string	15	[ACE] Exam-site additional data.
`tariff_lines`	array	-	Up to 5 tariff-line blocks (see below).

I5$ - bond + multiple-entity flags
Field	Type	Max	Description
`bond_type_code`	string	1	Bond type code.
`multi_seller` / `multi_buyer` / `multi_ship_to` / `multi_location` / `multi_consolidator` / `multi_booking`	string	1	[ACE] Multiple-entity flags (Y/N).

remarks, box 29, numeric arrays, ACE siblings
Field	Type	Description
`remarks_line_1` / `_2` / `_3`	string (35)	Free-text remarks (I8$).
`box29_lines`	array<string>	CBP 7501 Box 29 marks/numbers lines (10 x 36 chars).
`containers`	array	[ACE] Structured containers (preferred over box29_lines; see below).
`i7` / `i9` / `i10`	array<int>	Numeric arrays (mostly cleared on new; i7[3] = warehouse import date Julian).
`commercial_entities`	array	[ACE] Commercial entities from IPDFLED (see below).
`pga_indicators`	array<string>	[ACE] Per-tariff-line PGA "Y"/"N" flags (IPPGAIND).
`country_subdivision`	string	[ACE] State/province subdivision code (IPIFCSV).

tariff_lines[] (array, max 5)
Field	Type	Max	Description
`bond_no`	string	11	Bond number (row 0 holds the header bond#).
`ruling_no`	string	15	CBP ruling / AII reference (row 0).
`fws_ind` / `fda_ind` / `fcc_ind` / `dot_ind` / `pga_ind`	string	1	PGA agency indicators (Y/blank).
`country_of_origin`	string	2	Country of origin (ISO 2-char).
`manufacturer_id`	string	15	Manufacturer ID / MID.
`tariff_no`	string	12	HTS tariff number.
`quantity_1` / `quantity_2` / `quantity_3`	number	-	Reported quantities per UOM (Phase 1 duty-calc; typically only #1).
`uom_1` / `uom_2` / `uom_3`	string	4	Reporting units of measure.
`reserved_row_49_6` / `reserved_row_67_4`	string	6 / 4	Reserved row padding bytes.

containers[] (array) - [ACE] IPDFL4N
Field	Type	Max	Description
`seq`	int	-	0-based row index => legacy container sequence#.
`awb_seq`	string	6	AWB/BL sequence# linking the container to its AWB.
`container_number`	string	20	Container number.

commercial_entities[] (array) - [ACE] IPDFLED
Field	Type	Max	Description
`role`	string	3	Entity role ("CN " = consignee, "MF " = manufacturer, etc.).
`name`	string	35	Entity name.
`type_qualifier`	string	3	ID type qualifier ("EI " = EIN, "MF " = MID, etc.).
`identifier`	string	20	IRS / EIN / MID identifier.
`address_block`	string	70	Address / secondary fields block.
`customer_division`	string	6	Customer division / code.

Mode of Transportation Codes (reference)
Code	Label
`10`	Vessel, non-container
`11`	Vessel, container
`20`	Rail, non-container
`21`	Rail, container
`30`	Truck, non-container
`31`	Truck, container
`32`	Auto
`33`	Pedestrian
`40`	Air, non-container
`41`	Air, container
`60`	Passenger, hand-carried
`70`	Fixed Transport Installations (pipeline / powerhouse)

Labels follow CBP CATAIR Appendix B.