Skip to main content
Financial Data & Planning

Run deterministic company revenue and expense scenarios

POST /companies/{company}/scenarios

Contract

Authentication
Bearer credential required
Required scope
financial:analysis:run
Status
Published

Parameters

Name Location Type Required Description
company path integer Yes

Code examples

These examples compose a request only. Public reference pages never transmit your credential or execute the operation.

curl

curl -X POST \
  -H "Authorization: Bearer $FINANCEGPT_API_KEY" \
  -H "Accept: application/json"
  "https://financegpt.dev/api/v2/companies/{company}/scenarios"

javascript

const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/companies\/{company}\/scenarios", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
    Accept: 'application/json',
  },
});
const data = await response.json();

python

import json
import os
import requests

response = requests.request(
    'POST',
    'https://financegpt.dev/api/v2/companies/{company}/scenarios',
    headers={
        'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
        'Accept': 'application/json',
    },
)
response.raise_for_status()
print(response.json())

php

<?php
$ch = curl_init('https://financegpt.dev/api/v2/companies/{company}/scenarios');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
        'Accept: application/json',
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

Status Description
201 Scenario comparison against the latest recorded period

Authority boundary

A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.

financial:analysis:run

Machine-readable sources