@fayz-ai/plugin-financial 0.23.4 → 0.24.0

package/dist/types.d.ts

@@ -1,1362 +0,0 @@
-/** Direction: debit (money going out / payable) or credit (money coming in / receivable) */
-export type TransactionDirection = 'debit' | 'credit';
-/** What kind of financial movement this is */
-export type MovementKind = 'bill' | 'payment' | 'transfer';
-/** Status of a financial movement */
-export type MovementStatus = 'pending' | 'paid' | 'partial' | 'overdue' | 'cancelled';
-/** Status of an invoice */
-export type InvoiceStatus = 'draft' | 'open' | 'partial' | 'paid' | 'cancelled' | 'overdue'
-/**
- * PREVISTO, não devido.
- *
- * A ocorrência de uma recorrência que ainda não foi consolidada: ela aparece
- * na lista para que o mês se enxergue inteiro, mas não é conta — não tem
- * fatura, não entra no razão e não cobra ninguém. Vira conta quando alguém
- * manda (ver `financial_consolidate_occurrence`). É o `provisioned` do V1.
- */
- | 'provisioned';
-/** Type of bank account */
-export type BankAccountType = 'bank' | 'cash_physical' | 'cash_session' | 'card_receivable_credit' | 'card_receivable_debit' | 'card_payable' | 'person' | 'unit' | 'unidentified' | 'system';
-/** Cash session status */
-export type CashSessionStatus = 'open' | 'closed';
-/** Discount/interest application mode */
-export type AdjustmentMode = 'percentage' | 'fixed';
-/** Chart of accounts node type */
-export type AccountNodeType = 'group' | 'leaf';
-/** Item type on an invoice line — parametrizable per vertical */
-export type InvoiceItemKind = string;
-export interface Invoice {
-    id: string;
-    direction: TransactionDirection;
-    /** ISO code the document was written in. Absent = the house's currency. */
-    currency?: string;
-    /** Free labels the house puts on the bill. */
-    tags?: string[];
-    /** Competência — o eixo do razão e do DRE. */
-    invoiceDate: string;
-    /**
-     * Vencimento: o próximo em aberto, ou o último quando tudo já foi pago.
-     *
-     * É a data que a LISTA mostra e por onde ela ordena, porque é a pergunta da
-     * tela ("o que eu pago esta semana") e é como o V1 sempre a construiu. A
-     * competência continua sendo a do razão.
-     */
-    dueDate?: string;
-    /**
-     * O TÍTULO a que esta linha pertence.
-     *
-     * A lista é de PARCELAS — é assim que o V1 sempre a mostrou, e é a única
-     * granularidade em que "o que vence no dia 11" tem resposta. Então `id` é a
-     * parcela (a chave da linha) e `invoiceId` é o documento que se abre ao
-     * clicar. Numa linha que não veio parcelada os dois são iguais.
-     */
-    invoiceId?: string;
-    /** "3 de 4" — o numerador. */
-    installmentNumber?: number;
-    /** Quantos recibos a conta tem. O clipe da linha, como no V1. */
-    attachmentCount?: number;
-    fiscalNumber?: string;
-    totalAmount: number;
-    paidAmount: number;
-    status: InvoiceStatus;
-    totalInstallments: number;
-    contactId?: string;
-    contactName?: string;
-    cashSessionId?: string;
-    unitId?: string;
-    observations?: string;
-    /** Denormalized summary of item descriptions for list display */
-    itemsSummary?: string;
-    /** Latest active settlement details for this installment in list views. */
-    paymentMethodId?: string;
-    paymentMethodTypeId?: string;
-    paymentAccountId?: string;
-    paymentCardInstallments?: number;
-    /** If this order has a scheduled time (booking), the start time */
-    bookingStartsAt?: string;
-    metadata?: Record<string, unknown>;
-    tenantId: string;
-    createdAt: string;
-    updatedAt: string;
-    /** Who filed the bill — feeds the record footer. Written by the DB trigger. */
-    createdBy?: string;
-    /**
-     * Esta linha é uma OCORRÊNCIA provisionada, não uma conta.
-     *
-     * Linha virtual: não existe fatura por trás dela. A lista a desenha
-     * tracejada e troca as ações pelo botão «Consolidar», que é o único caminho
-     * que a transforma em dívida. Ver o V1 em `PayablesList`.
-     */
-    isProvisionedOccurrence?: boolean;
-    /** O id da ocorrência, que é o que «Consolidar» manda para a RPC. */
-    occurrenceId?: string;
-    /** A régua que a gerou — para abrir a recorrência a partir da linha. */
-    recurringBillId?: string;
-}
-export interface InvoiceItem {
-    id: string;
-    invoiceId: string;
-    /** The picture of the product this line names, when it names one that has a picture. */
-    imageUrl?: string;
-    itemKind: InvoiceItemKind;
-    referenceId?: string;
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    totalAmount: number;
-    discount: number;
-    surcharge: number;
-    accountId?: string;
-    costCenterId?: string;
-    isExecuted?: boolean;
-    executionDate?: string;
-    executedByProfessionalId?: string;
-    metadata?: Record<string, unknown>;
-    /** Set when the line was cancelled on its own (cancel by item). */
-    cancelledAt?: string;
-    cancelReason?: string;
-    createdAt: string;
-}
-export interface FinancialMovement {
-    id: string;
-    invoiceId?: string;
-    direction: TransactionDirection;
-    movementKind: MovementKind;
-    amount: number;
-    paidAmount: number;
-    status: MovementStatus;
-    /** For a payment: the bill it settles. See migration 014. */
-    settlesMovementId?: string;
-    dueDate: string;
-    paymentDate?: string;
-    installmentNumber?: number;
-    paymentMethodId?: string;
-    paymentMethodTypeId?: string;
-    /** How the money moved (`pix`, `cash`, `credit_card`…) — the column the
-     *  payment RPCs write; `paymentMethodId` is the V1-era registry link. */
-    method?: string;
-    bankAccountId?: string;
-    cashSessionId?: string;
-    cardBrand?: string;
-    cardInstallments?: number;
-    /** Processing/MDR fee deducted at settlement (net cash = paidAmount - feeAmount for credits) */
-    feeAmount?: number;
-    debitAccountId?: string;
-    creditAccountId?: string;
-    notes?: string;
-    metadata?: Record<string, unknown>;
-    /** Provider of an imported bank-statement line (set on imported movements only) */
-    externalSource?: string;
-    /** Provider-unique id of the imported bank line (idempotency key with externalSource) */
-    externalId?: string;
-    /** When this movement was reconciled — matched or accepted (undefined = pending) */
-    reconciledAt?: string;
-    /** For an imported bank line: the internal movement it was matched to */
-    matchedMovementId?: string;
-    tenantId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface BankAccount {
-    id: string;
-    name: string;
-    accountType: BankAccountType;
-    /** Número da instituição (COMPE/ISPB) — o que boleto, CNAB e PIX usam. `bankName` é o nome que a pessoa lê. */
-    bankCode?: string;
-    bankName?: string;
-    accountNumber?: string;
-    agencyNumber?: string;
-    /** Titular: raramente é o tenant — é o sócio, a holding, a empresa de serviços em cujo nome a conta está. */
-    holderName?: string;
-    holderDocument?: string;
-    /** Bank-specific CNAB fields live in metadata until every bank shares a stable schema. */
-    metadata?: Record<string, unknown>;
-    currentBalance: number;
-    initialBalance: number;
-    creditLimit?: number;
-    dueDay?: number;
-    closingDay?: number;
-    /** O dia seguinte ao fechamento: a compra cai na fatura mais distante. */
-    bestPurchaseDay?: number;
-    /** Bandeira, para conta de cartão. É o que liga a conta às taxas, que já são por bandeira. */
-    cardBrandId?: string | null;
-    /** Os quatro últimos do cartão (101) — é por eles que quem tem quatro sabe qual é. */
-    lastFour?: string | null;
-    /** Cor do cartão na tela — é assim que quem tem quatro sabe qual é (028). */
-    color?: string | null;
-    isActive: boolean;
-    unitId?: string;
-    tenantId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface CashSession {
-    id: string;
-    bankAccountId: string;
-    bankAccountName?: string;
-    status: CashSessionStatus;
-    openedAt: string;
-    openedByUserId?: string;
-    openedByName?: string;
-    openingBalance: number;
-    closedAt?: string;
-    closedByUserId?: string;
-    closedByName?: string;
-    closingBalance?: number;
-    expectedBalance?: number;
-    /** Live expected cash for an OPEN session, from v_financial_cash_session_expected (018). */
-    expectedCash?: number;
-    /** What the session took in, per payment method — pix included, not folded into "card". */
-    receivedByMethod?: Record<string, number>;
-    paymentCount?: number;
-    difference?: number;
-    notes?: string;
-    unitId?: string;
-    tenantId: string;
-    createdAt: string;
-}
-export interface PaymentMethod {
-    id: string;
-    name: string;
-    paymentMethodTypeId: string;
-    isActive: boolean;
-    discountMode?: AdjustmentMode;
-    discountValue?: number;
-    interestMode?: AdjustmentMode;
-    interestValue?: number;
-    minInstallments: number;
-    maxInstallments: number;
-    serviceFilterMode?: 'all' | 'include' | 'exclude';
-    serviceFilterIds?: string[];
-    tenantId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface PaymentMethodType {
-    id: string;
-    name: string;
-    transactionType?: string;
-    isActive: boolean;
-    allowedAccountTypes?: BankAccountType[];
-    tenantId: string;
-    createdAt: string;
-}
-/** The nature of a chart-of-accounts entry. */
-export type AccountType = 'asset' | 'liability' | 'equity' | 'revenue' | 'expense';
-export interface ChartOfAccountsNode {
-    id: string;
-    code: string;
-    name: string;
-    nodeType: AccountNodeType;
-    parentId?: string;
-    /** asset | liability | equity | revenue | expense — see migration 013. */
-    accountType?: AccountType;
-    isActive: boolean;
-    tenantId: string;
-    createdAt: string;
-}
-export interface CostCenter {
-    id: string;
-    code: string;
-    name: string;
-    isActive: boolean;
-    tenantId: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface CardTransaction {
-    id: string;
-    movementId: string;
-    cardBrand: string;
-    totalAmount: number;
-    installmentCount: number;
-    currentInstallment: number;
-    installmentAmount: number;
-    expectedDate: string;
-    receivedDate?: string;
-    fee?: number;
-    netAmount?: number;
-    status: 'pending' | 'received' | 'cancelled';
-    tenantId: string;
-    createdAt: string;
-}
-export interface CreateInvoiceInput {
-    direction: TransactionDirection;
-    invoiceDate: string;
-    fiscalNumber?: string;
-    contactId?: string;
-    contactName?: string;
-    cashSessionId?: string;
-    unitId?: string;
-    /** ISO code to write the document in. Absent = the unit's currency. */
-    currency?: string;
-    tags?: string[];
-    observations?: string;
-    metadata?: Record<string, unknown>;
-    items: CreateInvoiceItemInput[];
-    installments: CreateMovementInput[];
-}
-export interface CreateInvoiceItemInput {
-    itemKind: InvoiceItemKind;
-    referenceId?: string;
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    discount?: number;
-    surcharge?: number;
-    accountId?: string;
-    costCenterId?: string;
-    metadata?: Record<string, unknown>;
-}
-export interface CreateMovementInput {
-    direction: TransactionDirection;
-    movementKind: MovementKind;
-    amount: number;
-    dueDate: string;
-    installmentNumber?: number;
-    paymentMethodId?: string;
-    bankAccountId?: string;
-    notes?: string;
-    metadata?: Record<string, unknown>;
-}
-export interface PayMovementInput {
-    movementId: string;
-    amount: number;
-    paymentDate: string;
-    paymentMethodId?: string;
-    paymentMethodTypeId?: string;
-    bankAccountId?: string;
-    cashSessionId?: string;
-    cardBrand?: string;
-    cardInstallments?: number;
-    /** Free-text payment description / memo shown in the extract */
-    notes?: string;
-    /**
-     * O que acompanha ESTE pagamento — hoje, `receiptUrl`: a foto do comprovante.
-     * Fica na parcela paga, não na fatura: o recibo prova que um dinheiro
-     * específico mudou de mão.
-     */
-    metadata?: Record<string, unknown>;
-    /** Stable for every retry of the same payment attempt. */
-    idempotencyKey?: string;
-}
-export interface CancellationReason {
-    id: string;
-    name: string;
-}
-/** Goods a payable line brought into stock, still traceable to its note. */
-export interface InvoiceStockEntry {
-    itemId: string;
-    productId: string;
-    locationId: string;
-    /** Quantity that entered, in the product's stock unit. */
-    entered: number;
-    /** What is still at that location — the most a return or loss can move. */
-    available: number;
-    enteredOn: string;
-}
-export type StockDestination = 'devolver' | 'perda' | 'manter';
-export interface CancelInvoiceItemsInput {
-    invoiceId: string;
-    /** Empty = every live line (the whole invoice). */
-    itemIds: string[];
-    reasonId: string;
-    detail?: string;
-    stock: Array<{
-        itemId: string;
-        destination: StockDestination;
-        note?: string;
-    }>;
-    idempotencyKey?: string;
-}
-export interface CancelInvoiceItemsResult {
-    whole: boolean;
-    amount: number;
-    /** What had been paid on the cancelled part and became counterparty credit. */
-    creditAmount: number;
-}
-export interface InstallmentChargeInput {
-    installmentId: string;
-    kind: 'interest' | 'fine' | 'discount';
-    /** Always positive — `kind` carries the sign. */
-    amount: number;
-    accountId?: string;
-    description?: string;
-    idempotencyKey?: string;
-}
-export interface CancelInvoiceInput {
-    invoiceId: string;
-    reason: string;
-    /** Stable for every retry of the same cancellation attempt. */
-    idempotencyKey?: string;
-}
-export interface OpenCashSessionInput {
-    bankAccountId: string;
-    openingBalance: number;
-    openedByUserId?: string;
-    openedByName?: string;
-    unitId?: string;
-    notes?: string;
-}
-export interface CloseCashSessionInput {
-    sessionId: string;
-    closingBalance: number;
-    closedByUserId?: string;
-    closedByName?: string;
-    notes?: string;
-}
-export interface CreateBankAccountInput {
-    name: string;
-    accountType: BankAccountType;
-    bankCode?: string;
-    bankName?: string;
-    accountNumber?: string;
-    agencyNumber?: string;
-    holderName?: string;
-    holderDocument?: string;
-    initialBalance?: number;
-    creditLimit?: number;
-    dueDay?: number;
-    closingDay?: number;
-    bestPurchaseDay?: number;
-    cardBrandId?: string | null;
-    unitId?: string;
-}
-export interface DateRange {
-    from: string;
-    to: string;
-}
-export interface InvoiceQuery {
-    direction?: TransactionDirection;
-    status?: InvoiceStatus | InvoiceStatus[];
-    contactId?: string;
-    unitId?: string;
-    accountId?: string;
-    costCenterId?: string;
-    dateRange?: DateRange;
-    search?: string;
-    /** Número do documento/nota — o campo "Nota Fiscal" do recorte do V1. */
-    fiscalNumber?: string;
-    /** Conta bancária de onde saiu (ou entrou) o dinheiro — 114. */
-    bankAccountId?: string;
-    page?: number;
-    pageSize?: number;
-}
-export interface DreQuery {
-    year: number;
-    unitId?: string;
-}
-export interface DreRow {
-    unitId?: string;
-    competenceMonth?: string;
-    accountId?: string;
-    accountCode?: string;
-    accountName?: string;
-    accountType: 'revenue' | 'expense';
-    parentAccountId?: string;
-    statementCode?: string;
-    statementName?: string;
-    unclassified: boolean;
-    amount: number;
-    discount: number;
-    lineCount: number;
-}
-export interface MovementQuery {
-    direction?: TransactionDirection;
-    status?: MovementStatus | MovementStatus[];
-    bankAccountId?: string;
-    cashSessionId?: string;
-    /** Scope to a single invoice's movements (bills + payments). */
-    invoiceId?: string;
-    dateRange?: DateRange;
-    page?: number;
-    pageSize?: number;
-}
-export interface StatementQuery {
-    /** Omit (or pass undefined) for a consolidated "All accounts" statement */
-    bankAccountId?: string;
-    dateRange: DateRange;
-}
-export interface CreateTransferInput {
-    fromAccountId: string;
-    toAccountId: string;
-    amount: number;
-    /** YYYY-MM-DD — becomes payment_date on both ledger legs */
-    date: string;
-    notes?: string;
-}
-export interface TransferResult {
-    /** Shared correlation id stored in both legs' metadata */
-    transferId: string;
-    debitMovementId: string;
-    creditMovementId: string;
-}
-export interface PaginatedResult<T> {
-    data: T[];
-    total: number;
-}
-export interface FinancialSummary {
-    totalBalance: number;
-    totalReceivable: number;
-    totalPayable: number;
-    monthlyInflow: number;
-    monthlyOutflow: number;
-    overdueReceivableCount: number;
-    overdueReceivableAmount: number;
-    overduePayableCount: number;
-    overduePayableAmount: number;
-    /**
-     * Amounts in a currency with no rate to the house's on file. They are NOT in
-     * the totals above (never counted 1:1), so the screen has to say they exist.
-     */
-    excluded?: Array<{
-        currency: string;
-        balance: number;
-        receivable: number;
-        payable: number;
-        inflow: number;
-        outflow: number;
-    }>;
-}
-/** What a statement row represents — a normal movement or one leg of a transfer */
-export type StatementEntryKind = 'movement' | 'transfer-in' | 'transfer-out';
-export interface StatementEntry {
-    movement: FinancialMovement;
-    invoice?: Invoice;
-    /** NET cash running balance after this row */
-    runningBalance: number;
-    /** Amount that settled the receivable/payable (= paidAmount) */
-    gross: number;
-    /** Processing/MDR fee deducted (>= 0) */
-    fee: number;
-    /** Cash impact: gross - fee for credit; gross for debit */
-    net: number;
-    entryKind: StatementEntryKind;
-    /** For transfers: the other side's account */
-    counterAccountId?: string;
-    counterAccountName?: string;
-    /** When this row is a reconciled bank line, the internal movement it was matched to. */
-    reconciledWith?: {
-        movementId: string;
-        description?: string;
-        invoiceId?: string;
-        fiscalNumber?: string;
-        contactName?: string;
-    };
-}
-/** Full statement result with header context (opening/closing balance + period totals) */
-export interface StatementResult {
-    entries: StatementEntry[];
-    /** Balance as of start-of-day dateFrom (excludes in-range rows) */
-    openingBalance: number;
-    /** openingBalance + net of all in-range rows */
-    closingBalance: number;
-    /** Sum of NET credits in range */
-    totalCredits: number;
-    /** Sum of NET debits (cash out) in range */
-    totalDebits: number;
-    /** Sum of fees in range */
-    totalFees: number;
-    /** totalCredits - totalDebits */
-    net: number;
-    /** Echo of the queried account; undefined for consolidated */
-    accountId?: string;
-    /** Ledger-computed current balance of the selected account (as of today) */
-    accountCurrentBalance?: number;
-}
-export interface CashSessionSummary {
-    session: CashSession;
-    movementCount: number;
-    totalInflow: number;
-    totalOutflow: number;
-}
-/** A normalized bank-statement line, ready to import. */
-export interface BankStatementLine {
-    /** Provider-unique transaction id (idempotency key with externalSource) */
-    externalId: string;
-    /** Provider that produced the line (e.g. 'plugbank', 'inter') */
-    externalSource: string;
-    /** credit = money in, debit = money out */
-    direction: TransactionDirection;
-    /** Sempre positivo — o sinal esta em `direction`. */
-    amount: number;
-    /** YYYY-MM-DD settlement date */
-    date: string;
-    description: string;
-    /** Account the line belongs to; falls back to the import's bankAccountId */
-    bankAccountId?: string;
-    /** Quando o provedor diz que efetivou, se disser. */
-    effectiveAt?: string;
-    /** O saldo do banco NESTA linha — e com ele que se confere se o extrato bate. */
-    balanceAfter?: number;
-    counterpartyName?: string;
-    counterpartyDocument?: string;
-    document?: string;
-    code?: string;
-    category?: string;
-    transactionType?: string;
-    /** O cru, porque o contrato do provedor muda sem avisar. */
-    rawPayload?: Record<string, unknown>;
-}
-/**
- * A linha do extrato COMO ELA FICA GUARDADA — a evidencia, nao o lancamento.
- *
- * Ela nao e um `FinancialMovement` e a migration 112 explica por que: uma linha
- * recem-chegada nao tem duas pernas porque ainda nao se sabe contra o que ela
- * lanca, e `plg_financial_movements_legs_check` recusa quem nao tem. Casada, o
- * evento economico e o movimento; aceita como avulsa, e ela mesma.
- */
-export interface ImportedStatementLine extends BankStatementLine {
-    id: string;
-    tenantId?: string;
-    unitId?: string;
-    bankAccountId?: string;
-    /** O provedor tirou a linha do extrato. Ela nao some — deixa de aparecer. */
-    providerDeleted?: boolean;
-    reconciledAt?: string;
-    /** Nulo COM `reconciledAt` = aceita como avulsa. */
-    matchedMovementId?: string;
-    createdAt?: string;
-    updatedAt?: string;
-    /**
-     * De quem e o dinheiro, na linha JA conciliada — «Pagador:» numa entrada,
-     * «Fornecedor:» numa saida. Vem do lancamento casado, nao do provedor, e e
-     * o que responde «conciliei isto com o que?» sem abrir nada.
-     */
-    matchedCounterpartyName?: string;
-    /**
-     * A conta que a linha conciliada prova, para «Ver conta» ter para onde ir.
-     *
-     * Sai do MESMO `select` que ja busca a contraparte — ele lia
-     * `financial_invoice_id` e jogava fora. Um botao desabilitado "porque nao
-     * sabemos o id" quando o id estava na resposta e uma tela mentindo sobre o
-     * que ela tem.
-     */
-    matchedInvoiceId?: string;
-}
-export interface ImportBankTransactionsInput {
-    /** Default account for lines that don't carry their own */
-    bankAccountId?: string;
-    lines: BankStatementLine[];
-}
-export interface ImportBankTransactionsResult {
-    imported: number;
-    /** Lines skipped because they were already imported (idempotency) */
-    duplicates: number;
-}
-export interface UnreconciledQuery {
-    bankAccountId?: string;
-    dateRange?: DateRange;
-}
-/** Se a linha do extrato ja foi casada com um lancamento do sistema. */
-export type StatementLineStatus = 'reconciled' | 'pending';
-/**
- * A busca da Conciliacao, com os mesmos recortes do V1: conta, periodo, tipo,
- * status e texto livre — mais a pagina, porque um mes de extrato nao cabe numa
- * tela e o V1 pagina de 50 em 50.
- */
-export interface StatementLinesQuery {
-    bankAccountId?: string;
-    dateRange?: DateRange;
-    /** Entrada (credit) ou Saida (debit); ausente = ambos. */
-    direction?: TransactionDirection;
-    status?: StatementLineStatus;
-    /** Casa com a descricao e com o identificador do provedor. */
-    search?: string;
-    /** 1-based, como a paginacao que a tela mostra. */
-    page?: number;
-    pageSize?: number;
-}
-export interface StatementLinesResult {
-    rows: ImportedStatementLine[];
-    /** Total de linhas que o filtro encontrou, nao o da pagina. */
-    total: number;
-    page: number;
-    pageSize: number;
-    /**
-     * Somas **da pagina**, e o rotulo na tela diz isso com todas as letras.
-     * Foi a unica coisa da tela do V1 que evita uma leitura errada: quem troca de
-     * pagina troca os tres numeros, e quem nao sabe disso fecha o mes errado.
-     */
-    pageCredits: number;
-    pageDebits: number;
-    pageBalance: number;
-}
-/** A candidate internal movement to reconcile an imported bank line against. */
-export interface ReconciliationCandidate {
-    movement: FinancialMovement;
-    invoice?: Invoice;
-    /** 0..1 confidence from amount + date proximity */
-    score: number;
-    /** Installments in the bill, for the «1/3» column. */
-    installmentCount?: number;
-}
-/** Free search over the bills a statement line can settle — V1's "Vincular manualmente". */
-export interface ReconciliationTargetQuery {
-    /** YYYY-MM-DD, on the due date */
-    dueFrom?: string;
-    dueTo?: string;
-    /** `all` = open + paid-but-not-yet-reconciled */
-    status?: 'all' | 'open' | 'paid';
-    /** Counterparty, number or description */
-    search?: string;
-    amountMin?: number;
-    amountMax?: number;
-    page?: number;
-    pageSize?: number;
-}
-export interface ReconciliationTargetResult {
-    data: ReconciliationCandidate[];
-    hasMore: boolean;
-}
-/**
- * «Marcar como transferencia»: a linha do extrato nao e receita nem despesa —
- * e dinheiro andando entre duas contas da casa.
- *
- * A conta do extrato e sempre uma das pontas; a outra vem do usuario. A
- * convencao de direcao e a do V1, e ela importa: uma SAIDA no extrato (debit)
- * significa que o dinheiro deixou a conta do extrato, entao ela e a origem.
- * Inverter isso faz o saldo consolidado andar duas vezes no sentido errado.
- */
-export interface ReconcileAsTransferInput {
-    /** A linha importada (externalSource preenchido). */
-    bankMovementId: string;
-    /** A outra ponta — conta de destino numa saida, de origem numa entrada. */
-    counterAccountId: string;
-    notes?: string;
-}
-/**
- * «Lancar como conta»: a linha do extrato nao casa com nada porque o
- * lancamento nunca existiu. Entao ele nasce AQUI, classificado, e a linha
- * passa a ser a prova dele.
- *
- * Substitui o «aceitar como avulsa» — que, depois que a evidencia saiu do
- * razao (migration 112), marcava a linha sem lancar nada: o dinheiro no banco
- * e fora do livro, e o extrato deixando de bater em silencio.
- */
-export interface ReconcileAsBillInput {
-    /** A linha importada. */
-    bankMovementId: string;
-    /**
-     * Saida vira conta a pagar, entrada vira conta a receber. A direcao da linha
-     * e o padrao — mas o operador corrige, porque um estorno chega como credito
-     * numa conta que e despesa.
-     */
-    direction?: TransactionDirection;
-    /** O cadastro da contraparte, quando ela ja existe no sistema. */
-    contactId?: string;
-    /** De quem e o dinheiro — fornecedor numa saida, pagador numa entrada. */
-    contactName?: string;
-    /** O que aparece na conta; cai para a descricao do provedor. */
-    description?: string;
-    /** Plano de contas. E o que faz a conta aparecer classificada na DRE. */
-    accountId?: string;
-    costCenterId?: string;
-    /** Vencimento da conta; cai para a data da linha do extrato. */
-    dueDate?: string;
-    /**
-     * Os itens do comprovante. Vazio = uma linha so, com a descricao e o valor
-     * do extrato. Quando ha itens, a soma deles TEM de fechar com a linha: o
-     * extrato e a fonte da verdade do valor, nao o papel.
-     */
-    items?: ReconcileBillItemInput[];
-    /**
-     * Como a conta foi paga. Ausente = quita contra a conta do extrato sem dizer
-     * a forma, que e o que o import fazia sozinho; presente = o mesmo formulario
-     * de pagamento da fatura, com forma, conta e cartao.
-     */
-    payment?: ReconcilePaymentInput;
-    /** A foto do comprovante, quando houve uma. Viaja com o pagamento. */
-    receiptUrl?: string;
-}
-/** Uma linha do comprovante que virou item da conta. */
-export interface ReconcileBillItemInput {
-    description: string;
-    quantity: number;
-    unitPrice: number;
-    /** Plano de contas do item; cai para o da conta inteira. */
-    accountId?: string;
-    costCenterId?: string;
-}
-/**
- * Como o dinheiro andou, na forma que o formulario de pagamento da fatura ja
- * fala. E o MESMO componente nas duas telas: uma segunda escolha de forma de
- * pagamento seria um segundo vocabulario de dinheiro nascendo.
- */
-export interface ReconcilePaymentInput {
-    paymentMethodId?: string;
-    paymentMethodTypeId?: string;
-    bankAccountId?: string;
-    cashSessionId?: string;
-    cardBrand?: string;
-    cardInstallments?: number;
-    /** Cai para a data da linha do extrato. */
-    paymentDate?: string;
-    notes?: string;
-}
-/**
- * Juros, multa ou desconto que EXPLICAM a diferenca entre a linha do extrato e
- * a conta que ela quita.
- *
- * O `financial_receive_payment` recusa pagar mais que o saldo em aberto
- * (23514), e isso esta certo: uma parcela de 100 nunca foi de 112. Entao o
- * ajuste nao vai dentro do pagamento — ele nasce como um lancamento PROPRIO,
- * classificado, quitado na mesma data e contra a mesma conta. O balancete
- * continua fechando e o extrato continua batendo.
- */
-export interface ReconcileAdjustment {
-    type: 'interest' | 'fine' | 'discount';
-    /** Sempre positivo — o `type` diz o sinal. */
-    amount: number;
-    description?: string;
-    /** Plano de contas do ajuste. Sem ele o juros nasce sem classificacao. */
-    accountId?: string;
-}
-export interface ReconcileInput {
-    /** The imported bank-line movement (externalSource set) */
-    bankMovementId: string;
-    /** Internal movement to link; omit to accept the line standalone */
-    matchedMovementId?: string;
-    /**
-     * `settle` — a conta alvo esta EM ABERTO e conciliar a quita com o valor da
-     * linha. `link_only` — ela ja foi paga na mao no sistema, e conciliar so
-     * amarra a linha: criar um segundo pagamento dobraria o dinheiro.
-     *
-     * Ausente = `link_only`, que e o comportamento que esta tela sempre teve.
-     */
-    mode?: 'settle' | 'link_only';
-    /** Como quitar, quando `mode: 'settle'`. */
-    payment?: ReconcilePaymentInput;
-    /** A diferenca entre o extrato e a conta, explicada. Ver ReconcileAdjustment. */
-    adjustments?: ReconcileAdjustment[];
-}
-/**
- * O que a IA leu de um comprovante fotografado.
- *
- * O valor, a data e a conta bancaria do EXTRATO ficam travados como fonte da
- * verdade — o papel pode estar torto, amassado ou ser de outro dia. O que o
- * comprovante acrescenta e o que o extrato nao sabe: de quem e, o que foi
- * comprado, e em que prateleira isso mora.
- */
-export interface ReceiptReading {
-    contactName?: string;
-    /** Sugestao de plano de contas, pelo codigo ou pelo nome. */
-    accountHint?: string;
-    items?: ReconcileBillItemInput[];
-    /** O documento no papel (numero da nota, do cupom). */
-    document?: string;
-    /** O que a leitura teve de chutar ou nao conseguiu ler. */
-    warnings?: string[];
-}
-/** 55 = NF-e (mercadoria), 65 = NFC-e (consumidor), nfse = serviço (prefeitura). */
-export type NotaFiscalModel = 'nfe' | 'nfce' | 'nfse';
-export type NotaFiscalStatus = 'draft' | 'processing' | 'issued' | 'cancelled' | 'error';
-export interface NotaFiscal {
-    id: string;
-    tenantId: string;
-    model: NotaFiscalModel;
-    status: NotaFiscalStatus;
-    /** Número da nota — null while draft (assigned on issue). */
-    number: string | null;
-    series: string | null;
-    /** Order this nota documents (plg_shop_orders / orders id), if any. */
-    orderId?: string;
-    contactId?: string;
-    contactName?: string;
-    totalAmount: number;
-    issuedAt?: string;
-    /** Chave de acesso (44 dígitos), when authorized. */
-    accessKey?: string;
-    /** Links to the authorized XML and the DANFE/DANFCE PDF. */
-    xmlUrl?: string;
-    danfeUrl?: string;
-    /** External emissor id (focusnfe | nfeio | plugnotas | manual). */
-    emissor?: string;
-    errorMessage?: string;
-    observations?: string;
-    metadata?: Record<string, unknown>;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface CreateNotaFiscalInput {
-    model?: NotaFiscalModel;
-    orderId?: string;
-    contactId?: string;
-    contactName?: string;
-    totalAmount: number;
-    series?: string;
-    observations?: string;
-}
-export interface NotaFiscalQuery {
-    status?: NotaFiscalStatus | NotaFiscalStatus[];
-    model?: NotaFiscalModel;
-    orderId?: string;
-    search?: string;
-    page?: number;
-    pageSize?: number;
-}
-/** Uma comissão apurada, com a venda que a originou (009). */
-export interface CommissionEntry {
-    id: string;
-    personId: string;
-    personName?: string | null;
-    itemId: string;
-    itemName?: string | null;
-    orderId?: string | null;
-    invoiceId?: string | null;
-    invoiceNumber?: string | null;
-    competenceDate?: string | null;
-    ruleName?: string | null;
-    functionName?: string | null;
-    baseAmount: number;
-    rate: number;
-    amount: number;
-    share: number;
-    role?: string | null;
-    status: 'pending' | 'approved' | 'paid' | 'cancelled';
-}
-/** Os nove do V1. Os que o motor ainda não honra estão em UNENFORCED_CRITERIA. */
-export type CommissionCriteriaType = 'service' | 'category' | 'professional' | 'professional_group' | 'profession' | 'unit' | 'payment_method_type' | 'weekday' | 'time_range';
-/**
- * Quatro dos nove não restringem a apuração (009 + 021):
- * `profession` e `professional_group` não têm cadastro no V2 para onde apontar,
- * e `payment_method_type` só se conhece quando o pagamento acontece — depois de
- * a linha nascer, que é quando a regra é resolvida.
- *
- * A tela DIZ isso em vez de oferecer um controle que não faz nada: um critério
- * que parece configurado e é ignorado custa um mês de comissão errada.
- */
-export declare const UNENFORCED_CRITERIA: CommissionCriteriaType[];
-export interface CommissionRuleCriteria {
-    id?: string;
-    criteriaType: CommissionCriteriaType;
-    /** `{ids:[…]}` para listas, `{days:[0..6]}` para dias, `{ranges:[{from,to}]}` para horários. */
-    criteriaValue: Record<string, unknown>;
-}
-/** Uma faixa de produção. `to` vazio = sem limite; paga `fixed` OU `percent`. */
-export interface CommissionTier {
-    from: number;
-    to?: number | null;
-    fixed?: number | null;
-    percent?: number | null;
-}
-export interface CommissionFunction {
-    id?: string;
-    ruleId?: string;
-    functionName: string;
-    accountType: 'professional_executor' | 'professional' | 'supplier' | 'select_on_launch';
-    personId?: string | null;
-    valueType: 'percentage' | 'fixed';
-    valueAmount: number;
-    calculationBase: 'total' | 'net';
-    tierMode: 'none' | 'marginal' | 'retroactive' | 'guaranteed_min';
-    minGuaranteed?: number | null;
-    tiers: CommissionTier[];
-    isVariable: boolean;
-    displayOrder: number;
-    isActive: boolean;
-}
-export interface CommissionRule {
-    id: string;
-    name: string;
-    description?: string | null;
-    priority: number;
-    isDefault: boolean;
-    isActive: boolean;
-    unitId?: string | null;
-    /** Herdados da 003; hoje só semeiam a função padrão quando a regra não tem nenhuma (020). */
-    valueType: 'percentage' | 'fixed';
-    value: number;
-    criteria: CommissionRuleCriteria[];
-    functions: CommissionFunction[];
-}
-export interface CommissionRuleInput {
-    id?: string;
-    name: string;
-    description?: string | null;
-    priority: number;
-    isDefault?: boolean;
-    isActive?: boolean;
-    unitId?: string | null;
-    criteria?: CommissionRuleCriteria[];
-}
-/** Os cadastros para onde os critérios apontam, numa carga só. */
-export interface CommissionCatalogs {
-    services: {
-        id: string;
-        name: string;
-        categoryId?: string | null;
-    }[];
-    categories: {
-        id: string;
-        name: string;
-    }[];
-    professionals: {
-        id: string;
-        name: string;
-    }[];
-    units: {
-        id: string;
-        name: string;
-    }[];
-}
-/** Um mês do ano da unidade: os três degraus e o realizado do livro. */
-export interface GoalMonth {
-    goalId?: string | null;
-    unitId: string;
-    year: number;
-    month: number;
-    targetAmount: number;
-    superAmount: number;
-    hyperAmount: number;
-    achievedAmount: number;
-    targetPercent: number;
-    superPercent: number;
-    hyperPercent: number;
-    notes?: string | null;
-}
-export interface SaveGoalInput {
-    id?: string;
-    unitId: string;
-    year: number;
-    month: number;
-    targetAmount: number;
-    superAmount: number;
-    hyperAmount: number;
-    notes?: string | null;
-}
-/** O estado que a casa fala, não o enum da loja. */
-export type GiftCardState = 'issued' | 'active' | 'redeemed' | 'expired' | 'revoked';
-/** Um vale-presente como o Financeiro o lê: valor de face e saldo SEPARADOS. */
-export interface GiftCard {
-    id: string;
-    /** Dezesseis dígitos, como cartão. Um título ao portador. */
-    code: string;
-    /** O de face, gravado na emissão. Nunca muda. */
-    faceValue: number;
-    /** O que resta. `null` = nunca ativado — que não é a mesma coisa que zero. */
-    balance: number | null;
-    state: GiftCardState;
-    currency: string;
-    issuedAt: string;
-    expiresAt: string | null;
-    activatedAt: string | null;
-    note: string | null;
-    customerEmail: string | null;
-}
-export interface IssueGiftCardsInput {
-    quantity: number;
-    /** O mesmo para todos: um lote é uniforme. */
-    unitAmount: number;
-    /** Vazio = não expira. */
-    expiresAt?: string | null;
-    note?: string | null;
-}
-export interface GiftCardQuery {
-    search?: string;
-    state?: GiftCardState;
-    minValue?: number;
-    maxValue?: number;
-    issuedFrom?: string;
-    issuedTo?: string;
-}
-/** Um fechamento de caixa na fila de conferência. */
-export interface CashSessionReview {
-    sessionId: string;
-    unitId?: string | null;
-    openedAt?: string | null;
-    closedAt?: string | null;
-    openedByName?: string | null;
-    closedByName?: string | null;
-    closedByUserId?: string | null;
-    openingBalance: number;
-    closingBalance: number;
-    difference: number;
-    reviewStatus: 'pending' | 'approved' | 'rejected';
-    reviewedAt?: string | null;
-    reviewerName?: string | null;
-    reviewNotes?: string | null;
-}
-export interface CommissionQuery {
-    periodStart?: string;
-    periodEnd?: string;
-    personId?: string;
-    status?: string;
-}
-export interface GenerateCommissionsInput {
-    periodStart: string;
-    periodEnd: string;
-    unitId?: string;
-}
-/** O lote apurado: é por ele que se aprova e se levanta o borderô. */
-export interface CommissionGeneration {
-    id: string;
-    periodStart: string;
-    periodEnd: string;
-    status: 'draft' | 'approved' | 'paid' | 'cancelled';
-    total: number;
-    entries: number;
-}
-export interface CommissionApproveResult {
-    generationId: string;
-    approved: number;
-}
-export interface CommissionPayRunResult {
-    generationId: string;
-    payables: number;
-    total: number;
-    dueDate: string;
-}
-export interface CommissionGenerationResult {
-    generationId: string;
-    entries: number;
-    total: number;
-}
-/** A competência mensal e seu estado (006). */
-export interface FinancialPeriod {
-    id: string;
-    competenceMonth: string;
-    status: 'open' | 'closed';
-    closedAt?: string | null;
-    reopenReason?: string | null;
-}
-/** Uma conta do balancete: débito, crédito e saldo (006). */
-export interface TrialBalanceRow {
-    accountId: string;
-    accountCode?: string | null;
-    accountName?: string | null;
-    competenceMonth: string;
-    totalDebit: number;
-    totalCredit: number;
-    balance: number;
-}
-/** Saldo em aberto por faixa de atraso (016). */
-export interface AgingRow {
-    installmentId: string;
-    invoiceNumber?: string | null;
-    counterpartyName?: string | null;
-    dueDate: string;
-    balance: number;
-    daysOverdue: number;
-    bucket: 'current' | 'd1_15' | 'd16_30' | 'd31_60' | 'd61_90' | 'd90_plus';
-}
-/** Receita − CMV − comissão, por mês (015). */
-export interface MarginRow {
-    competenceMonth: string;
-    revenue: number;
-    cogs: number;
-    commission: number;
-    margin: number;
-    marginPercent: number;
-}
-export type RecurringBillDirection = 'payable' | 'receivable';
-export type RecurringBillFrequency = 'weekly' | 'monthly' | 'quarterly' | 'yearly';
-/** A rule that creates one financial title per competence when explicitly run. */
-export interface RecurringBill {
-    id: string;
-    direction: RecurringBillDirection;
-    description: string;
-    counterpartyPersonId?: string | null;
-    counterpartyName?: string | null;
-    amount: number;
-    items: CreateInvoiceItemInput[];
-    unitId?: string | null;
-    chartAccountId?: string | null;
-    costCenterId?: string | null;
-    frequency: RecurringBillFrequency;
-    dueDay: number;
-    startsOn: string;
-    endsOn?: string | null;
-    isActive: boolean;
-    notes?: string | null;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface SaveRecurringBillInput {
-    id?: string;
-    direction: RecurringBillDirection;
-    description: string;
-    counterpartyPersonId: string;
-    amount: number;
-    items: CreateInvoiceItemInput[];
-    unitId?: string | null;
-    chartAccountId?: string | null;
-    costCenterId?: string | null;
-    frequency: RecurringBillFrequency;
-    dueDay: number;
-    startsOn: string;
-    endsOn?: string | null;
-    isActive?: boolean;
-    notes?: string | null;
-}
-/**
- * A posição financeira de um CLIENTE, que é a pergunta que a recepção faz com a
- * pessoa na frente dela — e não a de um atendimento isolado.
- *
- * `paidToExecute` (o "pago a executar" do V1) é o valor já recebido de serviço
- * ainda não prestado: num salão isso é PASSIVO, não receita. Fica opcional
- * porque o V2 ainda não tem o eixo de EXECUÇÃO — modela pagamento e não modela
- * entrega —, e um zero fixo ali mentiria sobre uma dívida.
- */
-export interface ClientAccount {
-    personId: string;
-    contracted: number;
-    paid: number;
-    open: number;
-    paidToExecute?: number;
-    /**
-     * Contratado, ainda não executado e ainda não pago. Irmão do `paidToExecute`:
-     * um é dívida da casa (recebeu e deve prestar), o outro é dívida do cliente
-     * (vai receber quando prestar). Somar os dois num só número apagaria de que
-     * lado está o risco.
-     */
-    openToExecute?: number;
-    credits?: number;
-    invoices: ClientAccountInvoice[];
-}
-export interface ClientAccountInvoice {
-    id: string;
-    number: string | null;
-    orderId: string | null;
-    competenceDate: string | null;
-    total: number;
-    paid: number;
-    balance: number;
-    status: string;
-    description: string | null;
-}
-/**
- * Uma parcela de cartão a receber, com o que a adquirente vai reter.
- *
- * O V1 nunca construiu esta tela — "Cartões de Recebimento: funcionalidade em
- * desenvolvimento". Mas o dado existe desde o primeiro pagamento em cartão, e é
- * a resposta para a pergunta que um salão faz toda semana: quanto entra, quando,
- * e quanto a máquina fica.
- */
-export interface CardReceivable {
-    movementId: string;
-    accountName: string | null;
-    cardBrand: string | null;
-    cardInstallments: number;
-    installmentK: number;
-    paymentDate: string;
-    gross: number;
-    feeRate: number | null;
-    fee: number;
-    net: number;
-    settlementDate: string;
-    /** Sem taxa cadastrada a projeção é o BRUTO, e isso precisa aparecer. */
-    missingFeeConfig: boolean;
-}
-/**
- * Um recibo preso a uma conta.
- *
- * `pending` diz que a LINHA atravessou do V1 e os BYTES ainda não — o arquivo
- * existe, está no storage do V1, e o link daqui ainda não abre. É melhor
- * mostrar o nome com a ressalva do que esconder: quem precisa do comprovante
- * fica sabendo que ele existe e onde procurar.
- */
-export interface InvoiceAttachment {
-    id: string;
-    fileName: string;
-    fileSize?: number;
-    mimeType?: string;
-    url?: string;
-    pending: boolean;
-    createdAt?: string;
-}
-/** What a payee needs before the bank accepts a line paying them. */
-export interface CnabPayeeRecord {
-    /** `people.id` — where the document and the account are saved back. */
-    contactId: string;
-    name: string;
-    /** `people.document_number`. */
-    document: string;
-    /** The default row of `public.payee_accounts`, when there is one. */
-    payeeAccountId?: string;
-    bankCode?: string;
-    bankName?: string;
-    agencyNumber?: string;
-    agencyDigit?: string;
-    accountNumber?: string;
-    accountDigit?: string;
-    accountType?: string;
-    pixKey?: string;
-    pixKeyType?: string;
-    street?: string;
-    number?: string;
-    complement?: string;
-    district?: string;
-    city?: string;
-    state?: string;
-    postalCode?: string;
-}
-/** Everything the remittance wizard needs that is not already on screen. */
-export interface CnabContext {
-    /**
-     * A empresa que paga — `public.company_legal_entities`, da unidade da conta.
-     *
-     * Vem SEMPRE, mesmo sem cadastro: `id` nulo diz que a linha ainda não existe
-     * e `name` cai no nome da unidade, para a tela abrir com algo escrito em vez
-     * de dois campos vazios. O CNPJ digitado então CRIA a linha (`saveCompany`),
-     * e a próxima remessa já o encontra.
-     */
-    company: {
-        id?: string;
-        unitId?: string;
-        name: string;
-        document: string;
-    };
-    /** NSA of the next file for this account. Repeating one is a rejected remittance. */
-    nextSequence: number;
-    payees: CnabPayeeRecord[];
-}
-/** A empresa pagadora, cadastrada de dentro da remessa por falta de outra porta. */
-export interface SaveCompanyInput {
-    id?: string;
-    unitId?: string;
-    name: string;
-    document: string;
-}
-/** The payee data the wizard collected, saved back so the next file reuses it. */
-export interface SaveCnabPayeeInput {
-    contactId: string;
-    payeeAccountId?: string;
-    document?: string;
-    bankCode?: string;
-    bankName?: string;
-    agencyNumber?: string;
-    agencyDigit?: string;
-    accountNumber?: string;
-    accountDigit?: string;
-    accountType?: string;
-    pixKey?: string;
-    pixKeyType?: string;
-}
-export interface RecordCnabBatchInput {
-    bankAccountId: string;
-    unitId?: string;
-    layout: string;
-    sequenceNumber: number;
-    totalAmount: number;
-    fileName: string;
-    fileContent: string;
-    items: Array<{
-        /** The installment this line paid. */
-        movementId: string;
-        paymentForm: string;
-        paymentDate: string;
-        amount: number;
-    }>;
-}
-/** Uma instituição do catálogo do Bacen — `public.banks` (migration 167). */
-export interface BankCatalogEntry {
-    /** COMPE de 3 dígitos: o que vai no boleto e no CNAB. Nulo em quem só é PIX. */
-    compe?: string;
-    ispb: string;
-    name: string;
-    legalName?: string;
-    brandColor?: string;
-    logoUrl?: string;
-}
-//# sourceMappingURL=types.d.ts.map