FLflagpost
Data Cleaning

Run Data Cleaning

Start data cleaning with full inputs (companies, entities, FYE, periods).

post/api/businesses/{business_id}/workbook/run

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

Request body

company_namesstring[]
fiscal_year_endinteger nullable
fiscal_year_label_offsetinteger
start_yearinteger nullable
start_monthinteger nullable
end_yearinteger nullable
end_monthinteger nullable
document_idsstring[]
excluded_document_idsstring[]
ignore_periods_outside_windowboolean
persist_mode'merge' | 'rebuild'
refresh_document_idsstring[]

Response

Successful Response

successboolean required
messagestring required
statusstring
job_idstring required
data_cleaning_job_idstring required

Changes

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