Skip to main content
POST
Import Financials Configuration

Authorizations

Authorization
string
header
required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId
string<uuid>
required

Company identifier

Query Parameters

dryRun
enum<string>

Report the validated import plan without applying it.

Available options:
true

Body

application/json
documentVersion
enum<integer>
required
Available options:
1
eventFinancials
object
required
policyFinancials
object
required
reporting
object
required

Response

Validated import plan, applied unless dryRun is true.

dryRun
boolean
required
changes
object
required
skipped
object
required