---
title: "ScenarioMappingFile"
url: "https://developers.zinnia.com/apis/rate-configuration/versions/09cd2eb7-6cba-4d5f-b142-73e01c2ad670/schemas/ScenarioMappingFile"
---

> Full API specification: https://developers.zinnia.com/apis/rate-configuration/versions/09cd2eb7-6cba-4d5f-b142-73e01c2ad670.md

# ScenarioMappingFile

Full contents of a carrier's (or generic) ScenarioMapping.json, keyed by product type or plan code.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Rate Configuration
  version: 1.0.0
servers:
  - url: https://dev.api.zinnia.io
    description: Development
components:
  schemas:
    ScenarioMappingProductLevelEntry:
      required:
        - supportedCalculations
      type: object
      properties:
        transactionOrder:
          type: array
          items:
            type: array
            items:
              type: string
          description: Each step is one or more transaction IDs to run together, e.g.
            [["SOLVE_FACE"], ["SOLVE_TERM_FACE", "SOLVE_DEPOSIT"]].
          nullable: true
        supportedCalculations:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              $ref: "#/components/schemas/ScenarioMappingIllustrationLevelEntry"
          description: Keyed by calculation type, then by illustration type.
      additionalProperties: false
      description: Scenario/transaction config for one product type or plan code.
    ScenarioMappingIllustrationLevelEntry:
      required:
        - scenario
      type: object
      properties:
        duration:
          type: integer
          format: int32
          nullable: true
        scenario:
          type: array
          items:
            $ref: "#/components/schemas/ScenarioMappingScenarioEntry"
      additionalProperties: false
      description: An entry of a calculation type's illustration-type map, e.g.
        supportedCalculations.SINGLE_ILLUSTRATION.NEW_BUSINESS.
    ScenarioMappingScenarioEntry:
      required:
        - id
        - isBasis
      type: object
      properties:
        id:
          type: string
        isBasis:
          type: boolean
      additionalProperties: false
      description: An entry of an illustration level's "scenario" array.
    ScenarioMappingFile:
      required:
        - scenarioMapping
      type: object
      properties:
        scenarioMapping:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/ScenarioMappingProductLevelEntry"
      additionalProperties: false
      description: Full contents of a carrier's (or generic) ScenarioMapping.json,
        keyed by product type or plan code.
```