@repo/shared / EFApiInput
Interface: EFApiInput
Input type for the ABI entry summary transaction generation endpoint.
This type represents the full data payload required to generate a CBP-compliant
CATAIR entry summary. It uses the *Type form variants (the shape that the
UI and API consumers work with), which differ from internal data models in that
they exclude server-assigned fields such as id, status, and importerId.
Calculated fields such as totals are excluded — they are computed server-side
from the provided data.
Line items and PGA data
Each line item in lineItems is an EFLineItemType optionally extended with
Partner Government Agency (PGA) data. PGA data is keyed by the agency type identifier
(a MapType string) and typed to the corresponding *Type interface. For
example, an FDA Food line item would include { foodCombined: FoodCombinedType }.
Properties
| Property | Type | Description |
|---|---|---|
filer | FilerType | Filer identity — filer code, port code, and broker/self-filer status used for transmission. |
importerProfile | ImporterProfileType | Importer profile containing the IOR number and importer-side standing preferences. |
lineItems | EFLineItemType & {aacApqAvsAbs?: AACAPQAVSABSType;apl?: APLType;berWinDspTob?: BerWinDspTobType;biologics?: BiologicsType;cosmeticMedicalRadiation?: CometicMedicalRadiationType;dea?: DEAType;drugs?: DrugsType;egMOORPN?: EGMOORPNType;foodCombined?: FoodCombinedType;foodNonPN?: FoodNonPNType;fsi?: FSIType;fws?: FWSType;hfc?: HFCType;hms?: HMSTypeInner;nhtsa?: NHTSAType;nmfAmr?: NmfAmrType;nmfSection370?: NMFSection370Type;nmfSim?: NmfSimTypeInner;ods?: ODSType;omc?: OMCType;pesticide?: PesticideType;priorNotice?: PriorNoticeType;tobacco?: TobaccoType;ts1Ts2?: TS1TS2Type;vAndE?: VAndEType;}[] | Array of line items for each article in the shipment. Each line item may include optional PGA (Partner Government Agency) data keyed by PGA type identifier. |
shipping | EFDataType | Entry summary header data describing the overall shipment. |