---
title: "Segment"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/Segment"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# Segment

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    SegmentAttributes:
      type: object
      properties:
        segmentId:
          type: string
          example: SEG123
          description: Segment ID
        originalDepositAmount:
          type: string
          example: "1000"
          description: Original Deposit Amount
        originalDepositDate:
          type: string
          example: 2022-01-01
          description: Original Deposit Date
        depositDate:
          type: string
          example: 2022-01-15
          description: Deposit Date
        depositAmount:
          type: string
          example: "500"
          description: Deposit Amount
        currentAmount:
          type: string
          example: "600"
          description: Current Amount
        numberOfUnits:
          type: string
          example: "10"
          description: Number of Units
        renewalDate:
          type: string
          example: 2023-01-01
          description: Renewal Date
        sweepAccountId:
          type: string
          example: SWEEP001
          description: Sweep Account ID
        startDate:
          type: string
          example: 2022-01-01
          description: Start Date
        endDate:
          type: string
          example: 2022-12-31
          description: End Date
      required:
        - segmentId
        - originalDepositAmount
        - originalDepositDate
        - depositDate
        - depositAmount
        - currentAmount
        - numberOfUnits
        - renewalDate
        - sweepAccountId
        - startDate
        - endDate
    Segment:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/SegmentAttributes"
      required:
        - attributes
```