FLflagpost
Data Cleaning

Save Databook Entities

Set the business's entities, and return them with their ids.

Entities belong to the business, not to a databook or a run: they are named once and reused across runs. So this neither needs nor creates a databook — naming an entity on a business that has never been run has to work, since that is exactly when the first run needs a roster to attribute against.

Saving here rather than as a side effect of running is what gives entities ids up front.

put/api/businesses/{business_id}/workbook/databook/entities

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

namestring required

Canonical entity display name

aliasesstring[]

Alternate names that should map to this entity

fiscal_year_endinteger nullable

Entity fiscal year end month (1=Jan .. 12=Dec). Null means inherit the databook reporting year end.

fiscal_year_label_offsetinteger nullable

Entity fiscal year label offset. Null inherits the databook offset.

Response

Successful Response

idstring uuid required
namestring required
sort_orderinteger
aliasesstring[]
fiscal_year_endinteger nullable
fiscal_year_label_offsetinteger nullable
effective_fiscal_year_endinteger
effective_label_offsetinteger

Changes

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