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

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

# PolicyNote

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    PolicyNote:
      type: object
      properties:
        id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
          description: Unique identifier for the note
        notePriority:
          type: string
          description: Priority level of the note
          example: High
        dateEntered:
          type: string
          description: Date when the note was initially entered
          example: 2024-01-15T10:30:00Z
          format: date-time
        summary:
          type: string
          description: Brief summary of the note
          example: Policy review required
        noteCategory:
          type: string
          description: Category classification of the note
          example: Administrative
        noteType:
          type: string
          description: Type classification of the note
          example: Review
        notes:
          type: string
          description: Detailed note content
          example: Annual policy review is due. Please schedule appointment with policy
            holder.
        role:
          type: string
          description: Role of the person who created the note
          example: Administrator
        alertDisableDate:
          type: string
          description: Date when the note should be disabled
          example: 2024-02-15T10:30:00Z
          format: date-time
        alertIndicator:
          type: boolean
          description: Whether this note triggers an alert
          example: true
        userId:
          type: string
          description: ID of the user who created the note
          example: admin001
        timestamp:
          type: string
          description: Date when the note was last modified
          example: 2024-01-15T10:30:00Z
          format: date-time
        endDate:
          type: string
          description: Date when the note expires
          example: 2024-02-15T10:30:00Z
          format: date-time
      required:
        - id
        - notePriority
        - dateEntered
        - summary
        - noteCategory
        - noteType
        - notes
        - role
        - alertDisableDate
        - alertIndicator
        - userId
        - timestamp
        - endDate
```