OfficialStatements

Workspace API

---

Workspace API / models/OfficialStatements

models/OfficialStatements

Interfaces

OfficialStatement

Defined in: models/OfficialStatements.ts:5

Properties

id

id: string

Defined in: models/OfficialStatements.ts:6

organization_id

organization_id: string

Defined in: models/OfficialStatements.ts:7

issuer_id

issuer_id: string

Defined in: models/OfficialStatements.ts:8

document_id

document_id: string

Defined in: models/OfficialStatements.ts:9

fiscal_year_end

fiscal_year_end: Date | null

Defined in: models/OfficialStatements.ts:10

filing_deadline

filing_deadline: Date | null

Defined in: models/OfficialStatements.ts:11

cdu_location

cdu_location: { page_start: number; page_end: number; } | null

Defined in: models/OfficialStatements.ts:12

cdu_section_2_content

cdu_section_2_content: string | null

Defined in: models/OfficialStatements.ts:13

baseline_exhibit_reference

baseline_exhibit_reference: { exhibit_name: string; page_start: number; page_end: number; } | null

Defined in: models/OfficialStatements.ts:14

required_components

required_components: string[] | null

Defined in: models/OfficialStatements.ts:15

source_traceability

source_traceability: Record<string, any> | null

Defined in: models/OfficialStatements.ts:16

status

status: "failed" | "completed" | "processing"

Defined in: models/OfficialStatements.ts:17

cdu_extracted

cdu_extracted: boolean

Defined in: models/OfficialStatements.ts:18

baseline_reference_extracted

baseline_reference_extracted: boolean

Defined in: models/OfficialStatements.ts:19

filing_deadline_calculated

filing_deadline_calculated: boolean

Defined in: models/OfficialStatements.ts:20

created_at

created_at: Date

Defined in: models/OfficialStatements.ts:21

updated_at

updated_at: Date

Defined in: models/OfficialStatements.ts:22

---

CreateOfficialStatementData

Defined in: models/OfficialStatements.ts:26

Properties

issuerId

issuerId: string

Defined in: models/OfficialStatements.ts:27

documentId

documentId: string

Defined in: models/OfficialStatements.ts:28

organizationId

organizationId: string

Defined in: models/OfficialStatements.ts:29

fiscalYearEnd?

optional fiscalYearEnd: string

Defined in: models/OfficialStatements.ts:30

cduLocation?

optional cduLocation: object

Defined in: models/OfficialStatements.ts:31

page_start

page_start: number

page_end

page_end: number

cduSection2Content?

optional cduSection2Content: string

Defined in: models/OfficialStatements.ts:32

baselineExhibitReference?

optional baselineExhibitReference: object

Defined in: models/OfficialStatements.ts:33

exhibit_name

exhibit_name: string

page_start

page_start: number

page_end

page_end: number

requiredComponents?

optional requiredComponents: string[]

Defined in: models/OfficialStatements.ts:34

sourceTraceability?

optional sourceTraceability: Record<string, any>

Defined in: models/OfficialStatements.ts:35

---

UpdateOfficialStatementData

Defined in: models/OfficialStatements.ts:38

Properties

fiscalYearEnd?

optional fiscalYearEnd: string

Defined in: models/OfficialStatements.ts:39

filingDeadline?

optional filingDeadline: string

Defined in: models/OfficialStatements.ts:40

cduLocation?

optional cduLocation: object

Defined in: models/OfficialStatements.ts:41

page_start

page_start: number

page_end

page_end: number

cduSection2Content?

optional cduSection2Content: string

Defined in: models/OfficialStatements.ts:42

baselineExhibitReference?

optional baselineExhibitReference: object

Defined in: models/OfficialStatements.ts:43

exhibit_name

exhibit_name: string

page_start

page_start: number

page_end

page_end: number

requiredComponents?

optional requiredComponents: string[]

Defined in: models/OfficialStatements.ts:44

sourceTraceability?

optional sourceTraceability: Record<string, any>

Defined in: models/OfficialStatements.ts:45

status?

optional status: "failed" | "completed" | "processing"

Defined in: models/OfficialStatements.ts:46

cduExtracted?

optional cduExtracted: boolean

Defined in: models/OfficialStatements.ts:47

baselineReferenceExtracted?

optional baselineReferenceExtracted: boolean

Defined in: models/OfficialStatements.ts:48

filingDeadlineCalculated?

optional filingDeadlineCalculated: boolean

Defined in: models/OfficialStatements.ts:49

Functions

calculateFilingDeadline()

calculateFilingDeadline(fiscalYearEnd): Date

Defined in: models/OfficialStatements.ts:55

Calculate filing deadline from fiscal year end (fiscal_year_end + 180 days)

Parameters

fiscalYearEnd

string | Date

Returns

Date

---

createOfficialStatement()

createOfficialStatement(data, organizationId, log): Promise<OfficialStatement>

Defined in: models/OfficialStatements.ts:66

Create a new official statement record RLS enforcement: Validates that issuer belongs to user's organization

Parameters

data

CreateOfficialStatementData

organizationId

string

log

Logger = logger

Returns

Promise<OfficialStatement>

---

getOfficialStatementById()

getOfficialStatementById(id, organizationId, log): Promise<OfficialStatement | null>

Defined in: models/OfficialStatements.ts:154

Get official statement by ID RLS enforcement: Joins with issuers table to filter by organization_id

Parameters

id

string

organizationId

string

log

Logger = logger

Returns

Promise<OfficialStatement | null>

---

getOfficialStatementByDocumentId()

getOfficialStatementByDocumentId(documentId, organizationId, log): Promise<OfficialStatement | null>

Defined in: models/OfficialStatements.ts:202

Get official statement by document_id RLS enforcement: Joins with issuers table to filter by organization_id

Parameters

documentId

string

organizationId

string

log

Logger = logger

Returns

Promise<OfficialStatement | null>

---

updateOfficialStatement()

updateOfficialStatement(id, data, organizationId, log): Promise<OfficialStatement>

Defined in: models/OfficialStatements.ts:253

Update official statement RLS enforcement: Validates that issuer belongs to user's organization

Parameters

id

string

data

UpdateOfficialStatementData

organizationId

string

log

Logger = logger

Returns

Promise<OfficialStatement>