@repo/shared / EFDataType
Interface: EFDataType
Entry summary header data for a CBP customs filing. Populates the 10-Record and associated records.
This type represents all filer-provided header-level fields for an entry summary: port, bond,
transportation details, and shipment-level data. Server-assigned fields (id, importerId, status)
are excluded.
Properties
| Property | Type | Description |
|---|---|---|
associatedWarehouseEntryFilerCode? | string | Three-character CBP-assigned filer identification code of the associated Warehouse (Type 21) or Re-Warehouse (Type 22) Entry. Required on the 30-Record for withdrawal (31/32/34/38) and re-warehouse (22) entry types. |
associatedWarehouseEntryNumber? | string | 8-character unique entry number of the associated Warehouse or Re-Warehouse Entry being withdrawn from or re-warehoused against. Combined with the filer code and district/port code to uniquely identify the warehouse entry on the 30-Record. |
associatedWarehouseEntryPortCode? | string | 4-character District/Port Code of the U.S. port where the associated Warehouse or Re-Warehouse Entry was originally filed. Must match the D/P on record for the cited warehouse entry. |
bonds? | {bondDesignationType?: "A" | "B" | "U" | "E";bondType?: "8" | "9";continuousBond?: "Y" | "S";singleTransactionBondAccount?: string;singleTransactionBondAmount?: number;suretyCompany?: string;}[] | Bond and surety information securing potential duties, taxes, and fees. Up to one continuous bond and one single transaction bond may be reported per entry. Mandatory for AD/CVD entry types; conditionally required for others. |
bondWaived? | boolean | Indicates the bond requirement for this entry has been waived, as approved by the Port Director per 19 CFR 142.4(c). Not allowed for AD/CVD entry types (03, 07, 34, 38). |
bondWaiverReason? | "995" | "996" | "997" | "998" | "999" | Code indicating the reason for waiving the bond requirement (e.g., government importation, low value) |
brokerReferenceNumber? | string | The filer/preparer's internal Entry Summary identifier (up to 9 characters). When filing an Add (A) action to replace an existing entry that included a Broker Reference Number, this value must match exactly. Maps to the 10-Record position 22-30. |
cargoManifests? | {conveyances?: {carrierCode?: string;conveyanceName?: string;dateOfArrival?: Date;quantity?: number;trip?: string;unitOfMeasure?: string;}[]; equipment?: {equipmentNumber?: string;}[]; manifests?: {issuer?: string;number?: string;type?: "I" | "M" | "H" | "S";}[]; quantity?: number;unitOfMeasure?: string;}[] | One or more cargo manifest groupings linking this entry to arriving cargo. Each grouping ties bill of lading numbers, conveyance details, and equipment to the merchandise for CBP manifest matching and cargo control. |
cargoPscContactName? | string | Contact name for cargo-related Post Summary Corrections |
cargoPscContactPhone? | string | Contact phone for cargo-related Post Summary Corrections |
cargoPscDisIndicator? | boolean | Document Image System indicator for cargo PSC submissions |
carrierCode? | string | SCAC code of the carrier that transported the merchandise |
consignee? | EntityReference | The party to whom the merchandise is consigned. For most formal entry types this is mandatory and reported as an entity identifier (IRS/EIN). May be reported by name and address for informal entries where total article value is under $2,500. |
consolidatedExpressInformal? | boolean | Indicates this Entry Summary was filed by an authorized Express Consignment carrier/facility to consolidate duty-only payment for one or more manifest-released shipments valued between $800–$2,500. Only allowed for Entry Type 11 (Informal) by authorized Express Consignment filers. |
conveyanceName? | string | Name of the vessel, aircraft, or vehicle on which merchandise arrived. Used for manifest matching and cargo control. |
dateOfImportation? | Date | For vessel shipments, the date the vessel arrived within the limits of the U.S. Port of Arrival with intent to unlade. For other modes, the date merchandise arrived at the U.S. Port of Arrival. Mandatory for Entry Type 21 (Warehouse); not allowed for Re-Warehouse (22). |
designatedExamPortCode? | string | Port code where CBP examination will occur if different from port of entry |
dis? | boolean | Document Image System indicator. Boolean flag showing whether entry documents have been submitted through CBP's Document Image System. |
entryNumber? | number | 8-character unique entry number assigned by the filer. Combined with the filer code, it identifies the entry to CBP. The final digit is a check digit computed per the AE Table 1 formula. |
estimatedDateOfArrival? | Date | Estimated date of vessel/aircraft arrival at the U.S. port |
estimatedEntryDate? | Date | The date the filer expects the cargo to be entered for clearance. Used in the Duty Rate Date Matrix Hierarchy when not pre-empted by an Entry Date or Release Date. Mandatory for warehouse withdrawal entry types (31/32/34/38) and re-warehouse (22). |
finalWarehouseWithdrawal? | boolean | Indicates this is the final withdrawal against the associated Warehouse or Re-Warehouse Entry. Once marked final, no additional withdrawals can be claimed unless the designation is removed while the entry remains unpaid. |
foreignTradeZoneIdentifier? | string | 9-character identifier of the Foreign Trade Zone (FTZ) from which merchandise is being entered into U.S. commerce. Mandatory for Entry Type 06 (FTZ). |
formAction? | "A" | "D" | "R" | Action requested for this Entry Summary transaction. A = Add (create new), R = Replace (update entire entry), D = Delete (cancel entry). Maps to the 10-Record Summary Filing Action Request Code. |
headerEntities? | EntityReference[] | Array of header-level entity references (parties involved in the transaction) |
headerFees? | {amount?: number;code?: "311" | "496" | "500";}[] | Header-level fees such as informal entry fees (311), manual surcharges (500), or mail fees (496). Reported with accounting class codes. |
inBondInTransitDate? | Date | Date the merchandise began moving under an In-Bond or In-Transit arrangement within the U.S. Used in the Duty Rate Date Matrix Hierarchy as the earliest qualifying date for duty rate determination. |
internalName? | string | User-defined internal name for this entry summary. Never encoded to CBP. Development/internal use only. |
isCargoRelease? | boolean | Instructs CBP to use this Entry Summary's data to process Cargo Release (one-step filing). When set, CBP creates and processes the Entry for release using this summary (10-Record Cargo Release Certification Request Indicator = 'A'). Not allowed for warehouse withdrawal (3x) entry types or Military (51). |
isElectronicInvoice? | boolean | Indicates the Entry Summary conforms to the Electronic Invoice Processing (EIP) program requirements — an electronic invoice accounting for all articles has been submitted. Not allowed when also certifying for ACE Cargo Release. |
isLiveEntry? | boolean | Indicates this Entry Summary is filed simultaneously with cargo release data (one-step filing), as opposed to a two-step entry/entry summary process. |
isPostSummaryCorrection? | boolean | Boolean flag indicating this is a Post Summary Correction filing |
lloydsCode? | string | Lloyd's Register number uniquely identifying the vessel used to transport the merchandise. Applicable to vessel-mode shipments. |
locationOfGoods? | string | 4-character FIRMS (Facilities Information and Resources Management System) code identifying the known location of merchandise at time of filing. For warehouse entry types (21/22), this must be the FIRMS code of the customs bonded warehouse where goods are to be delivered. |
missingDocuments? | {missingDocument?: | "01" | "11" | "21" | "22" | "23" | "10" | "20" | "14" | "15" | "16" | "17" | "18" | "19" | "26" | "98";}[] | Documents required for the entry that have not yet been provided to CBP. Each entry allows up to two missing document codes. Code 99 is used when more than two documents are missing. |
modeOfTransportation? | | "11" | "12" | "21" | "31" | "32" | "34" | "10" | "20" | "30" | "33" | "40" | "41" | "50" | "60" | "70" | Code indicating the means of transportation by which merchandise arrived at the port. Examples include vessel (1), rail (2), truck (3), air (4), mail (5), passenger/hand-carried (60), or pipeline (7). |
originalFilerCode? | string | Three-character CBP-assigned filer code of the broker who originally filed the entry. Provide when filing a 2-step entry summary against another broker's cargo release, or when taking over another broker's entry via PSC — their filer code is the first 3 characters of the entry number. Leave blank when you are the original filer. |
originatingFilerCode? | string | On a PSC, the 3-character filer code that owns the original entry number being corrected. This differs from the transmitting filer when a filer (typically the IOR) files a PSC against an entry summary originally filed by a different broker. The original filer code is baked into the entry number's check-digit math but recorded here explicitly for traceability. Null/unset on non-PSC entries and on PSCs where the original filer equals the transmitting filer. |
paymentType? | "1" | "2" | "3" | "5" | "6" | "7" | "8" | Specifies the intended payment method and statement batching approach. 1 = Individual (non-statement). 2/3/5 = Daily Statement (batched by print date with varying IOR groupings). 6/7/8 = Periodic Monthly Statement (batched by print date with varying IOR groupings). |
periodicStatementMonth? | number | Calendar month (MM format) in which this Entry Summary is to be accounted for on the Periodic Monthly Statement. The reported month must be the current, next, or following month. Required for Periodic Monthly Statement payment types (6, 7, 8); not allowed for Daily Statement or individual payment. |
pgaDataIncluded? | " " | "Y" | "F" | Indicates that Partner Government Agency (PGA) data is included in this filing, either for an expedited entry program or for a weekly FTZ submission. |
portOfEntry? | string | Three or four character code identifying the CBP port where entry is filed. Must be a valid port code from CBP's port list. |
portOfUnlading? | string | 4-character CBP port code identifying the port where merchandise was unladen from the importing conveyance. |
preliminaryStatementPrintDate? | Date | The date this Entry Summary is scheduled to appear on the Preliminary Statement. Must be a future date (not exceeding 90 days), and cannot be a weekend or federal holiday. Also used as a fallback in the Duty Rate Date Matrix Hierarchy. Required for all statement payment types. |
pscOtherHeaderComments? | string | PSC Filing Explanation freetext (36-Record). Mandatory when Post Summary Correction Indicator is 'Y'. Describes the business reason for the PSC filing and is especially important for H99/L99 "Other" changes. Encoded as one or more 36-Records split into 75-char chunks. Must not be 'N/A', 'None', or similar. |
pscReasonCodes? | {reasonCode?: | "H01" | "H02" | "H04" | "H05" | "H06" | "H07" | "H08" | "H09" | "H10" | "H11" | "H12" | "H13" | "H14" | "H99";}[] | Post Summary Correction Header Reason Codes (35-Record). A set of up to 5 unique categorical codes identifying what changed at the header level in a PSC filing. Per CATAIR, codes are categorical (one code covers all changes of that category), not per-field. Encoder dedupes the set. Common codes: H01 = Entry Type Non-AD/CVD-to-AD/CVD, H02 = Entry Type-Other, H04 = MOT change, H05-H07 = Bond changes, H99 = Other (describe in 36-Record). |
reconciliationIssue? | "001" | "002" | "003" | "004" | "005" | "006" | "007" | Identifies the specific issue(s) to be subject to future reconciliation (e.g., value, classification, 9802 cost). Required when Trade Agreement Reconciliation is claimed. Only allowed for Entry Types 01, 02, and 06 (FTZ, excluding AD/CVD). |
referenceData? | {identifier?: string;qualifier?: | "CR " | "EN " | "IB " | "FTZ" | "DIS" | "V1 " | "AMT" | "EXP" | "KII" | "RRN" | "PER" | "CES" | "EDA" | "SCE" | "SSR" | "NAM" | "LOC" | "GEN";}[] | Array of reference data elements for additional identifiers |
releaseEntries? | {entryNumber?: string | number;filerCode?: string;}[] | Cargo Release (entry) transactions being consolidated under this Entry Summary. Required when the Consolidated Summary Indicator is set. Each entry cited must have been released but not yet associated with another entry summary. |
requestAcceleratedLiquidation? | boolean | Boolean flag requesting expedited liquidation of the entry |
shipmentUsageType? | "P" | "X" | " " | Code indicating special usage of the shipment such as carnets, TIB (Temporary Importation under Bond), or government shipments. |
statementClientBranch? | string | Filer-assigned 2-character code that further sub-groups Entry Summaries on a statement. Required only if the Broker/Filer has pre-configured this feature with CBP; otherwise not allowed. |
tibDeclaration? | boolean | Filer certification that TIB articles will be used solely per their HTS subheading terms, not for sale, and will be exported or destroyed within the applicable 6-month or 1-year period from date of importation. Required for Entry Type 23 (TIB) summaries. |
tradeAgreementReconciliation? | boolean | Indicates that certain issues (value, classification, etc.) are subject to a future reconciliation under an eligible Trade Agreement. Only allowed for Entry Types 01, 02, and 06. Maps to 10-Record Trade Agreement Reconciliation Indicator. |
trip? | string | Transportation trip number or voyage number associated with the arriving conveyance. Used for manifest matching and cargo control. |
type? | | "01" | "02" | "03" | "06" | "07" | "11" | "12" | "21" | "22" | "23" | "31" | "32" | "34" | "38" | "51" | "52" | Entry type code indicating the category of entry (e.g., 01-Consumption, 06-FTZ, 21-Warehouse, 23-TIB). Determines applicable procedures and requirements. |
usStateOfDestinationCode? | | "AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "VI" | "WA" | "WV" | "WI" | "WY" | Standard USPS two-character code for the U.S. state, territory, or possession where the merchandise is ultimately destined. |