Features AI Integrations Pricing Docs

Sign In Get Started

Overview API Reference Guides

accounting-periods 18

GET List accounting periods
POST Create accounting period
POST Bulk close-and-lock accounting periods
POST Close accounting period
GET Get accounting period
GET List what's blocking close
GET List checklist acknowledgements
DELETE Remove a checklist acknowledgement
PUT Acknowledge a checklist step
POST AI close readiness check
GET Get unified close readiness score
POST Force-recompute close score
POST Lock accounting period
POST Reopen accounting period
GET Daily close-score trend
DELETE Revoke a reviewer sign-off
GET List multi-reviewer sign-offs
POST Record a reviewer sign-off

advisory-firm-reports 4

GET List available firm reports
GET Get portfolio overview
GET Get work queue
GET Generate firm report

advisory-firm-teams 15

GET List firm teams
POST Create team
DELETE Delete team
GET Get team details
PATCH Update team
POST Add business to team
DELETE Remove business from team
POST Add team member
DELETE Remove team member
GET List accessible businesses
GET List staff assignments
POST Create staff assignment
PUT Bulk set assignments
DELETE Delete assignment
PATCH Update assignment

advisory-firm-templates 7

GET List firm templates
POST Create a firm template
DELETE Delete a firm template
GET Get a firm template
PATCH Update a firm template
POST Deploy a firm template to selected client businesses
GET List deployment history for a template

advisory-firms 30

GET List advisory firms
POST Create advisory firm
DELETE Delete advisory firm
GET Get advisory firm
PUT Update advisory firm
POST AI cross-client insights
GET List firm businesses
POST Assign business to firm
DELETE Unassign business from firm
POST Invite a client user to a business
GET List firm clients
GET List client business access
POST Grant client business access
DELETE Revoke client business access
GET List pending invitations
DELETE Cancel an invitation
POST Resend an invitation
GET Get firm logo download URL
PUT Save firm Slack webhook
GET Get firm Slack status
POST Test Slack webhook
DELETE Disconnect Slack
PUT Update firm Slack notification preferences
POST Test Slack webhook
PUT Link Stripe customer
GET List firm users
POST Add user to firm
POST Invite a staff member to the firm
DELETE Remove user from firm
PUT Update user role in firm

ai-reporting 11

GET List generated decks
POST Generate a new AI deck
DELETE Delete a deck
GET Get a deck
POST Export a deck
POST Create a public share link for a deck
GET List share links for a deck
POST Reorder slides
PATCH Edit a slide
POST Toggle slide visibility
DELETE Revoke a share link

ai-reporting-public 1

GET Public deck viewer (unauthenticated)

anomalies 8

GET List transaction anomalies
POST Dismiss an anomaly
POST Bulk dismiss anomalies in a date range
POST Bulk dismiss all anomalies of a given type
POST Trigger an on-demand anomaly rescan
POST Restore a dismissed anomaly
GET Get anomaly finding detail
POST Execute a recommended action and dismiss the anomaly

ap-approval 10

GET Get AP approval workflow
GET Approval queue analytics
GET Get approvers by tier
PUT Update approvers for a tier
POST Batch approve pending items
GET List pending AP approvals
POST Provision AP approval workflow for firm
POST AI approval risk scores
PATCH Update approval thresholds
GET Vendor payment history

api-tokens 4

GET List tokens
POST Create token
DELETE Delete token
POST Revoke token

attention 6

GET List attention items
POST Restore dismissed live alerts
POST Mark all read + clear dismissals
GET Attention summary counts
GET Get single attention item
POST Mark item read or dismiss

billing 12

POST Toggle Addon
POST Preview Addon Change
GET Get Ai Usage
GET Get Ai Usage Details
GET Get Billing Catalog
POST Change Plan
POST Create Checkout Session
GET Get Grandfathered Summary
GET Get Invoice History
POST Migrate grandfathered account to a paid plan
POST Create Portal Session
GET Get Billing Status

bills 27

GET List bills
POST Create bill
GET AP aging summary
POST AI-extract draft bills from documents
POST Bulk create bills
GET List expense candidates
GET Get bill metrics
GET List bill payment suggestions
POST Bulk approve bill payment suggestions
POST Trigger bill payment matching
POST Accept a bill payment suggestion
POST Reject a bill payment suggestion
POST Split one transaction across multiple bills
POST Create bill in received status
POST AI payment priority suggestions
POST Upload bill document
DELETE Delete bill
GET Get bill
PUT Update bill
PATCH Approve bill
PATCH Attach file to existing bill
PATCH Cancel bill
POST Compare bill against vendor contract
GET List bill payments
POST Add payment to bill
DELETE Remove payment from bill
PATCH Mark bill as received

