BooksApi class

Constructors

BooksApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getBooksAccounts({String? sandbox}) → Future<List<Account>?>
Returns the org's chart of accounts — the seeded fixed chart every posting key in the ledger refers to.
getBooksAccountsWithHttpInfo({String? sandbox}) → Future<Response>
Returns the org's chart of accounts — the seeded fixed chart every posting key in the ledger refers to.
getBooksBankTransactions({String? sandbox, int? limit}) → Future<List<BankTxnRow>?>
Returns the org's normalized bank transactions, newest first — every row the import and connector paths have ingested, with its amount in exact cents, its direction, and whether it has been matched to a voucher yet.
getBooksBankTransactionsWithHttpInfo({String? sandbox, int? limit}) → Future<Response>
Returns the org's normalized bank transactions, newest first — every row the import and connector paths have ingested, with its amount in exact cents, its direction, and whether it has been matched to a voucher yet.
getBooksBankUnreconciled({String? sandbox}) → Future<UnreconciledOut?>
Returns the org's unmatched bank inflows and their open clarifying questions — the queue a human answers so an unexplained deposit is never guessed into revenue.
getBooksBankUnreconciledWithHttpInfo({String? sandbox}) → Future<Response>
Returns the org's unmatched bank inflows and their open clarifying questions — the queue a human answers so an unexplained deposit is never guessed into revenue.
getBooksExport({String? sandbox, String? from, String? to, String? format, int? limit}) → Future<FinancialPackage?>
Returns the complete financial package for the caller's org over (from, to]: the trial balance, the P&L, the balance sheet, and the GL detail behind them — the four statements a tax preparer or an investor asks for, assembled from the one ledger in a single read so they cannot disagree with each other.
getBooksExportWithHttpInfo({String? sandbox, String? from, String? to, String? format, int? limit}) → Future<Response>
Returns the complete financial package for the caller's org over (from, to]: the trial balance, the P&L, the balance sheet, and the GL detail behind them — the four statements a tax preparer or an investor asks for, assembled from the one ledger in a single read so they cannot disagree with each other.
getBooksGl({String? sandbox, int? limit}) → Future<List<GLRow>?>
ListGL returns the org's most recent GL Entry rows, newest first.
getBooksGlWithHttpInfo({String? sandbox, int? limit}) → Future<Response>
ListGL returns the org's most recent GL Entry rows, newest first.
getBooksInbox({String? sandbox}) → Future<InboxOut?>
Returns the org's open document queue — everything uploaded but not yet booked, newest first, each with its extracted summary and the confidence the scanner resolved its category at.
getBooksInboxWithHttpInfo({String? sandbox}) → Future<Response>
Returns the org's open document queue — everything uploaded but not yet booked, newest first, each with its extracted summary and the confidence the scanner resolved its category at.
getBooksMetrics({String? sandbox, String? from, String? to}) → Future<MetricsResponse?>
Metrics returns the org's deterministic SaaS-metrics snapshot over an optional (from, to] window — MRR, ARR, revenue, COGS, burn, gross margin, net income, cash, deferred revenue, monthly burn and runway — as raw int64-cent figures AND the same figures already formatted.
getBooksMetricsWithHttpInfo({String? sandbox, String? from, String? to}) → Future<Response>
Metrics returns the org's deterministic SaaS-metrics snapshot over an optional (from, to] window — MRR, ARR, revenue, COGS, burn, gross margin, net income, cash, deferred revenue, monthly burn and runway — as raw int64-cent figures AND the same figures already formatted.
getBooksPnl({String? sandbox, String? from, String? to}) → Future<PnL?>
Returns the org's accrual-basis Profit & Loss over an optional (from, to] window of RFC3339 posting times: recognized revenue, matched cost, and the net.
getBooksPnlWithHttpInfo({String? sandbox, String? from, String? to}) → Future<Response>
Returns the org's accrual-basis Profit & Loss over an optional (from, to] window of RFC3339 posting times: recognized revenue, matched cost, and the net.
getBooksPosition({String? sandbox, String? to}) → Future<BalanceSheet?>
Returns the org's Balance Sheet as of to (empty = all time), with the Assets == Liabilities + Equity equation proof.
getBooksPositionWithHttpInfo({String? sandbox, String? to}) → Future<Response>
Returns the org's Balance Sheet as of to (empty = all time), with the Assets == Liabilities + Equity equation proof.
getBooksQuestions({String? sandbox}) → Future<QuestionsResponse?>
Returns the clarifying questions the caller's own recent GL raises — the unusual postings a founder should look at (outliers, reversals, round-offs, uncosted revenue, an overdrawn wallet), sharpest first.
getBooksQuestionsWithHttpInfo({String? sandbox}) → Future<Response>
Returns the clarifying questions the caller's own recent GL raises — the unusual postings a founder should look at (outliers, reversals, round-offs, uncosted revenue, an overdrawn wallet), sharpest first.
getBooksRules({String? sandbox}) → Future<RulesOut?>
Returns the org's auto-categorization rules, highest priority first.
getBooksRulesWithHttpInfo({String? sandbox}) → Future<Response>
Returns the org's auto-categorization rules, highest priority first.
getBooksTransactions({String? sandbox, String? from, String? to, String? category, String? vendor, int? limit}) → Future<TransactionsOut?>
Returns the org's booked ledger as a single-line register, newest first: one row per voucher, with its date, description, vendor, category, source and amount in exact cents.
getBooksTransactionsWithHttpInfo({String? sandbox, String? from, String? to, String? category, String? vendor, int? limit}) → Future<Response>
Returns the org's booked ledger as a single-line register, newest first: one row per voucher, with its date, description, vendor, category, source and amount in exact cents.
getBooksTrial({String? sandbox, String? from, String? to}) → Future<TrialBalance?>
Returns the org's trial balance over an optional from, to window of RFC3339 posting times, including the opening/closing columns and the TotalDebit == TotalCredit proof that the books balance.
getBooksTrialWithHttpInfo({String? sandbox, String? from, String? to}) → Future<Response>
Returns the org's trial balance over an optional from, to window of RFC3339 posting times, including the opening/closing columns and the TotalDebit == TotalCredit proof that the books balance.
getBooksVendors({String? sandbox}) → Future<VendorsOut?>
Returns the org's vendor book: each canonical vendor, the alias spellings a receipt may print it under, and the expense account new bills from it default to.
getBooksVendorsWithHttpInfo({String? sandbox}) → Future<Response>
Returns the org's vendor book: each canonical vendor, the alias spellings a receipt may print it under, and the expense account new bills from it default to.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
postBooksAsk(AskRequest askRequest) → Future<AskResponse?>
Answers a plain-language question about the caller's own books — "what is my MRR?", "how long is my runway?" — with figures taken from their ledger, never a guessed number.
postBooksAskWithHttpInfo(AskRequest askRequest) → Future<Response>
Answers a plain-language question about the caller's own books — "what is my MRR?", "how long is my runway?" — with figures taken from their ledger, never a guessed number.
postBooksBankExchange() → Future<void>
Finish connecting a bank account (not yet available)
postBooksBankExchangeWithHttpInfo() → Future<Response>
Finish connecting a bank account (not yet available)
postBooksBankImport({MultipartFile? body}) → Future<BankTally?>
Import a bank statement file into your books
postBooksBankImportWithHttpInfo({MultipartFile? body}) → Future<Response>
Import a bank statement file into your books
postBooksBankSync() → Future<BankTally?>
Pulls every connected bank (Plaid/Teller) for the caller's org, maps each fetched transaction to a posting and books it idempotently, then advances that connector's cursor so the next sync resumes where this one stopped.
postBooksBankSyncWithHttpInfo() → Future<Response>
Pulls every connected bank (Plaid/Teller) for the caller's org, maps each fetched transaction to a posting and books it idempotently, then advances that connector's cursor so the next sync resumes where this one stopped.
postBooksBankToken() → Future<void>
Begin connecting a bank account (not yet available)
postBooksBankTokenWithHttpInfo() → Future<Response>
Begin connecting a bank account (not yet available)
postBooksInbox({MultipartFile? body}) → Future<InboxItem?>
Queue a document for later scanning
postBooksInboxWithHttpInfo({MultipartFile? body}) → Future<Response>
Queue a document for later scanning
postBooksRules(Rule rule) → Future<Rule?>
Creates or updates one auto-categorization rule, keyed by its pattern — writing a pattern that already exists REPLACES that row's category and priority.
postBooksRulesWithHttpInfo(Rule rule) → Future<Response>
Creates or updates one auto-categorization rule, keyed by its pattern — writing a pattern that already exists REPLACES that row's category and priority.
postBooksScan({MultipartFile? body}) → Future<ScanDraft?>
Scan a receipt or invoice into a proposed voucher
postBooksScanBook(BookRequest bookRequest) → Future<BookResponse?>
Posts a reviewed scanned bill to the ledger.
postBooksScanBookWithHttpInfo(BookRequest bookRequest) → Future<Response>
Posts a reviewed scanned bill to the ledger.
postBooksScanWithHttpInfo({MultipartFile? body}) → Future<Response>
Scan a receipt or invoice into a proposed voucher
postBooksSync() → Future<SyncTally?>
Sync ingests the caller's OWN org from commerce into BOTH ledgers (live and sandbox) and reports how many new vouchers posted to each.
postBooksSyncWithHttpInfo() → Future<Response>
Sync ingests the caller's OWN org from commerce into BOTH ledgers (live and sandbox) and reports how many new vouchers posted to each.
postBooksVendors(VendorRow vendorRow) → Future<VendorRow?>
Creates or updates one vendor in the org's vendor book, keyed by its canonical name — writing a canonical name that already exists REPLACES that row's aliases and default category.
postBooksVendorsWithHttpInfo(VendorRow vendorRow) → Future<Response>
Creates or updates one vendor in the org's vendor book, keyed by its canonical name — writing a canonical name that already exists REPLACES that row's aliases and default category.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited