PostMemberClaimRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lynx/main/json-schema/lynx-post-member-claim-request-schema.json",
  "title": "PostMemberClaimRequest",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lynx-claims-service-api-openapi.yml#/components/schemas/PostMemberClaimRequest",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/CreateClaimRequestData"
    },
    "idempotency": {
      "$ref": "#/$defs/Idempotency",
      "description": "Unique identifier that represents the operation"
    }
  },
  "required": [
    "data",
    "idempotency"
  ],
  "$defs": {
    "BaseAddress": {
      "type": "object",
      "properties": {
        "line1": {
          "type": "string",
          "description": "The first line of the address"
        },
        "line2": {
          "type": "string",
          "description": "The (optional) second line of the address"
        },
        "city": {
          "type": "string",
          "description": "Address city"
        },
        "stateProvince": {
          "type": "string",
          "description": "2-Character address state or province"
        },
        "country": {
          "type": "string",
          "description": "Address country"
        },
        "postalCode": {
          "type": "string",
          "description": "Address zip code"
        },
        "postalCodeExtension": {
          "type": "string",
          "description": "Address zip code extension"
        }
      },
      "required": [
        "city",
        "country",
        "line1",
        "postalCode",
        "stateProvince"
      ]
    },
    "BaseMember": {
      "type": "object",
      "properties": {
        "clientMemberId": {
          "type": "string",
          "description": "Unique client-side identifier for the member"
        }
      },
      "required": [
        "clientMemberId"
      ]
    },
    "ClientOrgDto": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the client organization"
        }
      },
      "required": [
        "name"
      ]
    },
    "CreateClaimRequestData": {
      "type": "object",
      "properties": {
        "clientOrg": {
          "$ref": "#/$defs/ClientOrgDto"
        },
        "member": {
          "$ref": "#/$defs/BaseMember"
        },
        "memberAccount": {
          "$ref": "#/$defs/MemberAccountIdDto"
        },
        "memberBankAccount": {
          "$ref": "#/$defs/MemberBankAccountDto"
        },
        "merchantName": {
          "type": "string",
          "description": "Name of the merchant related to the claim"
        },
        "description": {
          "type": "string",
          "description": "The short description for the claim"
        },
        "expenseDate": {
          "type": "string",
          "description": "The date when the expense was incurred"
        },
        "claimAmount": {
          "type": "number",
          "description": "Total amount of the claim"
        },
        "reimbursementType": {
          "type": "string",
          "description": "Method of payment for Reimbursement (CHECK/ACH)"
        },
        "category": {
          "type": "string",
          "description": "The category for the Claim",
          "enum": [
            "OverTheCounter",
            "Wellness",
            "HealthyFood",
            "RentPayment",
            "UtilityPayment",
            "MortgagePayment",
            "Other",
            "FitnessFacility",
            "FitnessClass"
          ]
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MemberClaimItemDto"
          }
        },
        "address": {
          "$ref": "#/$defs/BaseAddress"
        },
        "serviceType": {
          "type": "string"
        }
      },
      "required": [
        "claimAmount",
        "clientOrg",
        "expenseDate",
        "member",
        "memberAccount",
        "reimbursementType"
      ]
    },
    "Idempotency": {
      "type": "object",
      "properties": {
        "idempotencyKey": {
          "type": "string",
          "description": "Unique identifier that represents the operation"
        }
      }
    },
    "MemberAccountIdDto": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier of the bank account"
        }
      },
      "required": [
        "id"
      ]
    },
    "MemberBankAccountDto": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "UUID of the Member's external bank account"
        }
      },
      "required": [
        "id"
      ]
    },
    "MemberClaimItemDto": {
      "type": "object",
      "properties": {
        "itemDescription": {
          "type": "string",
          "description": "Description of the item or service. e.g. Tums, Teeth Cleaning"
        },
        "amount": {
          "type": "number",
          "description": "The cost of the individual item."
        }
      },
      "required": [
        "amount",
        "itemDescription"
      ]
    }
  }
}