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

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

# RateMappingFile

Full contents of a carrier's (or generic) RateMapping.json — issueDate → planCode → jurisdiction → payload.

## 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:
    RateMappingJurisdictionEntry:
      type: object
      properties:
        benefits:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/RateMappingBenefitEntry"
          nullable: true
        rates:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              $ref: "#/components/schemas/RateMappingRateEntry"
          description: Keyed by benefit ID, then by rate type name.
          nullable: true
      additionalProperties: false
      description: Payload for a single issueDate/planCode/jurisdiction combination.
    RateMappingBenefitEntry:
      required:
        - available
      type: object
      properties:
        available:
          type: boolean
        configuration:
          type: object
          additionalProperties:
            type: string
          nullable: true
        parameters:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/RateMappingParameterEntry"
          nullable: true
      additionalProperties: false
      description: An entry of a jurisdiction's "benefits" map.
    RateMappingRateEntry:
      required:
        - id
      type: object
      properties:
        id:
          type: string
        conditionsList:
          type: array
          items:
            $ref: "#/components/schemas/RateMappingConditionEntry"
          nullable: true
      additionalProperties: false
      description: An entry of a jurisdiction's "rates" map for one benefit/rate-type
        combination.
    RateMappingParameterEntry:
      required:
        - value
      type: object
      properties:
        value:
          type: string
      additionalProperties: false
      description: "An entry of a benefit's \"parameters\" map, e.g. { \"value\": \"45\" }."
    RateMappingConditionEntry:
      required:
        - conditions
        - id
      type: object
      properties:
        id:
          type: string
        conditions:
          type: object
          additionalProperties: {}
      additionalProperties: false
      description: An entry of a rate's "conditionsList" array.
    RateMappingFile:
      required:
        - rateMapping
      type: object
      properties:
        rateMapping:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/RateMappingJurisdictionEntry"
      additionalProperties: false
      description: Full contents of a carrier's (or generic) RateMapping.json —
        issueDate → planCode → jurisdiction → payload.
```