Skip to main content
POST
Create bookkeeping status report export
Starts a client-wide async XLSX export of bookkeeping status for businesses enrolled in bookkeeping. The workbook has a Businesses sheet with enrollment, onboarding, pending task, and latest closed period information, and a Periods sheet with period statuses, billing statuses, task metrics, and closing milestones. Poll Fetch export or subscribe to export.completed / export.failed webhooks to retrieve the completed file. See Generating async reports.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Options for the client-wide bookkeeping status XLSX export. Send an empty object to use both defaults.

use_derived_status
boolean
default:false

When true, calculate period statuses from current bookkeeping facts rather than using stored statuses.

require_onboarding_call
boolean
default:true

When deriving statuses, require the onboarding date to have passed before reporting an actionable period status. Has no effect unless use_derived_status is true.

Response

202 - application/json

Export request accepted and generation started.

data
object
required

An async export request and its current status.