@robosystems/client 0.2.49 → 0.3.0

package/sdk-extensions/LedgerClient.d.ts

@@ -1,416 +0,0 @@
-import type { AccountListResponse, AccountRollupsResponse, AccountTreeResponse, ClosingBookStructuresResponse, LedgerSummaryResponse, LedgerTransactionDetailResponse, LedgerTransactionListResponse, MappingDetailResponse, TrialBalanceResponse } from '../sdk/types.gen';
-export interface LedgerEntity {
-    id: string;
-    name: string;
-    legalName: string | null;
-    entityType: string | null;
-    industry: string | null;
-    status: string | null;
-}
-export interface MappingInfo {
-    id: string;
-    name: string;
-    description: string | null;
-    structureType: string;
-    taxonomyId: string;
-    isActive: boolean;
-}
-export interface MappingCoverage {
-    totalCoaElements: number;
-    mappedCount: number;
-    unmappedCount: number;
-    coveragePercent: number;
-    highConfidence: number;
-    mediumConfidence: number;
-    lowConfidence: number;
-}
-export interface Structure {
-    id: string;
-    name: string;
-    structureType: string;
-}
-export interface Schedule {
-    structureId: string;
-    name: string;
-    taxonomyName: string;
-    entryTemplate: Record<string, unknown> | null;
-    scheduleMetadata: Record<string, unknown> | null;
-    totalPeriods: number;
-    periodsWithEntries: number;
-}
-export interface ScheduleCreated {
-    structureId: string;
-    name: string;
-    taxonomyId: string;
-    totalPeriods: number;
-    totalFacts: number;
-}
-export interface ScheduleFact {
-    elementId: string;
-    elementName: string;
-    value: number;
-    periodStart: string;
-    periodEnd: string;
-}
-export interface PeriodCloseItem {
-    structureId: string;
-    structureName: string;
-    amount: number;
-    status: string;
-    entryId: string | null;
-}
-export interface PeriodCloseStatus {
-    fiscalPeriodStart: string;
-    fiscalPeriodEnd: string;
-    periodStatus: string;
-    schedules: PeriodCloseItem[];
-    totalDraft: number;
-    totalPosted: number;
-}
-/**
- * Outcome of an idempotent `createClosingEntry` call.
- *
- * - `created`     — no prior draft, new draft created
- * - `unchanged`   — prior draft matches current schedule fact, no-op
- * - `regenerated` — prior draft was stale, replaced with a fresh one
- * - `removed`     — prior draft existed but schedule no longer covers this period
- * - `skipped`     — no prior draft and no in-scope fact; nothing to do
- */
-export type ClosingEntryOutcome = 'created' | 'unchanged' | 'regenerated' | 'removed' | 'skipped';
-/**
- * Result of an idempotent closing-entry call. `entry_id`, `amount`, and
- * related fields are null for `removed` and `skipped` outcomes.
- */
-export interface ClosingEntry {
-    outcome: ClosingEntryOutcome;
-    entryId: string | null;
-    status: string | null;
-    postingDate: string | null;
-    memo: string | null;
-    debitElementId: string | null;
-    creditElementId: string | null;
-    amount: number | null;
-    reason: string | null;
-}
-export type LedgerEntryType = 'standard' | 'adjusting' | 'closing' | 'reversing';
-export interface FiscalPeriodSummary {
-    name: string;
-    startDate: string;
-    endDate: string;
-    status: string;
-    closedAt: string | null;
-}
-export interface FiscalCalendarState {
-    graphId: string;
-    fiscalYearStartMonth: number;
-    closedThrough: string | null;
-    closeTarget: string | null;
-    gapPeriods: number;
-    catchUpSequence: string[];
-    closeableNow: boolean;
-    blockers: string[];
-    lastCloseAt: string | null;
-    initializedAt: string | null;
-    lastSyncAt: string | null;
-    periods: FiscalPeriodSummary[];
-}
-export interface InitializeLedgerOptions {
-    closedThrough?: string | null;
-    fiscalYearStartMonth?: number;
-    earliestDataPeriod?: string | null;
-    autoSeedSchedules?: boolean;
-    note?: string | null;
-}
-export interface InitializeLedgerResult {
-    fiscalCalendar: FiscalCalendarState;
-    periodsCreated: number;
-    warnings: string[];
-}
-export interface ClosePeriodOptions {
-    note?: string | null;
-    allowStaleSync?: boolean;
-}
-export interface ClosePeriodResult {
-    period: string;
-    entriesPosted: number;
-    targetAutoAdvanced: boolean;
-    fiscalCalendar: FiscalCalendarState;
-}
-export interface DraftLineItemView {
-    lineItemId: string;
-    elementId: string;
-    elementCode: string | null;
-    elementName: string;
-    debitAmount: number;
-    creditAmount: number;
-    description: string | null;
-}
-export interface DraftEntryView {
-    entryId: string;
-    postingDate: string;
-    type: string;
-    memo: string | null;
-    provenance: string | null;
-    sourceStructureId: string | null;
-    sourceStructureName: string | null;
-    lineItems: DraftLineItemView[];
-    totalDebit: number;
-    totalCredit: number;
-    balanced: boolean;
-}
-export interface PeriodDraftsView {
-    period: string;
-    periodStart: string;
-    periodEnd: string;
-    draftCount: number;
-    totalDebit: number;
-    totalCredit: number;
-    allBalanced: boolean;
-    drafts: DraftEntryView[];
-}
-export interface ManualClosingLineItem {
-    elementId: string;
-    debitAmount?: number;
-    creditAmount?: number;
-    description?: string | null;
-}
-export interface CreateManualClosingEntryOptions {
-    postingDate: string;
-    memo: string;
-    lineItems: ManualClosingLineItem[];
-    entryType?: LedgerEntryType;
-}
-export interface TruncateScheduleOptions {
-    newEndDate: string;
-    reason: string;
-}
-export interface TruncateScheduleResult {
-    structureId: string;
-    newEndDate: string;
-    factsDeleted: number;
-    reason: string;
-}
-export interface CreateScheduleOptions {
-    name: string;
-    elementIds: string[];
-    periodStart: string;
-    periodEnd: string;
-    monthlyAmount: number;
-    entryTemplate: {
-        debitElementId: string;
-        creditElementId: string;
-        entryType?: LedgerEntryType;
-        memoTemplate?: string;
-    };
-    taxonomyId?: string;
-    scheduleMetadata?: {
-        method?: string;
-        originalAmount?: number;
-        residualValue?: number;
-        usefulLifeMonths?: number;
-        assetElementId?: string;
-    };
-}
-export declare class LedgerClient {
-    private config;
-    constructor(config: {
-        baseUrl: string;
-        credentials?: 'include' | 'same-origin' | 'omit';
-        headers?: Record<string, string>;
-        token?: string;
-    });
-    /**
-     * Get the entity (company/organization) for this graph.
-     */
-    getEntity(graphId: string): Promise<LedgerEntity | null>;
-    /**
-     * List accounts (flat).
-     */
-    listAccounts(graphId: string): Promise<AccountListResponse>;
-    /**
-     * Get the account tree (hierarchical).
-     */
-    getAccountTree(graphId: string): Promise<AccountTreeResponse>;
-    /**
-     * List transactions with optional date filters.
-     */
-    listTransactions(graphId: string, options?: {
-        startDate?: string;
-        endDate?: string;
-        limit?: number;
-        offset?: number;
-    }): Promise<LedgerTransactionListResponse>;
-    /**
-     * Get transaction detail with entries and line items.
-     */
-    getTransaction(graphId: string, transactionId: string): Promise<LedgerTransactionDetailResponse>;
-    /**
-     * Get trial balance (CoA-level debits/credits).
-     */
-    getTrialBalance(graphId: string, options?: {
-        startDate?: string;
-        endDate?: string;
-    }): Promise<TrialBalanceResponse>;
-    /**
-     * Get mapped trial balance (CoA rolled up to GAAP concepts).
-     */
-    getMappedTrialBalance(graphId: string, options?: {
-        mappingId?: string;
-        startDate?: string;
-        endDate?: string;
-    }): Promise<unknown>;
-    /**
-     * Get ledger summary (account count, transaction count, date range).
-     */
-    getSummary(graphId: string): Promise<LedgerSummaryResponse>;
-    /**
-     * Get the reporting taxonomy (US GAAP seed).
-     */
-    getReportingTaxonomy(graphId: string): Promise<unknown>;
-    /**
-     * List reporting structures (IS, BS, CF) for a taxonomy.
-     */
-    listStructures(graphId: string, taxonomyId?: string): Promise<Structure[]>;
-    /**
-     * List elements (CoA accounts, GAAP concepts, etc.).
-     */
-    listElements(graphId: string, options?: {
-        taxonomyId?: string;
-        source?: string;
-        classification?: string;
-        isAbstract?: boolean;
-        limit?: number;
-        offset?: number;
-    }): Promise<unknown>;
-    /**
-     * Create a new CoA→GAAP mapping structure.
-     * Returns the created mapping info.
-     */
-    createMappingStructure(graphId: string, options?: {
-        name?: string;
-        description?: string;
-        taxonomyId?: string;
-    }): Promise<MappingInfo>;
-    /**
-     * List available CoA→GAAP mapping structures.
-     */
-    listMappings(graphId: string): Promise<MappingInfo[]>;
-    /**
-     * Get mapping detail — all associations with element names.
-     */
-    getMappingDetail(graphId: string, mappingId: string): Promise<MappingDetailResponse>;
-    /**
-     * Get mapping coverage — how many CoA elements are mapped.
-     */
-    getMappingCoverage(graphId: string, mappingId: string): Promise<MappingCoverage>;
-    /**
-     * Create a manual mapping association (CoA element → GAAP element).
-     */
-    createMapping(graphId: string, mappingId: string, fromElementId: string, toElementId: string, confidence?: number): Promise<void>;
-    /**
-     * Delete a mapping association.
-     */
-    deleteMapping(graphId: string, mappingId: string, associationId: string): Promise<void>;
-    /**
-     * Trigger AI auto-mapping (MappingAgent).
-     * Returns immediately — the agent runs in the background.
-     */
-    autoMap(graphId: string, mappingId: string): Promise<{
-        operationId?: string;
-    }>;
-    /**
-     * Create a schedule with pre-generated monthly facts.
-     */
-    createSchedule(graphId: string, options: CreateScheduleOptions): Promise<ScheduleCreated>;
-    /**
-     * List all schedules for a graph.
-     */
-    listSchedules(graphId: string): Promise<Schedule[]>;
-    /**
-     * Get facts for a schedule, optionally filtered by period.
-     */
-    getScheduleFacts(graphId: string, structureId: string, periodStart?: string, periodEnd?: string): Promise<ScheduleFact[]>;
-    /**
-     * Get close status for all schedules in a fiscal period.
-     */
-    getPeriodCloseStatus(graphId: string, periodStart: string, periodEnd: string): Promise<PeriodCloseStatus>;
-    /**
-     * Idempotently create (or refresh) a draft closing entry from a schedule's
-     * facts for a period. The `outcome` field describes what actually happened:
-     *
-     * - `created`     — new draft
-     * - `unchanged`   — existing draft still matches the schedule; no-op
-     * - `regenerated` — existing draft was stale; replaced
-     * - `removed`     — schedule no longer covers this period; stale draft deleted
-     * - `skipped`     — no existing draft and no in-scope fact; nothing to do
-     */
-    createClosingEntry(graphId: string, structureId: string, postingDate: string, periodStart: string, periodEnd: string, memo?: string): Promise<ClosingEntry>;
-    /**
-     * Get all closing book structure categories for the sidebar.
-     * Returns statements, account rollups, schedules, trial balance,
-     * and period close grouped into categories.
-     */
-    getClosingBookStructures(graphId: string): Promise<ClosingBookStructuresResponse>;
-    /**
-     * Get account rollups — CoA accounts grouped by reporting element with balances.
-     * Shows how company-specific accounts roll up to standardized reporting lines.
-     */
-    getAccountRollups(graphId: string, options?: {
-        mappingId?: string;
-        startDate?: string;
-        endDate?: string;
-    }): Promise<AccountRollupsResponse>;
-    /**
-     * Initialize the fiscal calendar for a graph. Creates FiscalPeriod rows
-     * for the data window, sets `closed_through` / `close_target`, and emits
-     * an `initialized` audit event. Fails with 409 if already initialized.
-     */
-    initializeLedger(graphId: string, options?: InitializeLedgerOptions): Promise<InitializeLedgerResult>;
-    /**
-     * Get the current fiscal calendar state — pointers, gap, closeable status.
-     */
-    getFiscalCalendar(graphId: string): Promise<FiscalCalendarState>;
-    /**
-     * Set the close target for a graph. Validates that the target is not in
-     * the future and not before `closed_through`.
-     */
-    setCloseTarget(graphId: string, period: string, note?: string | null): Promise<FiscalCalendarState>;
-    /**
-     * Close a fiscal period — the final commit action.
-     *
-     * Validates closeable gates, transitions all draft entries in the period
-     * to `posted`, marks the FiscalPeriod closed, and advances `closed_through`
-     * (auto-advancing `close_target` when reached).
-     */
-    closePeriod(graphId: string, period: string, options?: ClosePeriodOptions): Promise<ClosePeriodResult>;
-    /**
-     * Reopen a closed fiscal period. Requires a non-empty `reason` for the
-     * audit log. Posted entries stay posted; the period transitions to
-     * `closing` so the user can post adjustments and re-close.
-     */
-    reopenPeriod(graphId: string, period: string, reason: string, note?: string | null): Promise<FiscalCalendarState>;
-    /**
-     * List all draft entries in a fiscal period for review before close.
-     * Fully expanded with line items, element metadata, and per-entry balance.
-     *
-     * Pure read — call repeatedly without side effects.
-     */
-    listPeriodDrafts(graphId: string, period: string): Promise<PeriodDraftsView>;
-    /**
-     * Truncate a schedule — end it early by deleting facts with
-     * `period_start > new_end_date`, along with any stale draft entries they
-     * produced. Historical posted facts are preserved.
-     *
-     * `new_end_date` must be a month-end date (service enforces this).
-     */
-    truncateSchedule(graphId: string, structureId: string, options: TruncateScheduleOptions): Promise<TruncateScheduleResult>;
-    /**
-     * Create a manual draft closing entry with arbitrary balanced line items.
-     * Not tied to a schedule — used for disposals, adjustments, and other
-     * one-off closing events.
-     *
-     * Line items must sum to balanced debits/credits. Rejects entries
-     * targeting an already-closed period.
-     */
-    createManualClosingEntry(graphId: string, options: CreateManualClosingEntryOptions): Promise<ClosingEntry>;
-}