@get-asset/sdk

Book Health

Headless compound answering “are my books healthy?” for one fiscal year of the business (twelve months from its fiscal-year start; calendar years when that is January): a fraction of months closed and verified (the denominator is always 12), a per-month tone for a twelve-month grid and meter, and the open tasks waiting on the business, grouped by category. Selecting a month filters the tasks to it; the in-scope list is handed to a nested Tasks compound, actions included. A year dropdown offers previous years back to the business's entries start, and hides when there are none — the component is deliberately decoupled from the AssetProvider's shared date range.

Anatomy

Import the primitive and compose the parts you need.

<BookHealth.Root>
  <BookHealth.YearSelect>{/* a Select-Root-shaped child */}</BookHealth.YearSelect>
  <BookHealth.Success>
    <BookHealth.ReadyCount /> / <BookHealth.MonthCount />
    <BookHealth.Months>
      <BookHealth.MonthTone />           {/* meter segment */}
    </BookHealth.Months>
    <BookHealth.Months>
      <BookHealth.MonthCell>
        <BookHealth.MonthLabel />
        <BookHealth.MonthTaskCount />
      </BookHealth.MonthCell>
      <BookHealth.MonthBreakdown>
        <BookHealth.BreakdownLabel />
        <BookHealth.BreakdownCount />
      </BookHealth.MonthBreakdown>
      <BookHealth.BreakdownTotal />
    </BookHealth.Months>
    <BookHealth.TasksLabel />
    <BookHealth.TaskCount />
    <BookHealth.ShowAllMonths />
    <BookHealth.TasksEmpty>
      <BookHealth.TasksEmptyMessage />
    </BookHealth.TasksEmpty>
    {/* The in-scope tasks render through the Tasks compound: */}
    {/* <Tasks.Root tasks={tasks} onUpload={uploadTask} onAddNote={addTaskNote}> ... */}
  </BookHealth.Success>
</BookHealth.Root>

Required scopes

The access token used by AssetProvider must include these scopes for this primitive to fetch data successfully:

• business:read
• request:read
• plaid:create
• document:create
• journal_entry:read
• journal_entry:create

API reference

Root props

Parts