Data Cleaning

Get Databook

get/api/businesses/{business_id}/workbook/databook

Request

  • Base URL
    https://api.flagpost.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

business_idstring required

Query parameters

include_adjustmentsboolean
entity_idstring nullable

Entity UUID to scope the fiscal calendar / rows, 'unassigned' for null-entity rows, or omit for Consol.

Response

Successful Response

idstring uuid required
business_idstring uuid required
advisory_idstring uuid required
status'empty' | 'processing' | 'ready' | 'failed'

Lifecycle status of a business databook.

fiscal_year_endinteger nullable
fiscal_year_label_offsetinteger
currencystring
granularity'monthly' | 'quarterly' | 'yearly'

Time period granularity of financial data.

period_startstring nullable
period_endstring nullable
company_namesstring[]
source_job_idstring uuid nullable
error_messagestring nullable
has_mixed_fiscal_calendarsboolean
entity_scopestring nullable
calendar_warningsstring[]
has_manual_editsboolean
last_merge_statsobject
adjustments_errorstring nullable
applied_adjustment_countinteger
draft_adjustment_countinteger
aje_extractionobject
reported_net_incomeobject

Changes

No recorded changes to this operation across all 1 revision of this API.