budgets 15

GET List budgets
POST Create budget
POST Generate forecast
GET List forecast configs
POST Create forecast config
DELETE Delete budget
GET Get budget
PATCH Update budget
POST Activate budget
POST Copy budget
GET List budget lines
POST Add budget line
DELETE Delete budget line
PATCH Update budget line
GET Budget vs Actual

businesses 44

GET List businesses
POST Create business
GET Get auto-numbering settings
PUT Update auto-numbering settings
GET Preview next auto-generated numbers
PUT Update entries start date
POST Generate a COA template using AI
GET Get invoice branding settings
PATCH Update invoice branding settings
POST Sync logo to Stripe branding
GET Check mailbox uniqueness
PUT Save Slack webhook URL
GET Get Slack integration status
POST Test Slack webhook
DELETE Disconnect Slack
PUT Update Slack notification preferences
POST Test Slack webhook
GET Get Teal instances
GET Get Teal source accounts
GET List business users
POST Add user to business
DELETE Remove user from business
PUT Update user role
GET Get user role
POST Validate a custom COA template
DELETE Delete business
GET Get business
PUT Update business
GET Get balance sheet (sectioned)
POST AI analysis of balance sheet
GET Get cash flow statement
GET Top categories and vendors by cash outflow
GET Get cash flow statements for multiple periods
POST AI analysis of cash flow statement
GET Get income statement (sectioned)
GET Get income statement (flat)
POST AI analysis of income statement
GET Get ledger statement for a date range
GET Get vendor/counterparty breakdown for a ledger account
GET Get vendor breakdown across all periods for a ledger
GET Get individual transactions for a vendor within a ledger
PATCH Recategorize line entries
PUT Update Stripe subscription
GET Get sync status

cfo-portal 54

GET Get CFO financial alerts
GET Get CFO AP aging
GET Get CFO AR aging
POST Ask the CFO portal AI assistant a question
GET Get CFO benchmarks
GET Get CFO board deck summary
POST Generate an AI board memo/report from CFO board-deck data
POST Export AI board memo as PDF or HTML
GET Download board deck summary as PDF
GET List all managerial buckets (default + custom)
POST Create a custom managerial bucket
DELETE Delete or disable a managerial bucket
PUT Update a managerial bucket
GET Get CFO budget vs actual
GET Get CFO 13-week cash forecast
POST Evaluate a what-if cash forecast scenario
GET List one-time payment items applied to the cash forecast
POST Create a one-time payment item
DELETE Delete a one-time payment item
PATCH Update a one-time payment item
DELETE Clear all cash forecast overrides in a scope
GET List cell-level overrides for the cash forecast
PUT Replace all cash forecast overrides in a scope
DELETE Delete a single cash forecast override row
PUT Update Cash Forecast configuration
GET List saved cash forecast versions
POST Save the current cash forecast configuration as a named version
DELETE Delete a saved cash forecast version
GET Get a saved cash forecast version
PATCH Rename or describe a saved version
POST Re-apply a saved version's config to the live forecast
GET Get CFO configuration
GET Get CFO debt schedule
POST Approve parsed debt contract and create debt instrument
POST Parse debt contract into a draft payment schedule
GET Get CFO flux analysis
GET Get CFO landed COGS
GET Get CFO managerial P&L
GET Get CFO monthly close status
GET List open POs and which forecast column they flow through
GET Get CFO purchase order pipeline
GET Get CFO recipe book
POST AI auto-assign ledgers to managerial buckets
PUT Upsert managerial builder line account selections
PUT Upsert managerial bucket assignments for GL accounts
GET Get CFO reports and documents
GET Get CFO shipping analysis
GET Get CFO Shopify metrics
GET Get CFO statement bundle
GET Get CFO portal summary
GET Get CFO unit economics
PUT Update Unit Economics configuration
GET Get CFO valuation inputs
GET Get CFO vendor spend

cfo-projection 10

GET Get trailing actuals
GET List scenarios
POST Create scenario
GET Get active scenario
POST Create scenario from budget
DELETE Delete scenario
GET Get scenario
PATCH Update scenario
GET Compute projection
POST Suggest tax rates

client-messages 10

GET List client conversations
POST Create a conversation
GET Get conversation detail
POST Reply to a conversation (client)
GET List client conversations (firm)
GET Get conversation detail (firm)
POST Reply to a conversation (advisor)
PUT Update conversation status
GET Unread conversation count (firm)
GET Unread conversation count

credit-memos 10

