Holistiplan Public API

Your tax-planning engine, available to your own systems

The Holistiplan Public API gives your firm programmatic control over the same tax-planning engine your advisors use every day. It is a standard RESTful, JSON-based API. Stand up your book of business, push tax documents in for automated extraction, pull richly structured tax data back out, and generate Holistiplan's client-ready reports, all from inside your own systems.

The end-to-end flow
Step 1
Build your book
Households & Clients
Step 2
Feed documents in
Tax return uploads
Step 3
Pull data out
Income Tax & Scenarios
Step 4
Pull reports out
Client-ready PDFs
01

Build your book of business: Households & Clients

Stand up and maintain the records everything else hangs off of. A Household is the central planning unit, typically a family or relationship. Clients are the individual taxpayers inside it.

Why it matters

Onboard or continuously sync your entire client base programmatically, with no manual data entry and a clean key back to your system of record.

How it works
  • Create a household with POST/households/ and supply a name, state of residence, and the firm subsidiary it belongs to.

  • Add the people with POST/clients/: first and last name, the household they belong to, primary-contact flag, birth date, and email.

  • Keep records aligned to your CRM using the crm_key field on each record.

  • Sync at scale with the bulk create_or_update_many endpoints rather than one record at a time.

02

Provision your team: Users, Household & Feature Access

Control who is on Holistiplan, what they can do, and which clients they can see. Access is provisioned in three independent layers, so you can mirror your org structure and enforce least-privilege.

Why it matters

Automate onboarding and offboarding, keep permissions in lockstep with your HR or identity systems, and ensure advisors only access the households they should.

How it works
  • Create the user with POST/users/: set the email, optional firm-admin status, a default subsidiary, and invite_while_creating to send the welcome invite automatically.

  • Grant Feature Access by assigning firm_permission_groups, which unlock specific Holistiplan features and products. List the available groups with GET/firm_permission_groups/. Firm Permission Groups are an Enterprise feature beyond the Default permissions.

  • Scope Household Access so a user only sees the right clients: directly via a household's user_access list with owner designation, and by assigning Units (GET/units/) for team-based grouping.

  • Manage the full lifecycle with activate, deactivate, and reset_password_and_send_invite.

03

Feed documents in: Tax Return Uploads

Push tax documents into Holistiplan and let it do the extraction. Upload completed returns or IRS transcripts and Holistiplan automatically parses them into structured data.

Why it matters

Feed returns straight from your document management system at scale. Holistiplan handles the reading and extraction so your team does not have to.

How it works
  • Create the record with POST/tax_returns/, specifying the household, the tax year, and the document type (tax_return or irs_transcript).

  • Upload the file with POST/tax_returns/{id}/multipart_upload/. Password-protected PDFs are supported by passing the password alongside the file.

  • Track progress on the record's status as it moves from awaiting file, to processing, to done, or flagged for review.

04

Pull data out: Income Tax & Scenario Analysis

Retrieve clean, structured tax data with no rekeying from PDFs. Income Tax records hold the key parsed figures from each processed return. Scenario Analysis records hold the same rich field set for the what-if plans your advisors build.

Why it matters

Power your own dashboards, planning tools, or data warehouse with reliable tax data, turning every uploaded return into structured intelligence.

How it works
  • Read parsed return data with GET/income_tax/ and planning scenarios with GET/scenario_analyses/.

  • Each record exposes a deep set of fields, including AGI, taxable income, total tax, marginal and capital-gains brackets, effective rate, capital gains and loss carryovers, Medicare and IRMAA MAGI, and Schedule A through E line items.

  • Filter by household, year, or taxpayer, and use expand to inline related household and taxpayer details in a single call.

05

Pull reports out: Tax Report, Roth Projection & Tax Letter PDFs

Generate Holistiplan's polished, client-ready documents on demand and deliver them inside your own portal or workflow. PDF generation is asynchronous and follows one consistent pattern across all three report types.

Why it matters

Surface Holistiplan's most client-facing deliverables exactly where your advisors and clients already work.

How it works
  • Queue the document with the report's queue_pdf_snapshot action. You receive a snapshot job ID in return.

  • Poll GET/pdf_snapshots/{id}/ until processing succeeds, then read the download_url.

  • Download the finished file via GET/pdf_snapshots/{id}/download/.

  • Available for the Tax Report (/tax_reports/), Roth Projection (/roth_projections/), and Tax Letter (/tax_letter_status/, in client or CPA mode). Tax Letters can also be batched into a single ZIP for up to 100 households at once.

Getting started

Most integrations follow a simple end-to-end flow: build your book, feed documents in, pull data and reports back out. Here is what your engineering team can count on.

Interface
RESTful, JSONPaginated list endpoints and standard filtering throughout.
Authentication
OAuth2Per-firm credentials with scoped access.
Access
Request for your firmCredentials are issued per firm by the Holistiplan team.
Contact support@holistiplan.com
Holistiplan Public API ยท Capabilities Overview holistiplan.com