Financials
Financial Models

Create a financial model run

post/api/v1/financials/fin_model/runs

Request

  • Base URL: https://api.withaccend.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withaccend.com/api/v1/financials/fin_model/runs
  • Auth: none declared

Request body

fin_model_template_keystring required

Key of the template to base the run on.

versioninteger nullable

Template version to use. If omitted, the default version is used.

namestring required

Display name for the run.

descriptionstring nullable

Optional description.

entity_idstring nullable

Entity ID to associate with this run.

Response

Successful Response

fin_model_run_idstring required

Unique identifier of the run.

namestring required

Display name of the run.

descriptionstring nullable

Optional description.

status'pending' | 'running' | 'completed' | 'failed' required
fin_model_template_keystring nullable

Key of the template this run is based on.

fin_model_template_versioninteger nullable

Version of the template used.

created_atstring date-time required

Timestamp when the run was created.

updated_atstring date-time required

Timestamp when the run was last updated.

Changes

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