GET List credit memos
POST Create credit memo
GET Get customer available credits
POST AI credit memo suggestions
DELETE Delete credit memo
GET Get credit memo
PUT Update credit memo
POST Apply credit memo to invoice
POST Issue credit memo
POST Void credit memo

customers 16

GET List customers
POST Create customer
POST AI payment behavior analysis
POST Bulk AI auto-categorize uncategorized customers
POST Bulk upload customers from CSV
GET Download bulk customer upload CSV template
POST AI categorize customer
POST Check for duplicate customers
DELETE Delete customer
GET Get customer
PUT Update customer
GET List customer contacts
POST Create customer contact
DELETE Delete customer contact
GET Get customer contact
PUT Update customer contact

daily-brief 2

GET Books AI Daily Brief
GET Books AI proactive morning standup

delayed-charges 6

GET List delayed charges
POST Create delayed charge
GET Get customer pending charges
DELETE Delete delayed charge
GET Get delayed charge
PUT Update delayed charge

estimates 9

GET List estimates
POST Create estimate
DELETE Delete estimate
GET Get estimate
PUT Update estimate
POST Accept estimate
POST Convert estimate to invoice
POST Decline estimate
POST Send estimate

finch 9

GET Company info from payroll provider
GET Get Finch Connect URL
GET Employee directory
DELETE Disconnect payroll provider
GET Finch Connect callback
POST Get pay statements
GET List payroll payments
GET Finch connection status
POST Sync payroll data

fixed-assets 18

GET List fixed assets
POST Create fixed asset
GET List asset categories
POST Create asset category
POST Seed default categories
DELETE Delete asset category
GET Get asset category
PATCH Update asset category
GET Preview depreciation
POST Run depreciation
POST AI capitalization suggestions
DELETE Delete fixed asset
GET Get fixed asset
PATCH Update fixed asset
GET Get depreciation entries
GET Get depreciation schedule
POST Dispose asset
POST Place asset in service

hubspot 9

GET Get HubSpot OAuth connect URL
GET List HubSpot contacts
GET List HubSpot deals
DELETE Disconnect HubSpot
GET HubSpot OAuth callback
GET HubSpot connection status
POST Full HubSpot sync
POST Sync contacts to HubSpot
POST Sync invoices to HubSpot

hubspot-card 2

GET HubSpot app card data for a business
GET HubSpot card data by contact email

intents 1

POST Route user intent

inventory:accounts_payable 2

GET List Inventory AP bills
POST Recompute the three-way match for a bill

inventory:activity 1

GET List inventory activity

inventory:adjustments 1

POST Create manual inventory adjustment

inventory:cost_history 1

GET Landed COGS history

inventory:counts 7

GET List cycle counts
POST Start a cycle count
GET Get a cycle count
POST Cancel a cycle count
POST Add or scan a line
PUT Record a counted quantity
POST Post a cycle count

inventory:import 4

POST Analyze spreadsheet (async)
GET Poll analysis status
POST Apply import
POST Preview import

inventory:locations 10

GET List inventory locations
POST Create location
GET Get default location
DELETE Delete location
GET Get location
PUT Update location
POST Archive location
GET Get inventory at location
POST Set as default location
GET Get location inventory summary

inventory:lots 1

GET List expiring cost lots

inventory:payments 1

GET List inventory payments

inventory:po_import 4

POST Analyze manufacturer PO spreadsheet (async)
GET Poll PO analysis status
POST Create purchase order from import
POST Preview PO import with SKU matching

inventory:production 12

GET List recipes
POST Create recipe
DELETE Delete recipe
GET Get recipe
PUT Update recipe
POST Duplicate recipe
GET List production runs
POST Create production run
GET Get production run
PUT Update production run
POST What-if calculation
POST Complete production run

inventory:products 16

GET List products
POST Create product
GET Lookup variant by barcode or SKU
POST Apply unit cost bulk update
GET Export unit costs CSV
POST Preview unit cost bulk update
GET List product variants
POST Create product variant
DELETE Delete product variant
GET Get product variant
PUT Update product variant
PUT Set variant location opening quantities
DELETE Delete product
GET Get product
PUT Update product
POST Convert product to variant

inventory:reorder 2

POST Draft purchase orders from reorder suggestions
GET Suggest reorders from reorder points

inventory:reports 4

GET Adjustments grouped by reason
GET Inventory aging report
GET Margin-by-SKU report (landed cost + sales velocity)
GET Current inventory valuation

inventory:shipments 5

GET List shipments
POST Create shipment
DELETE Delete shipment
GET Get shipment
PUT Update shipment

