DocClientOrgCopayGroupCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lynx/main/json-schema/lynx-doc-client-org-copay-group-create-request-schema.json",
  "title": "DocClientOrgCopayGroupCreateRequest",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lynx-copay-management-service-api-openapi.yml#/components/schemas/DocClientOrgCopayGroupCreateRequest",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/ClientOrgCopayGroupCreateData"
    },
    "idempotency": {
      "$ref": "#/$defs/Idempotency",
      "description": "Unique identifier that represents the operation"
    }
  },
  "required": [
    "data",
    "idempotency"
  ],
  "$defs": {
    "ClientOrgCopayGroupCreateData": {
      "type": "object",
      "properties": {
        "clientOrg": {
          "$ref": "#/$defs/ClientOrgDto"
        },
        "effectiveDate": {
          "type": "string",
          "description": "Beginning effective date of the copay group"
        },
        "expirationDate": {
          "type": "string",
          "description": "Ending effective date of the copay group"
        },
        "copayList": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CopayItem"
          }
        }
      },
      "required": [
        "clientOrg",
        "copayList",
        "effectiveDate",
        "expirationDate"
      ]
    },
    "ClientOrgDto": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the client organization"
        }
      },
      "required": [
        "name"
      ]
    },
    "CopayItem": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "Type of covered health care service, such as Doctor Office Visit, Urgent Care Visit, Prescription, Physical Therapy, Mental Health Therapy, Hospital Visit, Emergency Room Visit, Dental, Hearing, Vision, and Lab Services",
          "enum": [
            "Dental",
            "Doctor Office Visit",
            "Emergency Room Visit",
            "Hearing",
            "Hospital Visit",
            "Lab Services",
            "Mental Health Therapy",
            "Physical Therapy",
            "Prescription",
            "Urgent Care Visit",
            "Vision"
          ]
        },
        "amount": {
          "type": "number",
          "description": "A fixed amount (for example, $15) you pay for a covered health care service, usually when you receive the service. The amount can vary by the type of covered health care service."
        }
      },
      "required": [
        "amount",
        "category"
      ]
    },
    "Idempotency": {
      "type": "object",
      "properties": {
        "idempotencyKey": {
          "type": "string",
          "description": "Unique identifier that represents the operation"
        }
      }
    }
  }
}