@repo/shared / ImporterProfileType
Interface: ImporterProfileType
Importer profile — Tarifflo's representation of a CBP importer/consignee identity record plus the standing filing preferences shared across entry summaries filed for this importer.
The identity + address + contact fields mirror CBP's Importer/Consignee File and feed the
"Importer/Consignee Create/Update" (Form 5106) transaction. Entry-summary filing only reads
importerOfRecord from here; the richer fields are needed at 5106 create/update time.
Properties
| Property | Type | Description |
|---|---|---|
alternateNames? | ImporterAlternateName[] | Alternate names — DBA / DIV / AKA (CBP TA, repeatable). |
approvedForReconciliations? | boolean | - |
businessDescription? | string | - |
checkDigitOffset? | number | - |
contactName? | string | - |
contactPhone? | string | Phone to contact the importer — also feeds CBP TD on a 5106 submission. |
deferredTaxPaymentCode? | "1" | "2" | - |
email? | string | - |
fax? | string | - |
formAction? | "A" | "U" | "N" | Add (A) / Update (U) / request a CBP-assigned number (N). Drives required-field gating. |
hasSSNButWantsCBPNumber? | boolean | - |
importerName? | string | Importer's full legal name (≤100, also the display name). The encoder transmits the first 32 chars on CBP T1 (abbreviated name) and the full value on T3 (+TN overflow) when it exceeds 32 — so this single field serves as both the abbreviated and the legal name. |
importerOfRecord? | string | IRS/EIN, SSN, or CBP-assigned number. Left blank for an N request until CBP assigns one. |
importerType? | "P" | "F" | "I" | "S" | "C" | "K" | "L" | "G" | - |
knownImporter? | boolean | - |
mailingAddressExplanation? | string | Free-text explanation, required when mailing address type is "Other". |
mailingAddressLine1? | string | - |
mailingAddressLine2? | string | - |
mailingAddressType? | "1" | "2" | "3" | "5" | "6" | "7" | "8" | "4" | - |
mailingCity? | string | - |
mailingCountryCode? | | "AL" | "AZ" | "AR" | "CA" | "CO" | "DE" | "GA" | "ID" | "IL" | "IN" | "KY" | "LA" | "ME" | "MD" | "MA" | "MN" | "MS" | "MO" | "MT" | "NE" | "NC" | "PA" | "PR" | "SC" | "SD" | "TN" | "VA" | "VI" | "CR" | "AU" | "BH" | "CL" | "JO" | "JP" | "KR" | "MX" | "NP" | "OM" | "PE" | "SG" | "GU" | "SK" | "NU" | "NL" | "YT" | "AG" | "BS" | "CM" | "CH" | "GT" | "GR" | "NA" | "SL" | "SI" | "SO" | "TM" | "TL" | "VE" | "ZA" | "AD" | "AE" | "AF" | "AI" | "AM" | "AO" | "AS" | "AT" | "AW" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BI" | "BJ" | "BM" | "BN" | "BO" | "BR" | "BT" | "BU" | "BV" | "BW" | "BY" | "BZ" | "CC" | "CD" | "CF" | "CG" | "CI" | "CK" | "CN" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GB" | "GD" | "GE" | "GF" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GW" | "GY" | "GZ" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IE" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JM" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KV" | "KW" | "KZ" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MC" | "MG" | "MH" | "MK" | "ML" | "MM" | "MP" | "MQ" | "MR" | "MU" | "MV" | "MW" | "MY" | "MZ" | "NF" | "NG" | "NI" | "NO" | "NR" | "NZ" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SE" | "SH" | "SJ" | "SM" | "SN" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VC" | "VG" | "VN" | "VU" | "WE" | "WF" | "WS" | "YE" | "ZM" | "ZW" | - |
mailingPostalCode? | string | - |
mailingStateProvince? | | "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" | "CL" | "MX" | "PE" | "GU" | "AB" | "NB" | "BC" | "MB" | "NS" | "ON" | "QC" | "SK" | "NT" | "NU" | "NL" | "YT" | "AG" | "BS" | "CM" | "CS" | "CH" | "DF" | "DG" | "GT" | "GR" | "HG" | "JA" | "NA" | "OA" | "PU" | "QT" | "QR" | "SL" | "SI" | "SO" | "TB" | "TM" | "TL" | "VE" | "YU" | "ZA" | "FN" | - |
nationalPermit? | boolean | Whether this broker holds a CBP National Permit authorizing Remote Location Filing (RLF) under 19 CFR 111. RLF allows an approved broker to electronically file entry summaries at any CBP port of entry from a single ABI profile port code, rather than being restricted to their registered port. This is a capability flag — it does NOT mean every entry this broker files is a remote filing. Whether a specific entry is actually remote-filed is determined by comparing this profile's portCode against the entry's portOfEntry. When those differ and this flag is true, the entry is an RLF filing, which requires: - Cargo Release Certification (isCargoRelease) for all non-prohibited entry types - A Designated Exam Port Code See: https://www.cbp.gov/trade/programs-administration/entry-summary/remote-location-filing |
noIRS? | boolean | - |
noSSN? | boolean | - |
notAppliedForTaxId? | boolean | - |
notifyParty? | string | - |
notUSResident? | boolean | - |
officers? | ImporterOfficer[] | Company officers/owners (CBP TI + TJ, repeatable). |
participatingInGBI? | boolean | - |
physicalAddressExplanation? | string | Free-text explanation, required when physical address type is "Other". |
physicalAddressLine1? | string | - |
physicalAddressLine2? | string | - |
physicalAddressType? | "1" | "2" | "3" | "5" | "8" | "4" | - |
physicalCity? | string | - |
physicalCountryCode? | | "AL" | "AZ" | "AR" | "CA" | "CO" | "DE" | "GA" | "ID" | "IL" | "IN" | "KY" | "LA" | "ME" | "MD" | "MA" | "MN" | "MS" | "MO" | "MT" | "NE" | "NC" | "PA" | "PR" | "SC" | "SD" | "TN" | "VA" | "VI" | "CR" | "AU" | "BH" | "CL" | "JO" | "JP" | "KR" | "MX" | "NP" | "OM" | "PE" | "SG" | "GU" | "SK" | "NU" | "NL" | "YT" | "AG" | "BS" | "CM" | "CH" | "GT" | "GR" | "NA" | "SL" | "SI" | "SO" | "TM" | "TL" | "VE" | "ZA" | "AD" | "AE" | "AF" | "AI" | "AM" | "AO" | "AS" | "AT" | "AW" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BI" | "BJ" | "BM" | "BN" | "BO" | "BR" | "BT" | "BU" | "BV" | "BW" | "BY" | "BZ" | "CC" | "CD" | "CF" | "CG" | "CI" | "CK" | "CN" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GB" | "GD" | "GE" | "GF" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GW" | "GY" | "GZ" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "IE" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JM" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KV" | "KW" | "KZ" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MC" | "MG" | "MH" | "MK" | "ML" | "MM" | "MP" | "MQ" | "MR" | "MU" | "MV" | "MW" | "MY" | "MZ" | "NF" | "NG" | "NI" | "NO" | "NR" | "NZ" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SE" | "SH" | "SJ" | "SM" | "SN" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VC" | "VG" | "VN" | "VU" | "WE" | "WF" | "WS" | "YE" | "ZM" | "ZW" | - |
physicalPostalCode? | string | - |
physicalStateProvince? | | "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" | "CL" | "MX" | "PE" | "GU" | "AB" | "NB" | "BC" | "MB" | "NS" | "ON" | "QC" | "SK" | "NT" | "NU" | "NL" | "YT" | "AG" | "BS" | "CM" | "CS" | "CH" | "DF" | "DG" | "GT" | "GR" | "HG" | "JA" | "NA" | "OA" | "PU" | "QT" | "QR" | "SL" | "SI" | "SO" | "TB" | "TM" | "TL" | "VE" | "YU" | "ZA" | "FN" | - |
referenceNumber? | string | - |
startingEntryNumber? | number | - |
website? | string | - |