inventory:supply_chain 1

GET Get inventory supply chain map

inventory:transfer_suggestions 1

GET Suggest site-to-site transfers

inventory:transfers 13

GET List inventory transfers
POST Create transfer
GET List in-transit transfers
GET List pending transfers
GET Get transfer summary
DELETE Delete transfer
GET Get transfer
PUT Update transfer
POST Cancel transfer
POST Add item to transfer
DELETE Remove item from transfer
POST Receive transfer
POST Ship transfer

invitations 2

POST Accept a pending invitation
GET Preview invitation details (public)

invoices 31

GET List invoices
POST Create invoice
GET AR aging summary
POST AI-extract draft invoices from documents
POST Batch create invoices
GET List all invoices (bulk)
POST Bulk create invoices
GET Weekly cash receipts reconciliation
POST Dismiss a transaction from cash receipts
POST Restore a dismissed cash receipt
GET Cash receipts week detail
GET List deposit candidates
POST Trigger payment matching
GET Get invoice metrics
GET List payment suggestions
POST Accept payment suggestion
POST Reject payment suggestion
DELETE Delete invoice
GET Get invoice
PUT Update invoice
PUT Mark Invoice Delivered
PUT Finalize invoice
PUT Mark Invoice Paid
GET List invoice payments
POST Add payment to invoice
DELETE Remove payment from invoice
PATCH Update payment on invoice
GET Get fresh invoice PDF URL
POST Send invoice via email
GET List suggestions for invoice
PUT Void invoice

journal-entries 9

GET List journal entries
POST Create journal entry
POST Post bulk journal entries
POST Preview bulk journal entry upload
GET Download bulk JE upload template
DELETE Delete journal entry
GET Get journal entry
PUT Update journal entry
PATCH Attach file to journal entry

ledgers 10

GET List ledgers
POST Create ledger
POST Apply AI-generated COA
POST Bulk update ledgers
POST Merge ledgers
POST Suggest cash flow classifications
POST AI account cleanup suggestions
DELETE Delete ledger
GET Get ledger
PUT Update ledger

month-end-packages 4

GET List month-end packages
POST Queue a month-end package build
GET Get month-end package
GET Get download URL

notes 15

GET List notes for a business
POST Create a note
POST Bulk-create notes (localStorage migration)
DELETE Cancel a reminder
DELETE Delete a note
GET Get a single note
PATCH Update a note
POST Register note attachment
POST Get upload URL for note attachment
DELETE Delete note attachment
GET Get download URL for note attachment
POST Notify business users about a note
GET List reminders for a note
POST Schedule a reminder for a note
POST AI rewrite of note body

notification-preferences 4

GET Get Notification Preferences
PUT Update Notification Preferences
GET Get Topic Overrides Endpoint
PUT Update Topic Overrides Endpoint

notifications 11

GET List notifications
POST Bulk dismiss
POST Bulk mark seen
GET Open notification count
GET Per-topic notification counts
GET Get a single notification
POST Dismiss a notification
PUT Pin or unpin a notification
POST Resolve a notification
POST Mark notification as seen
POST Snooze a notification

oauth 3

POST Exchange Code
POST Refresh Token
POST Get Token

onboarding 6

POST Get next AI discovery question
POST Generate personalised add-on recommendations
POST Complete onboarding after Stripe Checkout
POST Create Stripe Checkout session for onboarding
GET Resume in-progress onboarding
POST Get pre-signed upload URL for onboarding assets

payment-advisory 2

GET Get consolidated AP summary for firm
GET Get payment recommendations

payment-terms 7

GET List payment terms
POST Create payment term
GET Get default payment term
POST Seed default payment terms
DELETE Deactivate payment term
GET Get payment term
PUT Update payment term

purchase-orders 16

GET List inventory orders
POST Create inventory order
GET Get order PDFs
DELETE Delete inventory order
GET Get inventory order
PUT Update inventory order
POST Cancel purchase order
POST Mark purchase order in production
POST Mark purchase order partially received
POST Mark purchase order ready
POST Mark purchase order shipped
POST Record payment for purchase order
POST Recalculate order totals
POST Receive purchase order
POST Submit purchase order
POST Generate order PDF

ramp 13

POST Mark Ramp objects as synced
POST Push chart of accounts to Ramp
POST Register DayZero as Ramp's accounting provider
GET List available Ramp filter options
POST Sync Ramp bills
GET Get Ramp OAuth connect URL
POST Connect Ramp with your own API credentials
DELETE Disconnect Ramp
GET Ramp OAuth callback
GET Ramp connection status
POST Sync Ramp transactions
GET Get Ramp sync configuration
PUT Update Ramp sync configuration

