document_templates

create_calculated_field

POST

/api/v2/document_templates/create_calculated_field

Code
Create a new calculated field. Always appended at the end (highest sort_order).
Use sort_calculated_field to change ordering.

Parameters:
    field_name: str - required, valid Python identifier
    path: str - where to evaluate ('' for root, 'drivers' for arrays)
    expression: str - restricted Python expression
    description: str - optional description
    x_report_location_id: str or None - None for global, ID for template-specific

create_calculated_field › Request Body

Request payload for /api/v2/document_templates/create_calculated_field

request-create_calculated_field

field_name

string · pattern: ^[a-zA-Z_][a-zA-Z0-9… · required

Valid Python identifier for the calculated field

expression

string · required

RestrictedPython expression to evaluate

path

string

Dot-notation path (e.g. 'drivers', 'coverages.deductibles'). Empty for root.

Default:

description

string | null

Optional description

x_report_location_id

string | null · uuid

Template deliverable ID. Null for global fields.

create_calculated_field › Responses

200

Response payload for /api/v2/document_templates/create_calculated_field

response-create_calculated_field

required

calculated_field-def · required

A calculated field definition for Carbone document templates

success

boolean · required

POST/api/v2/document_templates/create_calculated_field

curl --request POST \
  --url /api/v2/document_templates/create_calculated_field \
  --header 'Content-Type: application/json' \
  --data '
{
  "field_name": "field_name",
  "expression": "expression",
  "path": "",
  "description": "description",
  "x_report_location_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "field_name": "field_name",
  "expression": "expression",
  "path": "",
  "description": "description",
  "x_report_location_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "x_report_location_id": "00000000-0000-0000-0000-000000000000",
    "field_name": "field_name",
    "path": "path",
    "expression": "expression",
    "description": "description",
    "sort_order": 0,
    "field_type": "global"
  },
  "success": true
}

json

application/json

delete_calculated_field

POST

/api/v2/document_templates/delete_calculated_field

Code
Delete a calculated field.

Parameters:
    id: str - the field ID to delete

delete_calculated_field › Request Body

Request payload for /api/v2/document_templates/delete_calculated_field

request-delete_calculated_field

id

string · uuid · required

ID of the field to delete

delete_calculated_field › Responses

200

Response payload for /api/v2/document_templates/delete_calculated_field

response-delete_calculated_field

required

object · required

success

boolean · required

get_available_functions

POST

/api/v2/document_templates/get_available_functions

Code
Get reference documentation for available custom functions.

get_available_functions › Request Body

get_available_functions › Responses

200

Response payload for /api/v2/document_templates/get_available_functions

response-get_available_functions

required

object · required

success

boolean · required

list_calculated_fields

POST

/api/v2/document_templates/list_calculated_fields

Code
List calculated fields. Each field has a `type` field ('global' or
'template') derived from x_report_location_id.

Parameters:
    x_report_location_id: str or None

list_calculated_fields › Request Body

Request payload for /api/v2/document_templates/list_calculated_fields

request-list_calculated_fields

x_report_location_id

string | null · uuid

Template deliverable ID. If provided, returns global + template-specific fields. If null/omitted, returns global fields only.

list_calculated_fields › Responses

200

Response payload for /api/v2/document_templates/list_calculated_fields

response-list_calculated_fields

required

calculated_field-def[] · required

Flat list of calculated fields. Use field_type to distinguish global vs template.

success

boolean · required

POST/api/v2/document_templates/list_calculated_fields

curl --request POST \
  --url /api/v2/document_templates/list_calculated_fields \
  --header 'Content-Type: application/json' \
  --data '
{
  "x_report_location_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "x_report_location_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "x_report_location_id": "00000000-0000-0000-0000-000000000000",
      "field_name": "field_name",
      "path": "path",
      "expression": "expression",
      "description": "description",
      "sort_order": 0,
      "field_type": "global"
    }
  ],
  "success": true
}

json

application/json

sort_calculated_field

POST

/api/v2/document_templates/sort_calculated_field

Code
Move a calculated field to a new position within its scope.
Same pattern as sortUnderwritingRules - takes a single field ID
and its new index position.

Parameters:
    field_id: str - the field to move
    new_order: int - the new 0-based index position

sort_calculated_field › Request Body

Request payload for /api/v2/document_templates/sort_calculated_field. Same pattern as sortUnderwritingRules.

request-sort_calculated_field

field_id

string · uuid · required

ID of the field to move

new_order

integer · min: 0 · required

New 0-based index position

sort_calculated_field › Responses

200

Response payload for /api/v2/document_templates/sort_calculated_field

response-sort_calculated_field

required

object · required

success

boolean · required

test_expression

POST

/api/v2/document_templates/test_expression

Code
Test an expression against provided context data.

Parameters:
    expression: str - the expression to evaluate
    path: str - path context ('' for root, 'drivers' for arrays)
    context: dict - the context data to evaluate against

test_expression › Request Body

Request payload for /api/v2/document_templates/test_expression

request-test_expression

expression

string · required

RestrictedPython expression to evaluate

path

string

Path context (e.g. '' for root, 'drivers' for arrays)

Default:

context

object

Template context data to evaluate the expression against

test_expression › Responses

200

Response payload for /api/v2/document_templates/test_expression

response-test_expression

required

object · required

success

boolean · required

update_calculated_field

POST

/api/v2/document_templates/update_calculated_field

Code
Update an existing calculated field. sort_order cannot be changed here;
use sort_calculated_field instead.

Parameters:
    id: str - required, the field ID to update
    field_name: str - optional new field name
    path: str - optional new path
    expression: str - optional new expression
    description: str - optional new description

update_calculated_field › Request Body

Request payload for /api/v2/document_templates/update_calculated_field

request-update_calculated_field

id

string · uuid · required

ID of the field to update

field_name

string · pattern: ^[a-zA-Z_][a-zA-Z0-9…

New field name

expression

string

New expression

path

string

New path

description

string | null

New description

update_calculated_field › Responses

200

Response payload for /api/v2/document_templates/update_calculated_field

response-update_calculated_field

required

calculated_field-def · required

A calculated field definition for Carbone document templates

success

boolean · required

POST/api/v2/document_templates/update_calculated_field

curl --request POST \
  --url /api/v2/document_templates/update_calculated_field \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "field_name": "field_name",
  "expression": "expression",
  "path": "path",
  "description": "description"
}
'

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "field_name": "field_name",
  "expression": "expression",
  "path": "path",
  "description": "description"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "x_report_location_id": "00000000-0000-0000-0000-000000000000",
    "field_name": "field_name",
    "path": "path",
    "expression": "expression",
    "description": "description",
    "sort_order": 0,
    "field_type": "global"
  },
  "success": true
}

json

application/json

document_summary drivers