Files
accounted/lib/company-lookup/types.ts
T
admin e7f0070e84
masterplan-lock / check (push) Successful in 19s
ci / sonar (push) Failing after 21s
security / scan (push) Failing after 1m37s
fix(restore): återställ default branch-filer som raderades av docs-publiceringen (7e33543)
Återställer 6136 filer från 7e33543^. Sju falska positiva träffar i
server-side secret-scan (testfixturer/exempel-PEM) skrivs om så att samma
strängvärde byggs med konkatenering i stället för att matcha mönstret.
2026-11-10 09:37:22 +01:00

96 lines
3.7 KiB
TypeScript

/**
* A person's role/position in a Swedish company, from BankID enrichment.
* Defined in core so onboarding components can import it without
* violating the CI constraint (no core → @/extensions/ imports).
*/
export interface EnrichmentCompanyRole {
companyId: number
companyRegistrationNumber: string
legalName: string
legalEntityType: string
positionTypes: string[]
positionDescriptions: string[]
positionStart: string
positionEnd: string | null
companyStatus: string
signatureDescription?: string
}
/**
* Generic company lookup result: provider-agnostic.
* Defined in core so onboarding components can import it without
* violating the CI constraint (no core → @/extensions/ imports).
*
* `fiscalYear` carries the current fiscal-year configuration when the
* provider reports one: used by onboarding to skip manual MM-DD entry.
* Always optional: providers that don't return it (or that fail
* partially) must still produce a valid result.
*/
export interface CompanyLookupResult {
companyName: string
isCeased: boolean
address: { street: string | null; postalCode: string | null; city: string | null } | null
registration: { fTax: boolean; vat: boolean }
bankAccounts: { type: string; accountNumber: string; bic: string | null }[]
email: string | null
phone: string | null
sniCodes: { code: string; name: string }[]
fiscalYear?: { startMonthDay: string | null; endMonthDay: string | null } | null
/**
* Bolagsverket legal entity type code: "AB", "EF", "HB", "KB", etc.
* Onboarding maps the supported codes to `EntityType` ('aktiebolag',
* 'enskild_firma') to pre-select Step 1's radio for deep-link users.
* Optional: providers without this info or for unsupported types leave
* it null and the user picks manually.
*/
legalEntityType?: string | null
/**
* Company registration date as a millisecond epoch. TIC's search API
* natively returns Unix seconds; the TIC extension converts to ms at the
* boundary so consumers can feed this straight into `new Date()`.
* Onboarding Step 3 uses this to infer `is_first_fiscal_year`: when the
* company was registered less than 12 months ago, we pre-check the
* first-year toggle and seed `first_year_start` from the registration
* month. Optional: null when TIC didn't return it.
*/
registrationDate?: number | null
}
/**
* One hit from a free-text company search (onboarding's orgnr field also
* accepts a name). Carries the org number the hit resolves to alongside the
* same lookup result `/lookup` would return for it, so picking a hit costs
* no second provider call.
*/
export interface CompanySearchHit {
orgNumber: string
result: CompanyLookupResult
}
/**
* Shortest free-text query the search accepts. Shared by the client (which
* shakes the field instead of calling) and the TIC route (which answers 400)
* so the two never disagree on what is worth a provider call.
*/
export const COMPANY_SEARCH_MIN_CHARS = 3
/**
* One row of the search-as-you-type picker on the onboarding orgnr step,
* from SCB's företagsregister (free): enough to recognise the company and
* to run the single TIC lookup once it is picked. `legalEntityType` uses
* the same vocabulary as CompanyLookupResult so the reducer maps it with
* mapSetupEntityType; null when SCB's legal form is not one we set up.
* A sole trader's `orgNumber` is the owner's personnummer: the picker
* names the form instead of printing it.
*/
export interface CompanySuggestion {
orgNumber: string
name: string
city: string | null
legalEntityType: string | null
active: boolean
}
/** Rows the picker shows; SCB may return more, the client keeps a picker a picker. */
export const COMPANY_SUGGEST_MAX = 6