reconciliations 13

GET List reconciliations
POST Create reconciliation
POST Create reconciliation with upload
GET Get reconciliation
GET Get balance validation
POST Complete reconciliation
POST AI match explanations
POST Approve match
POST Bulk approve matches
POST Bulk reject matches
POST Reject match
GET Download reconciliation PDF
POST Start reconciliation processing

recurring 14

GET List recurring templates
POST Create recurring template
GET List recurring bill templates
GET List recurring invoice templates
POST AI recurring template suggestions
DELETE Delete recurring template
GET Get recurring template
PUT Update recurring template
POST Cancel recurring template
POST Clone recurring template
GET Get recurring template history
POST Pause recurring template
POST Resume recurring template
POST Skip next occurrence

reports 6

GET List reports
POST Generate report
GET Download report (proxy)
POST AI report suggestions
GET Get supported report types
GET Get report

search 2

GET Global search
POST AI natural language search

square 5

GET Get Square OAuth connect URL
DELETE Disconnect Square
GET Square OAuth callback
GET Square connection status
POST Sync Square payments

subscriptions 9

GET List detected recurring transactions
PUT Update a detected recurring transaction
POST AI subscription analysis
POST Dismiss a detected recurring transaction
GET Monthly spend history for recurring transactions
POST Restore a dismissed recurring transaction
GET Get recurring transaction budget settings
PUT Set monthly recurring transaction limit
GET Recurring transactions summary for dashboard

tags 17

POST Attach tag to entity
POST Bulk attach tags to an entity
POST Bulk detach tags from an entity
GET Get tags for an entity
DELETE Detach tag from entity
GET List tag groups
POST Create tag group
DELETE Delete tag group
GET Get tag group
PUT Update tag group
GET List tags
POST Create tag
POST AI tag suggestions
DELETE Delete tag
GET Get tag
PUT Update tag
GET Get entities with a tag

tax 13

GET List tax codes
POST Create tax code
POST Seed default tax codes
DELETE Deactivate tax code
GET Get tax code
PUT Update tax code
GET List tax rates
POST Create tax rate
GET Get default tax rate
DELETE Deactivate tax rate
GET Get tax rate
PUT Update tax rate
POST AI tax rate suggestions

transactions 23

GET List transactions
POST Create transaction
PATCH Batch update category
PATCH Batch update counterparty
POST Delete selected transactions
POST Mark all unreviewed transactions in a period as reviewed
PATCH Batch update reconciliation status
PATCH Batch update review status
POST Bulk create transactions
POST Bulk upload transactions to new source account
POST Get CSV/Excel column headers for mapping
POST Upload pasted transaction text
POST Preview bulk transaction upload
GET Download bulk transaction upload CSV template
POST AI-categorize all uncategorized transactions
POST Recategorize all transactions for a counterparty
POST Category suggestions
DELETE Delete or hide transaction
GET Get transaction
PUT Update transaction
GET Get transaction allocations
PATCH Attach file to transaction
POST Restore a hidden transaction

user 7

GET List users
POST Create user
GET Get last-selected business
PUT Set last-selected business
DELETE Delete user
GET Get user
PUT Update user

vendor-contracts 6

GET List vendor contracts
POST Create vendor contract
POST AI contract analysis
DELETE Delete vendor contract
GET Get vendor contract
PUT Update vendor contract

vendor-credits 9

GET List vendor credits
POST Create vendor credit
GET Get vendor available credits
DELETE Delete vendor credit
GET Get vendor credit
PUT Update vendor credit
POST Apply vendor credit to bill
POST Issue vendor credit
POST Void vendor credit

vendors 13

GET List vendors
POST Create vendor
POST Bulk upload vendors from CSV
GET Download bulk vendor upload CSV template
GET Check for duplicate vendors
DELETE Delete vendor
GET Get vendor
PUT Update vendor
GET List vendor contacts
POST Create vendor contact
DELETE Delete vendor contact
GET Get vendor contact
PUT Update vendor contact

xero 13

GET Get Xero OAuth connect URL
DELETE Disconnect Xero
GET Xero migration QA report
GET Xero OAuth callback
GET List parked Xero tenants
POST Finalize Xero multi-org connect
GET Xero connection status
POST Switch active Xero tenant
POST Sync Xero data
GET Get Xero sync configuration
GET Xero sync progress
GET List connected Xero tenants
POST Xero webhook

API Reference / ai-reporting-public

ai-reporting-public

1 endpoint.

GET /api/v1/public/decks/{token} Public deck viewer (unauthenticated)