title: Policies API language_tabs:
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
GET /policies/v2.0/benefititemclauses/{id}
Gets a benefit item clause by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The benefit item clause id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemTierId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item clause.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItemClause |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/benefititemclauses
Search for benefit item clause.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemTierId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item clause.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBenefitItemClause |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/benefititemoptions/{id}
Gets a benefit item option by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The benefit item option id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"benefitItemOptionTypeId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item option.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItemOption |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/benefititemoptions
Search for benefit item option.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"benefitItemOptionTypeId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item option.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBenefitItemOption |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/benefititemoptiontypes/{id}
Gets a benefit item option type by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The benefit item option type id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItemOptionType |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/benefititemoptiontypes
Search for benefit item option type.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBenefitItemOptionType |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/benefititems/{id}
Gets a benefit item by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The benefit item id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItem |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/benefititems
Search for benefit item.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBenefitItem |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/benefititemtiers/{id}
Gets a benefit item tier by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The benefit item tier id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item tier.",
"maxLength": 255,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item tier is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item tier.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItemTier |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/benefititemtiers
Search for benefit item tier.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item tier.",
"maxLength": 255,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item tier is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item tier.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBenefitItemTier |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/benefititemvalues
Deletes the benefit item values associated with the policy
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The ID of the policy for which all benefit value items are to be deleted. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/benefititemvalues
Returns list of benefit item values for the policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item value.",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | BenefitItemValueBaseInfo | false | none | none |
| »»» benefitItemClauseId | integer(int32) | false | none | none |
| »»» sortOrder | integer(int32) | false | none | none |
| »»» text | string|null | false | none | Additional information about the Benefit Item besides its main Value. |
| »»» value | string|null | false | none | Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options' |
| »»» benefitItemValueType | BenefitItemValueType | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» policyId | integer(int32) | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» id | integer(int32) | false | none | The unique Zywave identifier for the benefit item value. |
| Property | Value |
|---|---|
| benefitItemValueType | Percent |
| benefitItemValueType | Dollar |
| benefitItemValueType | DollarOrPercent |
| benefitItemValueType | Boolean |
| benefitItemValueType | Numeric |
| benefitItemValueType | Options |
| benefitItemValueType | Text |
POST /policies/v2.0/policies/{policyId}/benefititemvalues
Creates a benefit item value.
Benefit item value has a dependency on other benefit item value items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | BenefitItemValueBaseInfo | true | The benefit item value to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the ID of the created benefit item value. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/benefititemvalues/{id}
Deletes the benefit item value associated with the benefit item value id.
Benefit item value has a dependency on other benefit item value items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The ID of the benefit item value to delete. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/benefititemvalues/{id}
Gets a benefit item value by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The benefit item value id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item value.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItemValue |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/benefititemvalues/{id}
Updates the existing benefit item value information for the benefit item value id specified.
Benefit item value has a dependency on other benefit item value items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The ID of the benefit item value to update |
| body | body | BenefitItemValueBaseInfo | true | The information to update on the benefit item value. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/billingmodes/{id}
Gets a billing mode by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The billing mode id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the billing mode.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the billing mode is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the billing mode.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BillingMode |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/billingmodes
Search for billing mode.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the billing mode.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the billing mode is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the billing mode.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBillingMode |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/carriercommissiontoagencypaymentschedules/{id}
Gets an carrier commission to agency payment schedule by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The carrier commission to agency payment schedule id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the carrier commission to agency payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32"
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the carrier commission to agency payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the carrier commission to agency payment schedule.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | CarrierCommissionToAgencyPaymentSchedule |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/carriercommissiontoagencypaymentschedules
Search for an carrier commission to agency payment schedule.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the carrier commission to agency payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32"
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the carrier commission to agency payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the carrier commission to agency payment schedule.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfCarrierCommissionToAgencyPaymentSchedule |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{id}/cobra/{rateTier}
Deletes a COBRA record.
Cobra Rate is influenced by Cobra Rate Strategy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| rateTier | path | RateTierTypeOption | true | The rate tier. |
| Parameter | Value |
|---|---|
| rateTier | Employee |
| rateTier | EmployeeSpouse |
| rateTier | EmployeeChildren |
| rateTier | EmployeeFamily |
| rateTier | EmployeeChild |
| rateTier | EmployeeSpouseChild |
| rateTier | EmployeeTwoChildren |
| rateTier | EmployeeThreeChildren |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{id}/cobrastrategies
Deletes a COBRA strategy and child records.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/cobrastrategies
Inserts or updates a COBRA rate strategy.
Cobra Rate is influenced by Cobra Rate Strategy.
Note: Changing OverrideDefaultRate from false to true will OVERWRITE the saved values.
Note: Setting DefaultRate will change values in all records UNLESS OverrideDefaultRate is false.
Body parameter
{
"type": "object",
"description": "A COBRA strategy record",
"additionalProperties": false,
"properties": {
"defaultRate": {
"description": "The default COBRA rate (as a percentage) to apply to `CobraRateRecord` values for the policy.\n \nThe default value for this property is `102`.\n \nThis rate is used if `OverrideDefaultRate` is `false`; it is ignored if `true`.\n \nIf `false`, the `DefaultRate` is multiplied by the policy rate for the rate tier.",
"default": "OneHundredTwoPercent",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
]
},
"overrideDefaultRate": {
"type": "boolean",
"description": "If `true`, then the default rate is overriden in the `CobraRateRecord` values for the policy.\n \nThe default value for this property is `false`.\n \n**Note:** Changing this value from `false` to `true` will **OVERWRITE** the saved values.",
"default": false,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| body | body | CobraRateStrategyInfo | true | The CobraRateStrategy. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"strategy": {
"description": "The CobraRateStrategy.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"description": "A COBRA strategy record",
"additionalProperties": false,
"properties": {
"defaultRate": {
"description": "The default COBRA rate (as a percentage) to apply to `CobraRateRecord` values for the policy.\n \nThe default value for this property is `102`.\n \nThis rate is used if `OverrideDefaultRate` is `false`; it is ignored if `true`.\n \nIf `false`, the `DefaultRate` is multiplied by the policy rate for the rate tier.",
"default": "OneHundredTwoPercent",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
]
},
"overrideDefaultRate": {
"type": "boolean",
"description": "If `true`, then the default rate is overriden in the `CobraRateRecord` values for the policy.\n \nThe default value for this property is `false`.\n \n**Note:** Changing this value from `false` to `true` will **OVERWRITE** the saved values.",
"default": false,
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate strategy record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate Strategy",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
]
},
"cobraRates": {
"type": "array",
"description": "An array of CobraRateRecord values.",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate record",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"tier": {
"description": "The contribution tier for the rate record.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK result for an update or a 201 Created for an insert. | CobraRatesWithStrategy |
| 201 | Created | A 200 OK result for an update or a 201 Created for an insert. | CobraRatesWithStrategy |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{id}/cobra
Gets the COBRA rates for the policy.
Cobra Rate is influenced by Cobra Rate Strategy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"strategy": {
"description": "The CobraRateStrategy.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"description": "A COBRA strategy record",
"additionalProperties": false,
"properties": {
"defaultRate": {
"description": "The default COBRA rate (as a percentage) to apply to `CobraRateRecord` values for the policy.\n \nThe default value for this property is `102`.\n \nThis rate is used if `OverrideDefaultRate` is `false`; it is ignored if `true`.\n \nIf `false`, the `DefaultRate` is multiplied by the policy rate for the rate tier.",
"default": "OneHundredTwoPercent",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
]
},
"overrideDefaultRate": {
"type": "boolean",
"description": "If `true`, then the default rate is overriden in the `CobraRateRecord` values for the policy.\n \nThe default value for this property is `false`.\n \n**Note:** Changing this value from `false` to `true` will **OVERWRITE** the saved values.",
"default": false,
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate strategy record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate Strategy",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
]
},
"cobraRates": {
"type": "array",
"description": "An array of CobraRateRecord values.",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate record",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"tier": {
"description": "The contribution tier for the rate record.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the COBRA rate records and strategy for the policy. | CobraRatesWithStrategy |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/cobra/{contributionTier}
Inserts or updates a COBRA rate record.
Cobra Rate is influenced by Cobra Rate Strategy.
NOTE: If the CobraRateStrategy associated with the policy has OverrideDefaultRate = false, the value will NOT be used. The record for the tier will be created, however, if it does not already exist.
Body parameter
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| contributionTier | path | RateTierTypeOption | true | The contribution tier. |
| body | body | CobraRateRecordInfo | true | The CobraRateRecord. |
| Parameter | Value |
|---|---|
| contributionTier | Employee |
| contributionTier | EmployeeSpouse |
| contributionTier | EmployeeChildren |
| contributionTier | EmployeeFamily |
| contributionTier | EmployeeChild |
| contributionTier | EmployeeSpouseChild |
| contributionTier | EmployeeTwoChildren |
| contributionTier | EmployeeThreeChildren |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate record",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"tier": {
"description": "The contribution tier for the rate record.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Either a 200 OK (for an update) or a 201 Created (for an insert) with a ContributionRecord payload containing the computed contributions in dollars for employer and employee. | CobraRateRecord |
| 201 | Created | Either a 200 OK (for an update) or a 201 Created (for an insert) with a ContributionRecord payload containing the computed contributions in dollars for employer and employee. | CobraRateRecord |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/commissionbillings/{id}
Deletes the commission billing information associated with the commission billing id specified.
Commission billing has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The ID of the commission billing to delete. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/commissionbillings/{id}
Returns the commission billing information for the commission billing id specified.
Commission billing has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The commission billing id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the commission billing record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the commission billing.",
"format": "int32"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the commission billing was last updated.",
"format": "date-time"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the commission billing.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the commission billing.",
"nullable": true
},
"billingVendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the billing vendor.",
"format": "int32",
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | CommissionBilling |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/commissionbillings/{id}
Updates the existing commission billing information for the commission billing id specified.
Commission billing has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The ID of the commission billing to update |
| body | body | CommissionBillingBaseInfo | true | The information to update on the commission billing. |
Example responses
400 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/commissionbillings
Returns list of commission billing information for the policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the commission billing record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the commission billing.",
"format": "int32"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the commission billing was last updated.",
"format": "date-time"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the commission billing.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the commission billing.",
"nullable": true
},
"billingVendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the billing vendor.",
"format": "int32",
"nullable": true
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | CommissionBillingBaseInfo | false | none | none |
| »»» billingCarrierCompanyId | integer(int32) | true | none | The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference. |
| »»» commissionType | CommissionTypeOption | true | none | The type of commission. Ex. Annual |
| »»» annualPremium | number(decimal) | true | none | The annual premium for the commission billing. |
| »»» insuredPaymentScheduleId | integer(int32)|null | false | none | The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference. |
| »»» billingModeId | integer(int32)|null | false | none | The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference. |
| »»» currentSubscriberCount | integer(int32)|null | false | none | The amount of subscribers for the policy tied to the commission billing. |
| »»» commissionProducerId | integer(int32)|null | false | none | The identifier for the producer responsible for the commission. |
| »»» commissionRate | number(decimal)|null | false | none | The rate of the commission. |
| »»» annualCommission | number(decimal)|null | false | none | The total annual commission for the policy. |
| »»» isPremiumCalculated | boolean | false | none | The flag to toggle calculated premium |
| »»» billingVendorSourceId | string|null | false | none | Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1). |
| »»» billingVendorSourceType | string|null | false | none | Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1). |
| »»» billingVendorSourceEntityName | string|null | false | none | Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1). |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» policyId | integer(int32) | true | none | The identifier for the policy that is tied to the commission billing record. Has a dependency on a policy item. Please use the policy endpoint for reference. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» id | integer(int32) | false | none | The unique Zywave identifier for the commission billing. |
| »»» updatedDateTimeOffSet | string(date-time) | false | none | The record of when the commission billing was last updated. |
| »»» updatedUserProfileId | string|null | false | none | The unique Zywave identifier for the user that last updated the commission billing. |
| »»» updatedUserProfileTypeCode | string|null | false | none | The Zywave identifier for the user type that last updated the commission billing. |
| »»» billingVendorId | integer(int32)|null | false | read-only | Denotes the Zywave ID of the billing vendor. |
| Property | Value |
|---|---|
| commissionType | Annual |
| commissionType | Unspecified |
POST /policies/v2.0/policies/{policyId}/commissionbillings
Creates a commission billing for a policy.
Commission billing has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | CommissionBillingBaseInfo | true | The commission billing to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the ID of the created commission billing. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/commissionperiods/{id}
Gets a CommissionPeriodInfo record by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The commission period id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"description": "Represents a commission period. ",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The id of the commission period record.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 result with the object. | CommissionPeriod |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/commissionperiods
Gets all of the CommissionPeriodInfo records for a policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"description": "Represents a commission period. ",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The id of the commission period record.",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 result with an array of objects. | Inline |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | CommissionPeriodInfo | false | none | Information used when creating or updating a CommissionPeriod. All values are required when used for creation. |
| »» commissionCalculationStrategy | CommissionCalculationStrategyOption|null | false | none | The commission calculation method (e.g. "Percentage" or "Flat"). |
| »» commissionRoundingStrategy | CommissionRoundingStrategyOption|null | false | none | The rounding method to use. |
| »» startDateTimeOffset | string(date-time)|null | false | none | The start date for the commission period. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | Represents a commission period. |
| »» id | integer(int32) | false | none | The id of the commission period record. |
| Property | Value |
|---|---|
| commissionCalculationStrategy | Percentage |
| commissionCalculationStrategy | Flat |
| commissionRoundingStrategy | HouseWins |
POST /policies/v2.0/policies/{policyId}/commissionperiods
Creates, updated, or deletes a Commission Period for a policy based on the auditInfo.
auditInfo Delta follows the following validation rules
| Action | Id | Info |
|---|---|---|
| Create | Never | Always |
| Update | Always | Always |
| Delete | Always | Never |
Body parameter
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"entityAction"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Required for Update and Delete. It is invalid to provide an id for a Create.",
"format": "int32",
"nullable": true
},
"entityAction": {
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
},
"info": {
"description": "The information used to create or update an entity. It is invalid to provide this for a Delete.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
]
}
}
},
{
"type": "object",
"description": "Audit info for commission period",
"additionalProperties": false
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | CommissionPeriodAuditInfo | true | The info used to create or update. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Either 201 for a CREATE message or a 204 for an UPDATE or DELETE message. | integer |
| 204 | No Content | Either 201 for a CREATE message or a 204 for an UPDATE or DELETE message. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/commissionperiods/{commissionPeriodId}/commissionsplits/{id}
Gets the commission split payee record by id for a commission period in a policy.
Commission Split is dependent on Commission Period.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| commissionPeriodId | path | integer(int32) | true | The commission period id. |
| id | path | integer(int32) | true | The commission split id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
},
{
"type": "object",
"description": "A commission split record",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The id of the commission split.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK with CommissionSplit payload containing the payee data. | CommissionSplit |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/commissionperiods/{commissionPeriodId}/commissionsplits
Gets the commission split payee records for a commission period in a policy.
Commission Split is dependent on Commission Period.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| commissionPeriodId | path | integer(int32) | true | The commission period id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
},
{
"type": "object",
"description": "A commission split record",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The id of the commission split.",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK with an IEnumerable`1 of CommissionSplit payload containing the payee data. | Inline |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | CommissionSplitInfo | false | none | Commission Split info |
| »» payeeId | string|null | false | none | The id for the payee. Example: "5003000000D8cuIQAA". This id is intended for use by a caller in conjunction with the values in the PayeeIdSource* properties. Uniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple. NOTE TO IMPLEMENTERS: If your source system potentially has multiple "versions" of the same ID (e.g. Salesforce which offers both 15-character and 18-character IDs), it is your responsibility to consistently use the same "version". |
| »» payeeIdSourceType | string|null | false | none | The source type of the id used for the payee. Example: "Salesforce". This id is intended for use by a caller in conjunction with the values in the PayeeIdSource* properties. Uniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple. |
| »» payeeIdSourceEntityName | string|null | false | none | The name of the source entity of the id used for the payee. Example: "Contact". This id is intended for use by a caller in conjunction with the values in the PayeeIdSource* properties. Uniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple. |
| »» commissionPeriodId | integer(int32)|null | false | none | The id of the CommissionPeriod that is the parent of this record. CommissionSplit is dependent on CommissionPeriod. |
| »» amount | number(decimal)|null | false | none | The amount to be paid to the payee. The amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy. Only two(2) significant decimal places are supported. |
| »» generation | integer(int32)|null | false | none | Indicates the "generation" in which the payee's payment amount is calculated. Payments within a period are calculated by "generation": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated. This allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount. Generation zero(0) is recommended for internal producers. It is recommended that "space" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | A commission split record |
| »» id | integer(int32) | false | none | The id of the commission split. |
POST /policies/v2.0/policies/{policyId}/commissionperiods/{commissionPeriodId}/commissionsplits
Creates, updated, or deletes a Commission Split for a policy based on the auditInfo.
auditInfo Delta follows the following validation rules
| Action | Id | Info |
|---|---|---|
| Create | Never | Always |
| Update | Always | Always |
| Delete | Always | Never |
Body parameter
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"entityAction"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Required for Update and Delete. It is invalid to provide an id for a Create.",
"format": "int32",
"nullable": true
},
"entityAction": {
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
},
"info": {
"description": "The information used to create or update an entity. It is invalid to provide this for a Delete.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
}
]
}
}
}
]
}
}
},
{
"type": "object",
"description": "Audit info for commission split",
"additionalProperties": false
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| commissionPeriodId | path | integer(int32) | true | The commission period id. |
| body | body | CommissionSplitAuditInfo | true | The info used to create or update. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Either 201 for a CREATE message or a 204 for an UPDATE or DELETE message. | integer |
| 204 | No Content | Either 201 for a CREATE message or a 204 for an UPDATE or DELETE message. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{id}/contributions
Gets the contributions for the policy.
Contribution is influenced by Contribution Strategy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "object",
"description": "The contribution strategy and records for the policy.",
"additionalProperties": false,
"properties": {
"contributionStrategy": {
"description": "The contribution strategy.",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"calculationStrategy",
"roundingStrategy"
],
"properties": {
"calculationStrategy": {
"description": "The strategy used for calculating monthly contributions.",
"default": "EmployerDollars",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
],
"enum": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
]
}
]
},
"roundingStrategy": {
"description": "The strategy used for rounding.",
"default": "RoundDownEmployee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"RoundDownEmployer",
"RoundDownEmployee"
],
"enum": [
"RoundDownEmployer",
"RoundDownEmployee"
]
}
]
}
}
}
]
},
"contributionRecords": {
"type": "array",
"description": "The contribution records.",
"items": {
"type": "object",
"description": "The contribution record data returned to the caller.",
"additionalProperties": false,
"properties": {
"contributionTier": {
"description": "The contribution tier.",
"default": "Employee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"rateTotal": {
"type": "number",
"description": "The monthly total for rate tier (Employer $ + Employee $).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"strategyAmount": {
"type": "number",
"description": "The percent or dollar amount used in calculations. E.g. 30% (a percentage strategy) or $541.32 (a dollars strategy).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeeDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeePercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerPercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the contribution records and strategy for the policy. | ContributionRecordsWithStrategy |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/contributions/{contributionTier}
Inserts or updates a contribution record.
Contribution is influenced by Contribution Strategy.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"strategyAmount",
"rateTotal"
],
"properties": {
"strategyAmount": {
"type": "number",
"description": "The eployee/employer percentage/dollars.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"rateTotal": {
"type": "number",
"description": "The total for the contribution tier (employer $ + employee $).",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| contributionTier | path | ContributionTierOption | true | The contribution tier. |
| body | body | ContributionInfo | true | The ContributionInfo. |
| Parameter | Value |
|---|---|
| contributionTier | Employee |
| contributionTier | EmployeeSpouse |
| contributionTier | EmployeeChildren |
| contributionTier | EmployeeFamily |
| contributionTier | EmployeeChild |
| contributionTier | EmployeeSpouseChild |
| contributionTier | EmployeeTwoChildren |
| contributionTier | EmployeeThreeChildren |
Example responses
200 Response
{
"type": "object",
"description": "The contribution record data returned to the caller.",
"additionalProperties": false,
"properties": {
"contributionTier": {
"description": "The contribution tier.",
"default": "Employee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"rateTotal": {
"type": "number",
"description": "The monthly total for rate tier (Employer $ + Employee $).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"strategyAmount": {
"type": "number",
"description": "The percent or dollar amount used in calculations. E.g. 30% (a percentage strategy) or $541.32 (a dollars strategy).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeeDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeePercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerPercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Either a 200 OK (for an update) or a 201 Created (for an insert) with a ContributionRecord payload containing the computed contributions in dollars for employer and employee. | ContributionRecord |
| 201 | Created | Either a 200 OK (for an update) or a 201 Created (for an insert) with a ContributionRecord payload containing the computed contributions in dollars for employer and employee. | ContributionRecord |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{id}/contributions/{contributionTier}
Deletes a contribution record.
Contribution is influenced by Contribution Strategy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| contributionTier | path | ContributionTierOption | true | The contribution tier. |
| Parameter | Value |
|---|---|
| contributionTier | Employee |
| contributionTier | EmployeeSpouse |
| contributionTier | EmployeeChildren |
| contributionTier | EmployeeFamily |
| contributionTier | EmployeeChild |
| contributionTier | EmployeeSpouseChild |
| contributionTier | EmployeeTwoChildren |
| contributionTier | EmployeeThreeChildren |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/contributionstrategies
Inserts or updates a contribution strategy.
Contribution is influenced by Contribution Strategy.
Body parameter
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"calculationStrategy",
"roundingStrategy"
],
"properties": {
"calculationStrategy": {
"description": "The strategy used for calculating monthly contributions.",
"default": "EmployerDollars",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
],
"enum": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
]
}
]
},
"roundingStrategy": {
"description": "The strategy used for rounding.",
"default": "RoundDownEmployee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"RoundDownEmployer",
"RoundDownEmployee"
],
"enum": [
"RoundDownEmployer",
"RoundDownEmployee"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"shouldKeepContributionRecords": {
"type": "boolean",
"description": "Indicates if changing the strategy should or should not keep the existing contribution records.",
"default": false,
"nullable": true
}
}
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| body | body | ContributionStrategyUpdateInfo | true | The ContributionStrategyUpdateInfo. |
Example responses
400 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 204 NoContent result for an update or a 201 Created for an insert. | None |
| 204 | No Content | A 204 NoContent result for an update or a 201 Created for an insert. | None |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/coveragetypes/{id}
Returns the coverage type for the coverage type id specified.
Coverage types describe the type of coverages within an insurance category. Each coverage type drills down to more specific policy coverage types. Below shows an example of the insurance category, coverage type, and policy coverage type relationship.
| InsuranceCategory | CoverageType | PolicyCoverageType |
|-------------------|--------------------|--------------------|
| Benefits | Dental | Dental |
| Benefits | Worksite/Voluntary | Critical Illness |
| Benefits | Worksite/Voluntary | Accident |
| Benefits | Worksite/Voluntary | Pet Insurance |
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The coverage type id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"insuranceCategory"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the coverage type.",
"maxLength": 50,
"minLength": 1
},
"insuranceCategory": {
"description": "The category of insurance that this coverage type belongs. Ex. Benefits / Property",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PropertyCasualty"
],
"enum": [
"Benefits",
"PropertyCasualty"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the coverage type.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | CoverageType |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/coveragetypes
Returns list of coverage types.
Coverage types describe the type of coverages within an insurance category. Each coverage type drills down to more specific policy coverage types. Below shows an example of the insurance category, coverage type, and policy coverage type relationship.
| InsuranceCategory | CoverageType | PolicyCoverageType |
|-------------------|--------------------|--------------------|
| Benefits | Dental | Dental |
| Benefits | Worksite/Voluntary | Critical Illness |
| Benefits | Worksite/Voluntary | Accident |
| Benefits | Worksite/Voluntary | Pet Insurance |
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"insuranceCategory"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the coverage type.",
"maxLength": 50,
"minLength": 1
},
"insuranceCategory": {
"description": "The category of insurance that this coverage type belongs. Ex. Benefits / Property",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PropertyCasualty"
],
"enum": [
"Benefits",
"PropertyCasualty"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the coverage type.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfCoverageType |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/departments/{id}
Gets a department by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The department id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the department.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Department |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /policies/v2.0/departments/{id}
Deletes the department information associated with the department id specified.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the department to delete. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/departments/{id}
Updates the existing department information for the department id specified.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the department to update |
| body | body | DepartmentInfo | true | The information to update on the department. |
Example responses
400 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/departments
Search for department.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the department.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfDepartment |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
POST /policies/v2.0/departments
Creates a department for the agency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | DepartmentInfo | true | The department to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the id of the created department. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
POST /policies/v2.0/policies/{policyId}/eligibilities
Creates an eligibility record for the policy.
Body parameter
{
"type": "object",
"description": "Eligibility information for a policy.",
"additionalProperties": false,
"properties": {
"employeeGroup": {
"description": "The employee group or groups to which this eligibility information applies.\n\nThis value can be a bit mask of EmployeeGroupOptions values. ",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
]
},
"hours": {
"type": "integer",
"description": "The minimum weekly hours required for eligibility.",
"format": "int32",
"maximum": 40,
"minimum": 0,
"nullable": true
},
"waitingPeriod": {
"description": "The waiting period between hire date and first coverage.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
]
},
"waitingPeriodAmount": {
"type": "integer",
"description": "The waiting period amount (days/months) used as needed with the WaitingPeriod.",
"format": "int32",
"maximum": 365,
"minimum": 0,
"nullable": true
},
"domesticPartnerCoverage": {
"type": "boolean",
"description": "Indicates if domestic partners are covered by the policy.",
"nullable": true
},
"coverageTermination": {
"description": "The coverage termination relative to employment termination.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
]
},
"description": {
"type": "string",
"description": "The description of the eligibility coverage information.",
"maxLength": 500,
"nullable": true
},
"spouseCoverage": {
"type": "boolean",
"description": "Indicates if spouse is covered by the policy.",
"nullable": true
},
"dependentCoverage": {
"type": "boolean",
"description": "Indicates if dependent or child is covered by the policy.",
"nullable": true
},
"otherCoverage": {
"type": "boolean",
"description": "Indicates if there is anything other covered by the policy.",
"nullable": true
},
"otherCoverageDescription": {
"type": "string",
"description": "The description of the other coverage information.",
"maxLength": 100,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | EligibilityInfo | true | The EligibilityInfo used to create a new record. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 CREATED with the id of the new record. | integer |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/eligibilities
Gets all of the Eligibility records for a policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Eligibility information for a policy.",
"additionalProperties": false,
"properties": {
"employeeGroup": {
"description": "The employee group or groups to which this eligibility information applies.\n\nThis value can be a bit mask of EmployeeGroupOptions values. ",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
]
},
"hours": {
"type": "integer",
"description": "The minimum weekly hours required for eligibility.",
"format": "int32",
"maximum": 40,
"minimum": 0,
"nullable": true
},
"waitingPeriod": {
"description": "The waiting period between hire date and first coverage.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
]
},
"waitingPeriodAmount": {
"type": "integer",
"description": "The waiting period amount (days/months) used as needed with the WaitingPeriod.",
"format": "int32",
"maximum": 365,
"minimum": 0,
"nullable": true
},
"domesticPartnerCoverage": {
"type": "boolean",
"description": "Indicates if domestic partners are covered by the policy.",
"nullable": true
},
"coverageTermination": {
"description": "The coverage termination relative to employment termination.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
]
},
"description": {
"type": "string",
"description": "The description of the eligibility coverage information.",
"maxLength": 500,
"nullable": true
},
"spouseCoverage": {
"type": "boolean",
"description": "Indicates if spouse is covered by the policy.",
"nullable": true
},
"dependentCoverage": {
"type": "boolean",
"description": "Indicates if dependent or child is covered by the policy.",
"nullable": true
},
"otherCoverage": {
"type": "boolean",
"description": "Indicates if there is anything other covered by the policy.",
"nullable": true
},
"otherCoverageDescription": {
"type": "string",
"description": "The description of the other coverage information.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "The Eligibility for the policy.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The ID of the eligibility record.",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with an array of Eligibility records. | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | EligibilityInfo | false | none | Eligibility information for a policy. |
| »» employeeGroup | EmployeeGroupOptions|null | false | none | The employee group or groups to which this eligibility information applies. This value can be a bit mask of EmployeeGroupOptions values. |
| »» hours | integer(int32)|null | false | none | The minimum weekly hours required for eligibility. |
| »» waitingPeriod | WaitingPeriodOption|null | false | none | The waiting period between hire date and first coverage. |
| »» waitingPeriodAmount | integer(int32)|null | false | none | The waiting period amount (days/months) used as needed with the WaitingPeriod. |
| »» domesticPartnerCoverage | boolean|null | false | none | Indicates if domestic partners are covered by the policy. |
| »» coverageTermination | CoverageTerminationOption|null | false | none | The coverage termination relative to employment termination. |
| »» description | string|null | false | none | The description of the eligibility coverage information. |
| »» spouseCoverage | boolean|null | false | none | Indicates if spouse is covered by the policy. |
| »» dependentCoverage | boolean|null | false | none | Indicates if dependent or child is covered by the policy. |
| »» otherCoverage | boolean|null | false | none | Indicates if there is anything other covered by the policy. |
| »» otherCoverageDescription | string|null | false | none | The description of the other coverage information. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | The Eligibility for the policy. |
| »» id | integer(int32) | false | none | The ID of the eligibility record. |
| Property | Value |
|---|---|
| employeeGroup | None |
| employeeGroup | Salaried |
| employeeGroup | NonSalaried |
| employeeGroup | Management |
| employeeGroup | Union |
| employeeGroup | FullTime |
| employeeGroup | All |
| waitingPeriod | DateOfHire |
| waitingPeriod | NDaysAfterDateOfHire |
| waitingPeriod | NMonthsAfterDateOfHire |
| waitingPeriod | FirstOfMonthAfterDateOfHire |
| waitingPeriod | FirstOfMonthAfterNDaysAfterDateOfHire |
| waitingPeriod | FirstOfMonthAfterNMonthsAfterDateOfHire |
| waitingPeriod | FifteenthOfMonthAfterNDaysAfterDateOfHire |
| waitingPeriod | FifteenthOfMonthAfterNMonthsAfterDateOfHire |
| coverageTermination | Immediate |
| coverageTermination | LastDayOfMonth |
| coverageTermination | ThirtyDaysAfter |
| coverageTermination | FifteenthOfMonth |
DELETE /policies/v2.0/policies/{policyId}/eligibilities/{id}
Deletes an eligibility record by id for a policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | the id of the eligibility record. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/eligibilities/{id}
Gets an Eligibility record for a policy by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the eligibility record. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Eligibility information for a policy.",
"additionalProperties": false,
"properties": {
"employeeGroup": {
"description": "The employee group or groups to which this eligibility information applies.\n\nThis value can be a bit mask of EmployeeGroupOptions values. ",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
]
},
"hours": {
"type": "integer",
"description": "The minimum weekly hours required for eligibility.",
"format": "int32",
"maximum": 40,
"minimum": 0,
"nullable": true
},
"waitingPeriod": {
"description": "The waiting period between hire date and first coverage.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
]
},
"waitingPeriodAmount": {
"type": "integer",
"description": "The waiting period amount (days/months) used as needed with the WaitingPeriod.",
"format": "int32",
"maximum": 365,
"minimum": 0,
"nullable": true
},
"domesticPartnerCoverage": {
"type": "boolean",
"description": "Indicates if domestic partners are covered by the policy.",
"nullable": true
},
"coverageTermination": {
"description": "The coverage termination relative to employment termination.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
]
},
"description": {
"type": "string",
"description": "The description of the eligibility coverage information.",
"maxLength": 500,
"nullable": true
},
"spouseCoverage": {
"type": "boolean",
"description": "Indicates if spouse is covered by the policy.",
"nullable": true
},
"dependentCoverage": {
"type": "boolean",
"description": "Indicates if dependent or child is covered by the policy.",
"nullable": true
},
"otherCoverage": {
"type": "boolean",
"description": "Indicates if there is anything other covered by the policy.",
"nullable": true
},
"otherCoverageDescription": {
"type": "string",
"description": "The description of the other coverage information.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "The Eligibility for the policy.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The ID of the eligibility record.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the Eligibility record. | Eligibility |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/eligibilities/{id}
Updates an eligibility record for a policy.
Body parameter
{
"type": "object",
"description": "Eligibility information for a policy.",
"additionalProperties": false,
"properties": {
"employeeGroup": {
"description": "The employee group or groups to which this eligibility information applies.\n\nThis value can be a bit mask of EmployeeGroupOptions values. ",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
]
},
"hours": {
"type": "integer",
"description": "The minimum weekly hours required for eligibility.",
"format": "int32",
"maximum": 40,
"minimum": 0,
"nullable": true
},
"waitingPeriod": {
"description": "The waiting period between hire date and first coverage.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
]
},
"waitingPeriodAmount": {
"type": "integer",
"description": "The waiting period amount (days/months) used as needed with the WaitingPeriod.",
"format": "int32",
"maximum": 365,
"minimum": 0,
"nullable": true
},
"domesticPartnerCoverage": {
"type": "boolean",
"description": "Indicates if domestic partners are covered by the policy.",
"nullable": true
},
"coverageTermination": {
"description": "The coverage termination relative to employment termination.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
]
},
"description": {
"type": "string",
"description": "The description of the eligibility coverage information.",
"maxLength": 500,
"nullable": true
},
"spouseCoverage": {
"type": "boolean",
"description": "Indicates if spouse is covered by the policy.",
"nullable": true
},
"dependentCoverage": {
"type": "boolean",
"description": "Indicates if dependent or child is covered by the policy.",
"nullable": true
},
"otherCoverage": {
"type": "boolean",
"description": "Indicates if there is anything other covered by the policy.",
"nullable": true
},
"otherCoverageDescription": {
"type": "string",
"description": "The description of the other coverage information.",
"maxLength": 100,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the eligibility record. |
| body | body | EligibilityInfo | true | The EligibilityInfo. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/fees/{id}
Deletes a fee.
Fee has a dependency on fee type.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The fee id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/fees/{id}
Gets a fee.
Fee has a dependency on fee type.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The fee id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Fee info",
"additionalProperties": false,
"required": [
"feeTypeId",
"frequency"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount",
"format": "decimal",
"maximum": 999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"count": {
"type": "integer",
"description": "The count",
"format": "int32",
"maximum": 999999,
"minimum": 0,
"nullable": true
},
"feeTypeId": {
"type": "integer",
"description": "The unique identifier of the FeeType",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"frequency": {
"description": "The FrequencyOption",
"default": "Annually",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
]
},
"policyId": {
"type": "integer",
"description": "Gets or sets the policy id",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"description": "A fee record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fee",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the fee. | Fee |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/fees/{id}
Updates a fee for a policy.
Fee has a dependency on fee type.
Body parameter
{
"type": "object",
"description": "Fee info",
"additionalProperties": false,
"required": [
"feeTypeId",
"frequency"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount",
"format": "decimal",
"maximum": 999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"count": {
"type": "integer",
"description": "The count",
"format": "int32",
"maximum": 999999,
"minimum": 0,
"nullable": true
},
"feeTypeId": {
"type": "integer",
"description": "The unique identifier of the FeeType",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"frequency": {
"description": "The FrequencyOption",
"default": "Annually",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
]
},
"policyId": {
"type": "integer",
"description": "Gets or sets the policy id",
"format": "int32",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The fee id. |
| body | body | FeeInfo | true | The fee info used for the update of a fee type record. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /policies/v2.0/policies/{policyId}/fees
Creates a fee for a policy.
Fee has a dependency on fee type.
Body parameter
{
"type": "object",
"description": "Fee info",
"additionalProperties": false,
"required": [
"feeTypeId",
"frequency"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount",
"format": "decimal",
"maximum": 999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"count": {
"type": "integer",
"description": "The count",
"format": "int32",
"maximum": 999999,
"minimum": 0,
"nullable": true
},
"feeTypeId": {
"type": "integer",
"description": "The unique identifier of the FeeType",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"frequency": {
"description": "The FrequencyOption",
"default": "Annually",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
]
},
"policyId": {
"type": "integer",
"description": "Gets or sets the policy id",
"format": "int32",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | FeeInfo | true | The fee info used for the creation of a fee record. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 CREATED response with the fee. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/fees
Returns a list of fee information for the policy.
Fee has a dependency on fee type.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Fee info",
"additionalProperties": false,
"required": [
"feeTypeId",
"frequency"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount",
"format": "decimal",
"maximum": 999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"count": {
"type": "integer",
"description": "The count",
"format": "int32",
"maximum": 999999,
"minimum": 0,
"nullable": true
},
"feeTypeId": {
"type": "integer",
"description": "The unique identifier of the FeeType",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"frequency": {
"description": "The FrequencyOption",
"default": "Annually",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
]
},
"policyId": {
"type": "integer",
"description": "Gets or sets the policy id",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"description": "A fee record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fee",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | FeeInfo | false | none | Fee info |
| »» amount | number(decimal)|null | false | none | The amount |
| »» count | integer(int32)|null | false | none | The count |
| »» feeTypeId | integer(int32) | true | none | The unique identifier of the FeeType |
| »» frequency | FrequencyOption | true | none | The FrequencyOption |
| »» policyId | integer(int32)|null | false | none | Gets or sets the policy id |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | A fee record |
| »» id | integer(int32) | true | none | The unique Zywave identifier for the fee |
| Property | Value |
|---|---|
| frequency | None |
| frequency | Annually |
| frequency | Monthly |
DELETE /policies/v2.0/feetypes/{id}
Deletes a fee type.
Fee has a dependency on fee type.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The fee type id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/feetypes/{id}
Gets a fee type.
Fee has a dependency on fee type.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The fee type id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the fee type. | FeeType |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/feetypes/{id}
Updates a fee type.
Fee has a dependency on fee type.
Body parameter
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The fee type id. |
| body | body | FeeTypeInfo | true | The fee type info used for the update of a fee type record. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /policies/v2.0/feetypes
Creates a fee type.
Fee has a dependency on fee type.
Body parameter
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | FeeTypeInfo | true | The fee type info used for the creation of a fee type record. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 CREATED response with the fee type. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/feetypes
Returns list of fee type information.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfFeeType |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/fixedrates/{id}
Deletes the fixed rate information associated with the fixed rate id specified.
Fixed rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The ID of the policy for which all fixed rates are to be deleted. |
| id | path | integer(int32) | true | The id of the fixed rate to delete. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/fixedrates/{id}
Returns the fixed rate information for the fixed rate id specified.
Fixed rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The fixed rate id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"annualRate": {
"type": "number",
"readOnly": true,
"description": "The _calculated_ annual rate.\n ",
"format": "decimal"
},
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fixed rate.\n ",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | FixedRate |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/fixedrates/{id}
Updates the existing fixed rate information for the fixed rate id specified.
Fixed rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the fixed rate to update |
| body | body | FixedRateBaseInfo | true | The information to update on the fixed rate. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"annualRate": {
"type": "number",
"readOnly": true,
"description": "The _calculated_ annual rate.\n ",
"format": "decimal"
},
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fixed rate.\n ",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The FixedRate with a calculated annual rate. | FixedRate |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /policies/v2.0/policies/{policyId}/fixedrates
Creates a fixed rate for a policy.
Fixed rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | FixedRateBaseInfo | true | The fixed rate to create. |
Example responses
201 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"annualRate": {
"type": "number",
"readOnly": true,
"description": "The _calculated_ annual rate.\n ",
"format": "decimal"
},
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fixed rate.\n ",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response with the FixedRate with the calculated annual rate. | FixedRate |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/fixedrates
Returns list of fixed rate information for the policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"annualRate": {
"type": "number",
"readOnly": true,
"description": "The _calculated_ annual rate.\n ",
"format": "decimal"
},
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fixed rate.\n ",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | FixedRateBaseInfo | false | none | none |
| »»» rate | number(decimal)|null | false | none | The rate for the fixed rate. |
| »»» frequency | FixedRateFrequencyOption | true | none | The frequency of the Rate. |
| »»» employeeCount | integer(int32)|null | false | none | The employee count. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» policyId | integer(int32) | true | none | The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
| »»» annualRate | number(decimal) | false | read-only | The calculated annual rate. |
| »»» id | integer(int32) | false | none | The unique Zywave identifier for the fixed rate. |
| Property | Value |
|---|---|
| frequency | AnnuallyOrOneTime |
| frequency | SemiAnnually |
| frequency | Quarterly |
| frequency | BiMonthly |
| frequency | Monthly |
| frequency | SemiMonthly |
| frequency | BiWeekly |
| frequency | Weekly |
| frequency | PerEmployeePerMonth |
| frequency | PerEmployeePerYear |
GET /policies/v2.0/insuredpaymentschedules/{id}
Gets an insured payment schedule by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The insured payment schedule id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the insured payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32",
"maximum": 2147483647,
"minimum": 0
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the insured payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the insured payment schedule.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | InsuredPaymentSchedule |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/insuredpaymentschedules
Search for an insured payment schedule.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the insured payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32",
"maximum": 2147483647,
"minimum": 0
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the insured payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the insured payment schedule.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfInsuredPaymentSchedule |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{id}
Deletes the policy associated with the policy id.
Policy has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The ID of the policy to delete. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{id}
Returns the policy information for the policy id specified.
Policy has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy.",
"format": "int32"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the policy.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the policy.",
"nullable": true
},
"createdDateTimeOffset": {
"type": "string",
"description": "The record of when the policy was created.",
"format": "date-time"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the policy was last updated.",
"format": "date-time"
},
"renewedByPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that renews this policy.\n \nIf this property has a value, the Policy is NOT renewable.",
"format": "int32",
"nullable": true
},
"renewedFromPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that is the predecessor of this policy.",
"format": "int32",
"nullable": true
},
"vendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the vendor.",
"format": "int32",
"nullable": true
},
"isEndingStatusRetained": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the ending status has the base status of Retained."
},
"isActive": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is active."
},
"isCancelled": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is cancelled."
},
"isExpired": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is expired."
},
"isFuture": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is future."
},
"isPendingCancellation": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending cancellation."
},
"isPendingReinstatement": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending reinstatement."
},
"isReinstated": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is reinstated."
},
"isRenewed": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is renewed."
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Policy |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}
Updates the existing policy information for the policy id specified.
Policy has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The ID of the policy to update |
| body | body | PolicyInfo | true | The information to update on the policy. |
Example responses
400 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies
Returns list of policy information for all policies.
Policy has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency. The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy.",
"format": "int32"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the policy.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the policy.",
"nullable": true
},
"createdDateTimeOffset": {
"type": "string",
"description": "The record of when the policy was created.",
"format": "date-time"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the policy was last updated.",
"format": "date-time"
},
"renewedByPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that renews this policy.\n \nIf this property has a value, the Policy is NOT renewable.",
"format": "int32",
"nullable": true
},
"renewedFromPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that is the predecessor of this policy.",
"format": "int32",
"nullable": true
},
"vendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the vendor.",
"format": "int32",
"nullable": true
},
"isEndingStatusRetained": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the ending status has the base status of Retained."
},
"isActive": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is active."
},
"isCancelled": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is cancelled."
},
"isExpired": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is expired."
},
"isFuture": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is future."
},
"isPendingCancellation": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending cancellation."
},
"isPendingReinstatement": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending reinstatement."
},
"isReinstated": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is reinstated."
},
"isRenewed": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is renewed."
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfPolicy |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
POST /policies/v2.0/policies
Creates a policy.
Policy has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PolicyInfo | true | The policy to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the ID of the created policy. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Operations that can be performed on a policy: e.g. renew, cancel.
PUT /policies/v2.0/policies/{id}/reinstate
Reinstates the policy.
NOTE: Reinstatement removes policy ending status.
Body parameter
{
"type": "object",
"description": "The policy reinstate information.",
"additionalProperties": false,
"required": [
"reinstatementDate"
],
"properties": {
"reinstatementDate": {
"type": "string",
"description": "The reinstatement date.",
"format": "date-time"
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| body | body | PolicyReinstateInfo | true | The policy reinstate information. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/cancel
Cancels the policy.
NOTE: Cancellation removes reinstatement data.
Body parameter
{
"type": "object",
"description": "The policy cancel information.",
"additionalProperties": false,
"required": [
"cancellationDate",
"endingPolicyStatusId"
],
"properties": {
"cancellationDate": {
"type": "string",
"description": "The cancellation date.",
"format": "date-time"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The ending policy status id.\nUse GET policystatus to search for allowed values.\nThe ending policy status id must have base type \"Lost\".",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
| body | body | PolicyCancelInfo | true | The policy cancel information. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/undocancel
Undoes the cancellation of a policy.
NOTE: Undo cancellation will not work on reinstated policies.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy id. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /policies/v2.0/policies/{id}/renew
Renews the policy.
Conceptually, renewal is a deep copy of the object graph of the source policy with some values replaced by parameters supplied here and others overwritten with defaults.
NOTE: Renewal does not copy reinstatement and cancellation data from the old policy to the new policy.
Body parameter
{
"type": "object",
"description": "The renewal information for a policy.",
"additionalProperties": false,
"required": [
"beginningPolicyStatusId"
],
"properties": {
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the new policy becomes effective.",
"format": "date-time",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "The date that the new policy expires.",
"format": "date-time",
"nullable": true
},
"policyId": {
"type": "integer",
"description": "The id for the policy to renew. ",
"format": "int32"
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company id for the new policy. If left blank will use the old policy for new.",
"format": "int32",
"nullable": true
},
"userPrincipalId": {
"type": "string",
"description": "Gets or sets the user principal id.",
"format": "guid"
},
"userProfileTypeCode": {
"type": "string",
"description": "Gets or sets the user profile type code.",
"maxLength": 4,
"nullable": true
},
"userProfileId": {
"type": "string",
"description": "Gets or sets the user profile id.",
"maxLength": 36,
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The policy number for the new policy. If left blank will use the old policy for new.",
"maxLength": 75,
"nullable": true
},
"billingCarrierCompanyId": {
"type": "integer",
"description": "The billing carrier company id.\n\nIf missing, the value for billing carrier company is copied from the source policy.\n\nNOTE: simply setting the value for the carrier company underwriting the policy does NOT update this property.\nIt is recommended that callers *always* set this value when renewing.",
"format": "int32",
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Indicates if the new policy should be marked as needing review.\nIf this property is null/missing, the value of the flag from the source policy is carried into the new policy.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "The id of the policy group to add the renewed policy to.\nIf the policy group does not exist, the renewed policy will not be added to any group.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"policyVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor for the new policy (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"policyVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor for the new policy (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"policyVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor for the new policy (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the policy to renew. |
| body | body | RenewPolicyInfo | true | The policy renewal information. |
Example responses
201 Response
{
"type": "string"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response with a URL to the new policy. | string |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/setneedsreview
Sets a policy as needing review
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the policy to set as needing review. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{id}/clearneedsreview
Clears the needs review flag on a policy
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the policy to clear the needs reviewed flag on. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policycoveragetypes/{id}
Returns the policy coverage type for the policy coverage type id specified.
Policy coverage type has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency. Policy coverage types describe the type of coverage a policy provides. Each policy coverage type belongs to an even broader coverage type, and each coverage type belongs to an even broader insurance category. Below shows an example of the insurance category, coverage type, and policy coverage type relationship.
| InsuranceCategory | CoverageType | PolicyCoverageType |
|-------------------|--------------------|--------------------|
| Benefits | Dental | Dental |
| Benefits | Worksite/Voluntary | Critical Illness |
| Benefits | Worksite/Voluntary | Accident |
| Benefits | Worksite/Voluntary | Pet Insurance |
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy coverage group id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"coverageTypeId",
"description"
],
"properties": {
"coverageTypeId": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the policy coverage type.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy coverage type is archived.",
"default": false
},
"acordCode": {
"type": "string",
"description": "Gets or sets the value of the ACORD line of business code",
"maxLength": 5,
"minLength": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PolicyCoverageType |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policycoveragetypes
Returns list of policy coverage types.
Policy coverage type has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency. Policy coverage types describe the type of coverage a policy provides. Each policy coverage type belongs to an even broader coverage type, and each coverage type belongs to an even broader insurance category. Below shows an example of the insurance category, coverage type, and policy coverage type relationship.
| InsuranceCategory | CoverageType | PolicyCoverageType |
|-------------------|--------------------|--------------------|
| Benefits | Dental | Dental |
| Benefits | Worksite/Voluntary | Critical Illness |
| Benefits | Worksite/Voluntary | Accident |
| Benefits | Worksite/Voluntary | Pet Insurance |
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"coverageTypeId",
"description"
],
"properties": {
"coverageTypeId": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the policy coverage type.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy coverage type is archived.",
"default": false
},
"acordCode": {
"type": "string",
"description": "Gets or sets the value of the ACORD line of business code",
"maxLength": 5,
"minLength": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfPolicyCoverageType |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/preferredpolicycoveragetypes
Returns list of preferred policy coverage types (if they exist, otherwise the default list)
Policy coverage type has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency. Policy coverage types describe the type of coverage a policy provides. Each policy coverage type belongs to an even broader coverage type, and each coverage type belongs to an even broader insurance category. Below shows an example of the insurance category, coverage type, and policy coverage type relationship.
| InsuranceCategory | CoverageType | PolicyCoverageType |
|-------------------|--------------------|--------------------|
| Benefits | Dental | Dental |
| Benefits | Worksite/Voluntary | Critical Illness |
| Benefits | Worksite/Voluntary | Accident |
| Benefits | Worksite/Voluntary | Pet Insurance |
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"coverageTypeId",
"description"
],
"properties": {
"coverageTypeId": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the policy coverage type.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy coverage type is archived.",
"default": false
},
"acordCode": {
"type": "string",
"description": "Gets or sets the value of the ACORD line of business code",
"maxLength": 5,
"minLength": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfPolicyCoverageType |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/setgroup/{policyGroupId}
Adds the policy to the corresponding policy group.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy to add to the policy group. |
| policyGroupId | path | integer(int32) | true | The policy group ID to add the policy to. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/cleargroup
Removes the policy from any policy group.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/setasgroupparent
Sets a policy as the parent of the policy group it belongs to.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/clearfromgroupparent
Clears the parent from the policy group
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/grouping
Gets policy group details and members for a policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"members": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
},
"isParent": {
"type": "boolean"
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the policy group details and members. | PolicyGroupWithMembers |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /policies/v2.0/policygroups
Creates a policy group.
Body parameter
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 150,
"minLength": 1
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"accountId"
],
"properties": {
"accountId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PolicyGroupCreateInfo | true | The policy group info used for the creation of a policy group record. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response with the policy group. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policygroups
Returns list of policy group information.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"members": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
},
"isParent": {
"type": "boolean"
}
}
}
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the list of policy group information. | PagedResultOfPolicyGroupWithMembers |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policygroups/{id}
Updates a policy group.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 150,
"minLength": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy group id. |
| body | body | PolicyGroupInfo | true | The policy group info used for the update of a policy group record. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policygroups/{id}
Gets a policy group and list of members.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy group id. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"members": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
},
"isParent": {
"type": "boolean"
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the policy group. | PolicyGroupWithMembers |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /policies/v2.0/policygroups/{id}
Deletes a policy group.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy group id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/policygroups/{id}/setparent/{policyId}
Sets the given policy ID as the parent in the policy group.
The policy must already be part of the group, it will not be added as part of this method.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy group id. |
| policyId | path | integer(int32) | true | The policy id to set as the parent in the group. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policygroups/{id}/clearparent/{policyId}
Clears the given policy ID from being the parent in the policy group.
The policy must already be part of the group, it will not be added as part of this method.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy group id. |
| policyId | path | integer(int32) | true | The policy id to clear from the parent in the group. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 NoContent response | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policystatuses/{id}
Gets a policy status by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The policy status id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"basePolicyStatus",
"policyStatusType"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the policy status.",
"maxLength": 50,
"minLength": 1
},
"basePolicyStatus": {
"description": "The base policy status that this policy status derives from.\nEx. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"New",
"Retained",
"Lost"
],
"enum": [
"New",
"Retained",
"Lost"
]
}
]
},
"policyStatusType": {
"description": "The type of policy status.\nEx. Beginning, Ending",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Beginning",
"Ending"
],
"enum": [
"Beginning",
"Ending"
]
}
]
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy status is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy status.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PolicyStatus |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policystatuses
Search for policy status.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"basePolicyStatus",
"policyStatusType"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the policy status.",
"maxLength": 50,
"minLength": 1
},
"basePolicyStatus": {
"description": "The base policy status that this policy status derives from.\nEx. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"New",
"Retained",
"Lost"
],
"enum": [
"New",
"Retained",
"Lost"
]
}
]
},
"policyStatusType": {
"description": "The type of policy status.\nEx. Beginning, Ending",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Beginning",
"Ending"
],
"enum": [
"Beginning",
"Ending"
]
}
]
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy status is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy status.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfPolicyStatus |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/preferredbenefititems
Returns list of preferred benefit items for the agency (if they exist, otherwise the default list)
Preferred benefit items describe the benefit items an agency has configured as preferred for their policies.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfBenefitItem |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
PUT /policies/v2.0/preferredbenefititems
Sets or unsets a preferred benefit item for the agency.
Use this endpoint to mark a single benefit item as preferred or non-preferred for the agency. Setting IsPreferred to true creates or updates the preferred benefit item record. Setting IsPreferred to false removes the preferred benefit item record if it exists.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"isPreferred"
],
"properties": {
"benefitItemId": {
"type": "integer",
"description": "The unique identifier for the benefit item.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"isPreferred": {
"type": "boolean",
"description": "Whether the benefit item is preferred for the agency."
},
"enrollmentBookletsSync": {
"type": "boolean",
"description": "Whether the benefit item should be synced to enrollment booklets."
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SetPreferredBenefitItemInfo | true | The set preferred benefit item info. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | The updated benefit item. | BenefitItem |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/tieredrates/{id}
Deletes the tiered rate information associated with the tiered rate id specified.
Tiered rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the tiered rate to delete. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/tieredrates/{id}
Returns the tiered rate information for the tiered rate id specified.
Tiered rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The tiered rate id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "Tiered rate info",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the tiered rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"description": "Represents a tiered rate",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the tiered rate.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | TieredRate |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/tieredrates/{id}
Updates the existing tiered rate information for the tiered rate id specified.
Tiered rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the tiered rate to update |
| body | body | TieredRateBaseInfo | true | The information to update on the tiered rate. |
Example responses
400 Response
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/tieredrates
Returns list of tiered rate information for the policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "Tiered rate info",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the tiered rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"description": "Represents a tiered rate",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the tiered rate.",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | any | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | TieredRateBaseInfo | false | none | none |
| »»» rateTierType | RateTierTypeOption | true | none | The identifier for the tier type that is tied to the tiered rate record. |
| »»» memberCount | integer(int32)|null | false | none | The number of people included in the tiered rate. |
| »»» monthlyRate | number(decimal)|null | false | none | The monthly rate for the tiered rate. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | Tiered rate info |
| »»» policyId | integer(int32) | true | none | The identifier for the policy that is tied to the tiered rate record. Has a dependency on a policy item. Please use the policy endpoint for reference. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | Represents a tiered rate |
| »»» id | integer(int32) | false | none | The unique Zywave identifier for the tiered rate. |
| Property | Value |
|---|---|
| rateTierType | Employee |
| rateTierType | EmployeeSpouse |
| rateTierType | EmployeeChildren |
| rateTierType | EmployeeFamily |
| rateTierType | EmployeeChild |
| rateTierType | EmployeeSpouseChild |
| rateTierType | EmployeeTwoChildren |
| rateTierType | EmployeeThreeChildren |
POST /policies/v2.0/policies/{policyId}/tieredrates
Creates a tiered rate for a policy.
Tiered rate has a dependency on other policy items and caller should be able to handle discrepancies, race conditions, and object creation order. Please check model for more information on each dependency.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | TieredRateBaseInfo | true | The tiered rate to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the id of the created tiered rate. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/vendors/{id}
Gets the vendor by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The vendor id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
},
{
"type": "object",
"description": "A vendor record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the vendor",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"customName": {
"type": "string",
"description": "The vendor name",
"maxLength": 255,
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the Vendor record. | Vendor |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/vendors/{id}
Updates the existing vendor information for the vendor id specified.
Body parameter
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the vendor to update |
| body | body | VendorInfo | true | The information to update on the vendor |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/vendors
Search for vendor.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
},
{
"type": "object",
"description": "A vendor record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the vendor",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"customName": {
"type": "string",
"description": "The vendor name",
"maxLength": 255,
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the list of vendors. | PagedResultOfVendor |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
POST /policies/v2.0/vendors
Creates a vendor.
Body parameter
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VendorInfo | true | The vendor info to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the id of the created vendor. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/vendors/{id}/name
Gets the vendor custom name for the vendor id specified.
A 404 response is returned both when the vendor does not exist and when the vendor exists but does not have a custom name.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The vendor id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Vendor name info",
"additionalProperties": false,
"required": [
"customName"
],
"properties": {
"customName": {
"type": "string",
"description": "The custom vendor name",
"maxLength": 255,
"minLength": 1
}
}
},
{
"type": "object",
"description": "A vendor name record",
"additionalProperties": false,
"required": [
"vendorId"
],
"properties": {
"vendorId": {
"type": "integer",
"description": "The unique Zywave identifier for the vendor",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the VendorName record. | VendorName |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/vendors/{id}/name
Updates the vendor custom name for the vendor id specified.
Body parameter
{
"type": "object",
"description": "Vendor name info",
"additionalProperties": false,
"required": [
"customName"
],
"properties": {
"customName": {
"type": "string",
"description": "The custom vendor name",
"maxLength": 255,
"minLength": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The id of the vendor to update. |
| body | body | VendorNameInfo | true | The vendor custom name information to update. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | A 204 No Content response. | None |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /policies/v2.0/vendors/custom
Creates a custom vendor with the specified custom name.
The source identity fields (source id, source type, and source entity name) are assigned by the service and must not be supplied.
Body parameter
{
"type": "object",
"description": "Vendor name info",
"additionalProperties": false,
"required": [
"customName"
],
"properties": {
"customName": {
"type": "string",
"description": "The custom vendor name",
"maxLength": 255,
"minLength": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | VendorNameInfo | true | The vendor custom name info to create. |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 Created response containing the id of the created vendor. | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
POST /policies/v2.0/policies/{policyId}/volumerates
Creates a VolumeRate record for the policy.
Body parameter
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| body | body | VolumeRateInfo | true | The VolumeRateInfo used to create a new record. |
Example responses
201 Response
{
"type": "object",
"description": "An array of volume rates with the total premium for all.",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"description": "An array of VolumeRate",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The total monthly premium for all Items.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The total annual premium for all Items.",
"format": "decimal"
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | A 201 CREATED with the id of the new record. | VolumeRates |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/volumerates
Gets the VolumeRates for a policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
Example responses
200 Response
{
"type": "object",
"description": "An array of volume rates with the total premium for all.",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"description": "An array of VolumeRate",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The total monthly premium for all Items.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The total annual premium for all Items.",
"format": "decimal"
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with an array of VolumeRate records. | VolumeRates |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
DELETE /policies/v2.0/policies/{policyId}/volumerates/{id}
Deletes a VolumeRate record by id for a policy.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | the id of the VolumeRate record. |
Example responses
200 Response
{
"type": "object",
"description": "An array of volume rates with the total premium for all.",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"description": "An array of VolumeRate",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The total monthly premium for all Items.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The total annual premium for all Items.",
"format": "decimal"
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 204 No Content response. | VolumeRates |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /policies/v2.0/policies/{policyId}/volumerates/{id}
Gets an VolumeRate record for a policy by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the VolumeRate record. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 200 OK response with the VolumeRate record. | VolumeRate |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /policies/v2.0/policies/{policyId}/volumerates/{id}
Updates a VolumeRate record for a policy.
Body parameter
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| policyId | path | integer(int32) | true | The policy id. |
| id | path | integer(int32) | true | The id of the VolumeRate record. |
| body | body | VolumeRateInfo | true | The VolumeRateInfo. |
Example responses
200 Response
{
"type": "object",
"description": "An array of volume rates with the total premium for all.",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"description": "An array of VolumeRate",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The total monthly premium for all Items.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The total annual premium for all Items.",
"format": "decimal"
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A 204 No Content response. | VolumeRates |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemTierId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item clause.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemClauseCreateInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the benefit item clause. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemTierId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemClauseInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » benefitItemId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemTierId": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| benefitItemTierId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| additionalProperties | any | false | none | none |
| type | string|null | false | none | none |
| title | string|null | false | none | none |
| status | integer(int32)|null | false | none | none |
| detail | string|null | false | none | none |
| instance | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemTierId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item clause.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [BenefitItemClause] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | HttpValidationProblemDetails | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » additionalProperties | any | false | none | none |
| » errors | object | false | none | none |
| »» additionalProperties | [string] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ProblemDetails | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » additionalProperties | any | false | none | none |
| » errors | object | false | none | none |
| »» additionalProperties | [string] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"benefitItemOptionTypeId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item option.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemOptionInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the benefit item option. |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"benefitItemOptionTypeId": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
| benefitItemOptionTypeId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"benefitItemOptionTypeId": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item option.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [BenefitItemOption] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemOptionTypeInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [BenefitItemOptionType] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemCreateInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the benefit item. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » policyCoverageTypeId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | The name of the benefit item. |
| defaultBenefitItemValueType | BenefitItemValueType | false | none | none |
| benefitItemOptionTypeId | integer(int32)|null | false | none | Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank. |
| allowsMultipleValues | boolean | false | none | none |
| isHeader | boolean | false | none | none |
| parentBenefitItemId | integer(int32)|null | false | none | none |
| sortOrder | integer(int32) | false | none | The index in which the benefit item is in the list |
{
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Percent |
| anonymous | Dollar |
| anonymous | DollarOrPercent |
| anonymous | Boolean |
| anonymous | Numeric |
| anonymous | Options |
| anonymous | Text |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item.",
"maxLength": 255,
"minLength": 1
},
"defaultBenefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
},
"benefitItemOptionTypeId": {
"type": "integer",
"description": "Must be not blank when DefaultBenefitItemValueType is 'Options'. Otherwise must stay blank.",
"format": "int32",
"nullable": true
},
"allowsMultipleValues": {
"type": "boolean"
},
"isHeader": {
"type": "boolean"
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyCoverageTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [BenefitItem] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item tier.",
"maxLength": 255,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item tier is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item tier.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemTierInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the benefit item tier. |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item tier.",
"maxLength": 255,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item tier is in the list",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | The name of the benefit item tier. |
| sortOrder | integer(int32) | false | none | The index in which the benefit item tier is in the list |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the benefit item tier.",
"maxLength": 255,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"description": "The index in which the benefit item tier is in the list",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item tier.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [BenefitItemTier] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the benefit item value.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemValueInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the benefit item value. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemValueBaseInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » policyId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemClauseId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"text": {
"type": "string",
"description": "Additional information about the Benefit Item besides its main Value.",
"maxLength": 255,
"nullable": true
},
"value": {
"type": "string",
"description": "Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options'",
"maxLength": 255,
"nullable": true
},
"benefitItemValueType": {
"type": "string",
"description": "",
"x-enumNames": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
],
"enum": [
"Percent",
"Dollar",
"DollarOrPercent",
"Boolean",
"Numeric",
"Options",
"Text"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| benefitItemClauseId | integer(int32) | false | none | none |
| sortOrder | integer(int32) | false | none | none |
| text | string|null | false | none | Additional information about the Benefit Item besides its main Value. |
| value | string|null | false | none | Value of the Benefit Item. May contain text or number. Should contain integer valid OptionId if BenefitItemValueType is 'Options' |
| benefitItemValueType | BenefitItemValueType | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the billing mode.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the billing mode is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the billing mode.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BillingModeInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the billing mode. |
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the billing mode.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the billing mode is archived."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | none | The description of the billing mode. |
| isArchived | boolean | false | none | Indicates whether the billing mode is archived. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the billing mode.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the billing mode is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the billing mode.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [BillingMode] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the carrier commission to agency payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32"
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the carrier commission to agency payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the carrier commission to agency payment schedule.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CarrierCommissionToAgencyPaymentScheduleInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the carrier commission to agency payment schedule. |
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the carrier commission to agency payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32"
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the carrier commission to agency payment schedule is archived."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | none | The description of the carrier commission to agency payment schedule |
| paymentsPerYear | integer(int32) | true | none | The amount of payments per year |
| isArchived | boolean | false | none | Indicates whether the carrier commission to agency payment schedule is archived. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the carrier commission to agency payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32"
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the carrier commission to agency payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the carrier commission to agency payment schedule.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [CarrierCommissionToAgencyPaymentSchedule] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the commission billing record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the commission billing.",
"format": "int32"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the commission billing was last updated.",
"format": "date-time"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the commission billing.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the commission billing.",
"nullable": true
},
"billingVendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the billing vendor.",
"format": "int32",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CommissionBillingInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the commission billing. |
| » updatedDateTimeOffSet | string(date-time) | false | none | The record of when the commission billing was last updated. |
| » updatedUserProfileId | string|null | false | none | The unique Zywave identifier for the user that last updated the commission billing. |
| » updatedUserProfileTypeCode | string|null | false | none | The Zywave identifier for the user type that last updated the commission billing. |
| » billingVendorId | integer(int32)|null | false | read-only | Denotes the Zywave ID of the billing vendor. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"description": " ",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the commission billing record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CommissionBillingBaseInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » policyId | integer(int32) | true | none | The identifier for the policy that is tied to the commission billing record. Has a dependency on a policy item. Please use the policy endpoint for reference. |
{
"type": "object",
"additionalProperties": false,
"required": [
"billingCarrierCompanyId",
"commissionType",
"annualPremium"
],
"properties": {
"billingCarrierCompanyId": {
"type": "integer",
"description": "The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"commissionType": {
"description": "The type of commission. Ex. Annual",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
]
},
"annualPremium": {
"type": "number",
"description": "The annual premium for the commission billing.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"insuredPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"billingModeId": {
"type": "integer",
"description": "The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"currentSubscriberCount": {
"type": "integer",
"description": "The amount of subscribers for the policy tied to the commission billing.",
"format": "int32",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "The identifier for the producer responsible for the commission.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"commissionRate": {
"type": "number",
"description": "The rate of the commission.",
"format": "decimal",
"maximum": 999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"annualCommission": {
"type": "number",
"description": "The total annual commission for the policy.",
"format": "decimal",
"maximum": 999999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"isPremiumCalculated": {
"type": "boolean",
"description": "The flag to toggle calculated premium"
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| billingCarrierCompanyId | integer(int32) | true | none | The identifier for the carrier company that is being billed. Has a dependency on a carrier company. Please use the Carrier API for reference. |
| commissionType | CommissionTypeOption | true | none | The type of commission. Ex. Annual |
| annualPremium | number(decimal) | true | none | The annual premium for the commission billing. |
| insuredPaymentScheduleId | integer(int32)|null | false | none | The identifier for the insured payment schedule of the commission billing. Has a dependency on an insured payment schedule. Please use the insured payment schedule endpoint for reference. |
| billingModeId | integer(int32)|null | false | none | The identifier for the billing mode of the commission billing. Has a dependency on a billing mode item. Please use the billing mode endpoint for reference. |
| currentSubscriberCount | integer(int32)|null | false | none | The amount of subscribers for the policy tied to the commission billing. |
| commissionProducerId | integer(int32)|null | false | none | The identifier for the producer responsible for the commission. |
| commissionRate | number(decimal)|null | false | none | The rate of the commission. |
| annualCommission | number(decimal)|null | false | none | The total annual commission for the policy. |
| isPremiumCalculated | boolean | false | none | The flag to toggle calculated premium |
| billingVendorSourceId | string|null | false | none | Denotes the source ID of the billing vendor (requires BillingCarrierCompanyId to be -1). |
| billingVendorSourceType | string|null | false | none | Denotes the source type of the billing vendor (requires BillingCarrierCompanyId to be -1). |
| billingVendorSourceEntityName | string|null | false | none | Denotes the source entity name of the billing vendor (requires BillingCarrierCompanyId to be -1). |
{
"type": "string",
"description": "",
"x-enumNames": [
"Annual",
"Unspecified"
],
"enum": [
"Annual",
"Unspecified"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Annual |
| anonymous | Unspecified |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"insuranceCategory"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the coverage type.",
"maxLength": 50,
"minLength": 1
},
"insuranceCategory": {
"description": "The category of insurance that this coverage type belongs. Ex. Benefits / Property",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PropertyCasualty"
],
"enum": [
"Benefits",
"PropertyCasualty"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the coverage type.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CoverageTypeInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the coverage type. |
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"insuranceCategory"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the coverage type.",
"maxLength": 50,
"minLength": 1
},
"insuranceCategory": {
"description": "The category of insurance that this coverage type belongs. Ex. Benefits / Property",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PropertyCasualty"
],
"enum": [
"Benefits",
"PropertyCasualty"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | none | The description of the coverage type. |
| insuranceCategory | InsuranceCategoryOption | true | none | The category of insurance that this coverage type belongs. Ex. Benefits / Property |
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PropertyCasualty"
],
"enum": [
"Benefits",
"PropertyCasualty"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Benefits |
| anonymous | PropertyCasualty |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"insuranceCategory"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the coverage type.",
"maxLength": 50,
"minLength": 1
},
"insuranceCategory": {
"description": "The category of insurance that this coverage type belongs. Ex. Benefits / Property",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PropertyCasualty"
],
"enum": [
"Benefits",
"PropertyCasualty"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the coverage type.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [CoverageType] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the department.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | DepartmentInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the department. |
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | none | The description of the department. |
| isArchived | boolean | false | none | Indicates whether the department is archived. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the department.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the department is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the department.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Department] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"annualRate": {
"type": "number",
"readOnly": true,
"description": "The _calculated_ annual rate.\n ",
"format": "decimal"
},
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fixed rate.\n ",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FixedRateInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » annualRate | number(decimal) | false | read-only | The calculated annual rate. |
| » id | integer(int32) | false | none | The unique Zywave identifier for the fixed rate. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FixedRateBaseInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » policyId | integer(int32) | true | none | The identifier for the policy that is tied to the fixed rate record. Has a dependency on a policy item. Please use the policy endpoint for reference. |
{
"type": "object",
"additionalProperties": false,
"required": [
"frequency"
],
"properties": {
"rate": {
"type": "number",
"description": "The rate for the fixed rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"frequency": {
"description": "The frequency of the `Rate`.",
"default": "AnnuallyOrOneTime",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
]
},
"employeeCount": {
"type": "integer",
"description": "The employee count.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rate | number(decimal)|null | false | none | The rate for the fixed rate. |
| frequency | FixedRateFrequencyOption | true | none | The frequency of the Rate. |
| employeeCount | integer(int32)|null | false | none | The employee count. |
{
"type": "string",
"description": "",
"x-enumNames": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
],
"enum": [
"AnnuallyOrOneTime",
"SemiAnnually",
"Quarterly",
"BiMonthly",
"Monthly",
"SemiMonthly",
"BiWeekly",
"Weekly",
"PerEmployeePerMonth",
"PerEmployeePerYear"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | AnnuallyOrOneTime |
| anonymous | SemiAnnually |
| anonymous | Quarterly |
| anonymous | BiMonthly |
| anonymous | Monthly |
| anonymous | SemiMonthly |
| anonymous | BiWeekly |
| anonymous | Weekly |
| anonymous | PerEmployeePerMonth |
| anonymous | PerEmployeePerYear |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the insured payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32",
"maximum": 2147483647,
"minimum": 0
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the insured payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the insured payment schedule.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | InsuredPaymentScheduleInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the insured payment schedule. |
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the insured payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32",
"maximum": 2147483647,
"minimum": 0
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the insured payment schedule is archived."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | none | The description of the insured payment schedule |
| paymentsPerYear | integer(int32) | true | none | The amount of payments per year |
| isArchived | boolean | false | none | Indicates whether the insured payment schedule is archived. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"paymentsPerYear"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the insured payment schedule",
"maxLength": 50,
"minLength": 1
},
"paymentsPerYear": {
"type": "integer",
"description": "The amount of payments per year",
"format": "int32",
"maximum": 2147483647,
"minimum": 0
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the insured payment schedule is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the insured payment schedule.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [InsuredPaymentSchedule] | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Employee |
| anonymous | EmployeeSpouse |
| anonymous | EmployeeChildren |
| anonymous | EmployeeFamily |
| anonymous | EmployeeChild |
| anonymous | EmployeeSpouseChild |
| anonymous | EmployeeTwoChildren |
| anonymous | EmployeeThreeChildren |
{
"type": "object",
"additionalProperties": false,
"properties": {
"strategy": {
"description": "The CobraRateStrategy.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"description": "A COBRA strategy record",
"additionalProperties": false,
"properties": {
"defaultRate": {
"description": "The default COBRA rate (as a percentage) to apply to `CobraRateRecord` values for the policy.\n \nThe default value for this property is `102`.\n \nThis rate is used if `OverrideDefaultRate` is `false`; it is ignored if `true`.\n \nIf `false`, the `DefaultRate` is multiplied by the policy rate for the rate tier.",
"default": "OneHundredTwoPercent",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
]
},
"overrideDefaultRate": {
"type": "boolean",
"description": "If `true`, then the default rate is overriden in the `CobraRateRecord` values for the policy.\n \nThe default value for this property is `false`.\n \n**Note:** Changing this value from `false` to `true` will **OVERWRITE** the saved values.",
"default": false,
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate strategy record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate Strategy",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
]
},
"cobraRates": {
"type": "array",
"description": "An array of CobraRateRecord values.",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate record",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"tier": {
"description": "The contribution tier for the rate record.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| strategy | CobraRateStrategy|null | false | none | The CobraRateStrategy. |
| cobraRates | [CobraRateRecord]|null | false | none | An array of CobraRateRecord values. |
{
"allOf": [
{
"type": "object",
"description": "A COBRA strategy record",
"additionalProperties": false,
"properties": {
"defaultRate": {
"description": "The default COBRA rate (as a percentage) to apply to `CobraRateRecord` values for the policy.\n \nThe default value for this property is `102`.\n \nThis rate is used if `OverrideDefaultRate` is `false`; it is ignored if `true`.\n \nIf `false`, the `DefaultRate` is multiplied by the policy rate for the rate tier.",
"default": "OneHundredTwoPercent",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
]
},
"overrideDefaultRate": {
"type": "boolean",
"description": "If `true`, then the default rate is overriden in the `CobraRateRecord` values for the policy.\n \nThe default value for this property is `false`.\n \n**Note:** Changing this value from `false` to `true` will **OVERWRITE** the saved values.",
"default": false,
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate strategy record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate Strategy",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CobraRateStrategyInfo | false | none | A COBRA strategy record |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | A COBRA rate strategy record |
| » id | integer(int32) | true | none | The unique Zywave identifier for the COBRA Rate Strategy |
{
"type": "object",
"description": "A COBRA strategy record",
"additionalProperties": false,
"properties": {
"defaultRate": {
"description": "The default COBRA rate (as a percentage) to apply to `CobraRateRecord` values for the policy.\n \nThe default value for this property is `102`.\n \nThis rate is used if `OverrideDefaultRate` is `false`; it is ignored if `true`.\n \nIf `false`, the `DefaultRate` is multiplied by the policy rate for the rate tier.",
"default": "OneHundredTwoPercent",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
]
},
"overrideDefaultRate": {
"type": "boolean",
"description": "If `true`, then the default rate is overriden in the `CobraRateRecord` values for the policy.\n \nThe default value for this property is `false`.\n \n**Note:** Changing this value from `false` to `true` will **OVERWRITE** the saved values.",
"default": false,
"nullable": true
}
}
}
A COBRA strategy record
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| defaultRate | CobraRateOption|null | false | none | The default COBRA rate (as a percentage) to apply to CobraRateRecord values for the policy. The default value for this property is 102. This rate is used if OverrideDefaultRate is false; it is ignored if true. If false, the DefaultRate is multiplied by the policy rate for the rate tier. |
| overrideDefaultRate | boolean|null | false | none | If true, then the default rate is overriden in the CobraRateRecord values for the policy. The default value for this property is false. Note: Changing this value from false to true will OVERWRITE the saved values. |
{
"type": "string",
"description": "",
"x-enumNames": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
],
"enum": [
"OneHundredPercent",
"OneHundredOnePercent",
"OneHundredTwoPercent"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | OneHundredPercent |
| anonymous | OneHundredOnePercent |
| anonymous | OneHundredTwoPercent |
{
"allOf": [
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "A COBRA rate record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the COBRA Rate record",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"tier": {
"description": "The contribution tier for the rate record.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CobraRateRecordInfo | false | none | COBRA rate record info |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | A COBRA rate record |
| » id | integer(int32) | true | none | The unique Zywave identifier for the COBRA Rate record |
| » tier | RateTierTypeOption | false | none | The contribution tier for the rate record. |
{
"type": "object",
"description": "COBRA rate record info",
"additionalProperties": false,
"properties": {
"cobraRate": {
"type": "number",
"description": "The COBRA rate for the contribution tier.\n \n**NOTE:** If the `CobraRateStrategy` associated with the policy has `OverrideDefaultRate` = `false`, this value will be calculated to follow the default rule.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
}
COBRA rate record info
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cobraRate | number(decimal)|null | false | none | The COBRA rate for the contribution tier. NOTE: If the CobraRateStrategy associated with the policy has OverrideDefaultRate = false, this value will be calculated to follow the default rule. |
{
"allOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"description": "Represents a commission period. ",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The id of the commission period record.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CommissionPeriodInfo | false | none | Information used when creating or updating a CommissionPeriod. All values are required when used for creation. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Represents a commission period. |
| » id | integer(int32) | false | none | The id of the commission period record. |
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
}
Information used when creating or updating a CommissionPeriod. All values are required when used for creation.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| commissionCalculationStrategy | CommissionCalculationStrategyOption|null | false | none | The commission calculation method (e.g. "Percentage" or "Flat"). |
| commissionRoundingStrategy | CommissionRoundingStrategyOption|null | false | none | The rounding method to use. |
| startDateTimeOffset | string(date-time)|null | false | none | The start date for the commission period. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Percentage |
| anonymous | Flat |
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | HouseWins |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"entityAction"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Required for Update and Delete. It is invalid to provide an id for a Create.",
"format": "int32",
"nullable": true
},
"entityAction": {
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
},
"info": {
"description": "The information used to create or update an entity. It is invalid to provide this for a Delete.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
]
}
}
},
{
"type": "object",
"description": "Audit info for commission period",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AuditInfoOfCommissionPeriodInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Audit info for commission period |
{
"type": "object",
"additionalProperties": false,
"required": [
"entityAction"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Required for Update and Delete. It is invalid to provide an id for a Create.",
"format": "int32",
"nullable": true
},
"entityAction": {
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
},
"info": {
"description": "The information used to create or update an entity. It is invalid to provide this for a Delete.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entityId | integer(int32)|null | false | none | Required for Update and Delete. It is invalid to provide an id for a Create. |
| entityAction | EntityActionOption | true | none | none |
| info | DeltaOfCommissionPeriodInfo|null | false | none | The information used to create or update an entity. It is invalid to provide this for a Delete. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Create |
| anonymous | Update |
| anonymous | Delete |
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Information used when creating or updating a CommissionPeriod.\nAll values are required when used for creation.",
"additionalProperties": false,
"properties": {
"commissionCalculationStrategy": {
"description": "The commission calculation method (e.g. \"Percentage\" or \"Flat\").",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Percentage",
"Flat"
],
"enum": [
"Percentage",
"Flat"
]
}
]
},
"commissionRoundingStrategy": {
"description": "The rounding method to use.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"HouseWins"
],
"enum": [
"HouseWins"
]
}
]
},
"startDateTimeOffset": {
"type": "string",
"description": "The start date for the commission period.",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
A wrapper for values to be used for updating or creating a record.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updateOrCreateInformation | CommissionPeriodInfo|null | false | none | The information to use for updating or creating. Null values are ignored. |
{
"allOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
},
{
"type": "object",
"description": "A commission split record",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The id of the commission split.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CommissionSplitInfo | false | none | Commission Split info |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | A commission split record |
| » id | integer(int32) | false | none | The id of the commission split. |
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
}
Commission Split info
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| payeeId | string|null | false | none | The id for the payee. Example: "5003000000D8cuIQAA". This id is intended for use by a caller in conjunction with the values in the PayeeIdSource* properties. Uniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple. NOTE TO IMPLEMENTERS: If your source system potentially has multiple "versions" of the same ID (e.g. Salesforce which offers both 15-character and 18-character IDs), it is your responsibility to consistently use the same "version". |
| payeeIdSourceType | string|null | false | none | The source type of the id used for the payee. Example: "Salesforce". This id is intended for use by a caller in conjunction with the values in the PayeeIdSource* properties. Uniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple. |
| payeeIdSourceEntityName | string|null | false | none | The name of the source entity of the id used for the payee. Example: "Contact". This id is intended for use by a caller in conjunction with the values in the PayeeIdSource* properties. Uniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple. |
| commissionPeriodId | integer(int32)|null | false | none | The id of the CommissionPeriod that is the parent of this record. CommissionSplit is dependent on CommissionPeriod. |
| amount | number(decimal)|null | false | none | The amount to be paid to the payee. The amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy. Only two(2) significant decimal places are supported. |
| generation | integer(int32)|null | false | none | Indicates the "generation" in which the payee's payment amount is calculated. Payments within a period are calculated by "generation": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated. This allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount. Generation zero(0) is recommended for internal producers. It is recommended that "space" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"entityAction"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Required for Update and Delete. It is invalid to provide an id for a Create.",
"format": "int32",
"nullable": true
},
"entityAction": {
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
},
"info": {
"description": "The information used to create or update an entity. It is invalid to provide this for a Delete.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
}
]
}
}
}
]
}
}
},
{
"type": "object",
"description": "Audit info for commission split",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AuditInfoOfCommissionSplitInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Audit info for commission split |
{
"type": "object",
"additionalProperties": false,
"required": [
"entityAction"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Required for Update and Delete. It is invalid to provide an id for a Create.",
"format": "int32",
"nullable": true
},
"entityAction": {
"type": "string",
"description": "",
"x-enumNames": [
"Create",
"Update",
"Delete"
],
"enum": [
"Create",
"Update",
"Delete"
]
},
"info": {
"description": "The information used to create or update an entity. It is invalid to provide this for a Delete.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
}
]
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entityId | integer(int32)|null | false | none | Required for Update and Delete. It is invalid to provide an id for a Create. |
| entityAction | EntityActionOption | true | none | none |
| info | DeltaOfCommissionSplitInfo|null | false | none | The information used to create or update an entity. It is invalid to provide this for a Delete. |
{
"type": "object",
"description": "A wrapper for values to be used for updating or creating a record.",
"additionalProperties": false,
"properties": {
"updateOrCreateInformation": {
"description": "The information to use for updating or creating. Null values are ignored.",
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Commission Split info",
"additionalProperties": false,
"properties": {
"payeeId": {
"type": "string",
"description": "The id for the payee. Example: \"5003000000D8cuIQAA\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.\n \nNOTE TO IMPLEMENTERS: If your source system potentially has multiple \"versions\" of the same ID\n(e.g. Salesforce which offers both 15-character and 18-character IDs),\nit is your responsibility to consistently use the same \"version\".",
"maxLength": 36,
"nullable": true
},
"payeeIdSourceType": {
"type": "string",
"description": "The source type of the id used for the payee. Example: \"Salesforce\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"payeeIdSourceEntityName": {
"type": "string",
"description": "The name of the source entity of the id used for the payee. Example: \"Contact\".\n\nThis id is intended for use by a caller in conjunction with the values in the `PayeeIdSource*` properties.\n \nUniqueness is enforced over PayeeId, PayeeIdSourceType, and PayeeIdSourceEntityName as a tuple.",
"maxLength": 32,
"nullable": true
},
"commissionPeriodId": {
"type": "integer",
"description": "The id of the CommissionPeriod that is the parent of this record.\n\nCommissionSplit is dependent on CommissionPeriod.",
"format": "int32",
"nullable": true
},
"amount": {
"type": "number",
"description": "The amount to be paid to the payee.\n \nThe amount is used with the CommissionCalculationStrategy and the CommissionCalculationStrategy.\n \nOnly two(2) significant decimal places are supported.",
"format": "decimal",
"maximum": 999999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"generation": {
"type": "integer",
"description": "Indicates the \"generation\" in which the payee's payment amount is calculated.\n\nPayments within a period are calculated by \"generation\": the amounts for payees in the generation with the smallest value are calculated first. Successive generations are calculated from the amount left after the previous generation has been calculated.\n \nThis allows for scenarios where there is an outside producer who is paid against the gross and internal producers who are paid against the remaining amount.\n \nGeneration zero(0) is recommended for internal producers.\n \nIt is recommended that \"space\" be left between generation values(e.g. -200, -100, 0) so that the addition of a generation between two existing generations does not require modifying those records.",
"format": "int32",
"default": 0,
"maximum": 0,
"minimum": -2147483648,
"nullable": true
}
}
}
]
}
}
}
A wrapper for values to be used for updating or creating a record.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updateOrCreateInformation | CommissionSplitInfo|null | false | none | The information to use for updating or creating. Null values are ignored. |
{
"type": "object",
"description": "The contribution strategy and records for the policy.",
"additionalProperties": false,
"properties": {
"contributionStrategy": {
"description": "The contribution strategy.",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"calculationStrategy",
"roundingStrategy"
],
"properties": {
"calculationStrategy": {
"description": "The strategy used for calculating monthly contributions.",
"default": "EmployerDollars",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
],
"enum": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
]
}
]
},
"roundingStrategy": {
"description": "The strategy used for rounding.",
"default": "RoundDownEmployee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"RoundDownEmployer",
"RoundDownEmployee"
],
"enum": [
"RoundDownEmployer",
"RoundDownEmployee"
]
}
]
}
}
}
]
},
"contributionRecords": {
"type": "array",
"description": "The contribution records.",
"items": {
"type": "object",
"description": "The contribution record data returned to the caller.",
"additionalProperties": false,
"properties": {
"contributionTier": {
"description": "The contribution tier.",
"default": "Employee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"rateTotal": {
"type": "number",
"description": "The monthly total for rate tier (Employer $ + Employee $).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"strategyAmount": {
"type": "number",
"description": "The percent or dollar amount used in calculations. E.g. 30% (a percentage strategy) or $541.32 (a dollars strategy).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeeDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeePercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerPercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
}
}
}
}
}
}
The contribution strategy and records for the policy.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contributionStrategy | ContributionStrategyInfo | false | none | The contribution strategy. |
| contributionRecords | [ContributionRecord] | false | none | The contribution records. |
{
"type": "object",
"additionalProperties": false,
"required": [
"calculationStrategy",
"roundingStrategy"
],
"properties": {
"calculationStrategy": {
"description": "The strategy used for calculating monthly contributions.",
"default": "EmployerDollars",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
],
"enum": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
]
}
]
},
"roundingStrategy": {
"description": "The strategy used for rounding.",
"default": "RoundDownEmployee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"RoundDownEmployer",
"RoundDownEmployee"
],
"enum": [
"RoundDownEmployer",
"RoundDownEmployee"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| calculationStrategy | ContributionCalculationStrategyOption | true | none | The strategy used for calculating monthly contributions. |
| roundingStrategy | ContributionRoundingStrategyOption | true | none | The strategy used for rounding. |
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
],
"enum": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | EmployerPercent |
| anonymous | EmployeePercent |
| anonymous | EmployerDollars |
| anonymous | EmployeeDollars |
{
"type": "string",
"description": "",
"x-enumNames": [
"RoundDownEmployer",
"RoundDownEmployee"
],
"enum": [
"RoundDownEmployer",
"RoundDownEmployee"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | RoundDownEmployer |
| anonymous | RoundDownEmployee |
{
"type": "object",
"description": "The contribution record data returned to the caller.",
"additionalProperties": false,
"properties": {
"contributionTier": {
"description": "The contribution tier.",
"default": "Employee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"rateTotal": {
"type": "number",
"description": "The monthly total for rate tier (Employer $ + Employee $).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"strategyAmount": {
"type": "number",
"description": "The percent or dollar amount used in calculations. E.g. 30% (a percentage strategy) or $541.32 (a dollars strategy).",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeeDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerDollars": {
"type": "number",
"description": "Computed. The monthly dollar amount paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employeePercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employee.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"employerPercent": {
"type": "number",
"description": "Computed. The monthly percent contribution paid by the employer.",
"format": "decimal",
"pattern": "^\\d+\\.?\\d{0,2}$"
}
}
}
The contribution record data returned to the caller.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contributionTier | ContributionTierOption | false | none | The contribution tier. |
| rateTotal | number(decimal) | false | none | The monthly total for rate tier (Employer $ + Employee $). |
| strategyAmount | number(decimal) | false | none | The percent or dollar amount used in calculations. E.g. 30% (a percentage strategy) or $541.32 (a dollars strategy). |
| employeeDollars | number(decimal) | false | none | Computed. The monthly dollar amount paid by the employee. |
| employerDollars | number(decimal) | false | none | Computed. The monthly dollar amount paid by the employer. |
| employeePercent | number(decimal) | false | none | Computed. The monthly percent contribution paid by the employee. |
| employerPercent | number(decimal) | false | none | Computed. The monthly percent contribution paid by the employer. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Employee |
| anonymous | EmployeeSpouse |
| anonymous | EmployeeChildren |
| anonymous | EmployeeFamily |
| anonymous | EmployeeChild |
| anonymous | EmployeeSpouseChild |
| anonymous | EmployeeTwoChildren |
| anonymous | EmployeeThreeChildren |
{
"type": "object",
"additionalProperties": false,
"required": [
"strategyAmount",
"rateTotal"
],
"properties": {
"strategyAmount": {
"type": "number",
"description": "The eployee/employer percentage/dollars.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"rateTotal": {
"type": "number",
"description": "The total for the contribution tier (employer $ + employee $).",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| strategyAmount | number(decimal) | true | none | The eployee/employer percentage/dollars. |
| rateTotal | number(decimal) | true | none | The total for the contribution tier (employer $ + employee $). |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"calculationStrategy",
"roundingStrategy"
],
"properties": {
"calculationStrategy": {
"description": "The strategy used for calculating monthly contributions.",
"default": "EmployerDollars",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
],
"enum": [
"EmployerPercent",
"EmployeePercent",
"EmployerDollars",
"EmployeeDollars"
]
}
]
},
"roundingStrategy": {
"description": "The strategy used for rounding.",
"default": "RoundDownEmployee",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"RoundDownEmployer",
"RoundDownEmployee"
],
"enum": [
"RoundDownEmployer",
"RoundDownEmployee"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"shouldKeepContributionRecords": {
"type": "boolean",
"description": "Indicates if changing the strategy should or should not keep the existing contribution records.",
"default": false,
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ContributionStrategyInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » shouldKeepContributionRecords | boolean|null | false | none | Indicates if changing the strategy should or should not keep the existing contribution records. |
{
"allOf": [
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy.",
"format": "int32"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the policy.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the policy.",
"nullable": true
},
"createdDateTimeOffset": {
"type": "string",
"description": "The record of when the policy was created.",
"format": "date-time"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the policy was last updated.",
"format": "date-time"
},
"renewedByPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that renews this policy.\n \nIf this property has a value, the Policy is NOT renewable.",
"format": "int32",
"nullable": true
},
"renewedFromPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that is the predecessor of this policy.",
"format": "int32",
"nullable": true
},
"vendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the vendor.",
"format": "int32",
"nullable": true
},
"isEndingStatusRetained": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the ending status has the base status of Retained."
},
"isActive": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is active."
},
"isCancelled": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is cancelled."
},
"isExpired": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is expired."
},
"isFuture": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is future."
},
"isPendingCancellation": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending cancellation."
},
"isPendingReinstatement": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending reinstatement."
},
"isReinstated": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is reinstated."
},
"isRenewed": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is renewed."
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PolicyInfo | false | none | PolicyInfo class. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the policy. |
| » updatedUserProfileId | string|null | false | none | The unique Zywave identifier for the user that last updated the policy. |
| » updatedUserProfileTypeCode | string|null | false | none | The Zywave identifier for the user type that last updated the policy. |
| » createdDateTimeOffset | string(date-time) | false | none | The record of when the policy was created. |
| » updatedDateTimeOffSet | string(date-time) | false | none | The record of when the policy was last updated. |
| » renewedByPolicyId | integer(int32)|null | false | read-only | The id of the Policy that renews this policy. If this property has a value, the Policy is NOT renewable. |
| » renewedFromPolicyId | integer(int32)|null | false | read-only | The id of the Policy that is the predecessor of this policy. |
| » vendorId | integer(int32)|null | false | read-only | Denotes the Zywave ID of the vendor. |
| » isEndingStatusRetained | boolean | false | read-only | Denotes whether or not the ending status has the base status of Retained. |
| » isActive | boolean | false | read-only | Denotes whether or not the status is active. |
| » isCancelled | boolean | false | read-only | Denotes whether or not the status is cancelled. |
| » isExpired | boolean | false | read-only | Denotes whether or not the status is expired. |
| » isFuture | boolean | false | read-only | Denotes whether or not the status is future. |
| » isPendingCancellation | boolean | false | read-only | Denotes whether or not the status is pending cancellation. |
| » isPendingReinstatement | boolean | false | read-only | Denotes whether or not the status is pending reinstatement. |
| » isReinstated | boolean | false | read-only | Denotes whether or not the status is reinstated. |
| » isRenewed | boolean | false | read-only | Denotes whether or not the status is renewed. |
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
*PolicyInfo class. *
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | true | none | The unique Zywave identifier for the account tied to the policy. |
| policyCoverageTypeId | integer(int32) | true | none | The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference. |
| carrierCompanyId | integer(int32) | true | none | The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference. |
| beginningPolicyStatusId | integer(int32) | true | none | The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference. |
| effectiveDate | string(date-time) | true | none | The date that the policy becomes effective. |
| expirationDate | string(date-time)|null | false | none | The date that the policy expires. |
| fundingType | FundingTypeOption | true | none | The funding type for the policy. |
| productType | ProductTypeOption | true | none | The product type for the policy. |
| isVoluntary | boolean | true | none | Denotes if a policy is voluntary. |
| policyName | string | true | none | The name of the policy. |
| firstWrittenDate | string(date-time) | true | none | The date that the policy was first written. Must be less than or equal to ExpirationDate. |
| cancellationDate | string(date-time)|null | false | none | The date that the policy was cancelled. |
| reinstatementDate | string(date-time)|null | false | none | The date that the policy was reinstated. |
| policyNumber | string|null | false | none | The carrier's identifier for the policy. |
| rateType | RateTypeOption|null | false | none | The type of rate for the policy. Ex. Tiered |
| endingPolicyStatusId | integer(int32)|null | false | none | The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference. |
| departmentId | integer(int32)|null | false | none | The identifier for the department related to the policy. |
| carrierCommissionToAgencyPaymentScheduleId | integer(int32)|null | false | none | The identifier for the carrier commission to agency payment schedule related to the policy. |
| needsReview | boolean|null | false | none | Denotes if a policy needs to be reviewed. |
| policyGroupId | integer(int32)|null | false | none | Denotes the policy group ID that this policy belongs to. |
| vendorSourceId | string|null | false | none | Denotes the source ID of the vendor (requires CarrierCompanyId to be -1). |
| vendorSourceType | string|null | false | none | Denotes the source type of the vendor (requires CarrierCompanyId to be -1). |
| vendorSourceEntityName | string|null | false | none | Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1). |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | FullyInsured |
| anonymous | SelfFunded |
| anonymous | LevelFunded |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | PPO |
| anonymous | HMO |
| anonymous | POS |
| anonymous | EPO |
| anonymous | Indemnity |
| anonymous | INO |
| anonymous | HDHP |
| anonymous | ReferenceBasedPricing |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Tiered |
| anonymous | Fixed |
| anonymous | Volume |
| anonymous | Complex |
| anonymous | SelfFunded |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "PolicyInfo class.\n ",
"additionalProperties": false,
"required": [
"accountId",
"policyCoverageTypeId",
"carrierCompanyId",
"beginningPolicyStatusId",
"effectiveDate",
"fundingType",
"productType",
"isVoluntary",
"policyName",
"firstWrittenDate"
],
"properties": {
"accountId": {
"type": "integer",
"description": "The unique Zywave identifier for the account tied to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"policyCoverageTypeId": {
"type": "integer",
"description": "The type of coverage for the policy. Ex. Medical, Dental, etc. Has a dependency on a policy coverage type item. Please use the policy coverage type endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company tied to the policy. Has a dependency on a carrier company item. Please use the Carriers API for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": -1
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the policy becomes effective.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "The date that the policy expires.",
"format": "date-time",
"nullable": true
},
"fundingType": {
"description": "The funding type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
],
"enum": [
"None",
"FullyInsured",
"SelfFunded",
"LevelFunded"
]
}
]
},
"productType": {
"description": "The product type for the policy.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
],
"enum": [
"None",
"PPO",
"HMO",
"POS",
"EPO",
"Indemnity",
"INO",
"HDHP",
"ReferenceBasedPricing"
]
}
]
},
"isVoluntary": {
"type": "boolean",
"description": "Denotes if a policy is voluntary."
},
"policyName": {
"type": "string",
"description": "The name of the policy.",
"maxLength": 100,
"minLength": 1
},
"firstWrittenDate": {
"type": "string",
"description": "The date that the policy was first written. Must be less than or equal to ExpirationDate.",
"format": "date-time"
},
"cancellationDate": {
"type": "string",
"description": "The date that the policy was cancelled.",
"format": "date-time",
"nullable": true
},
"reinstatementDate": {
"type": "string",
"description": "The date that the policy was reinstated.",
"format": "date-time",
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The carrier's identifier for the policy.",
"maxLength": 75,
"nullable": true
},
"rateType": {
"description": "The type of rate for the policy. Ex. Tiered",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
],
"enum": [
"None",
"Tiered",
"Fixed",
"Volume",
"Complex",
"SelfFunded"
]
}
]
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy at the end of its term. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"description": "The identifier for the department related to the policy.",
"format": "int32",
"nullable": true
},
"carrierCommissionToAgencyPaymentScheduleId": {
"type": "integer",
"description": "The identifier for the carrier commission to agency payment schedule related to the policy.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Denotes if a policy needs to be reviewed.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "Denotes the policy group ID that this policy belongs to.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"vendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"vendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"vendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy.",
"format": "int32"
},
"updatedUserProfileId": {
"type": "string",
"description": "The unique Zywave identifier for the user that last updated the policy.",
"nullable": true
},
"updatedUserProfileTypeCode": {
"type": "string",
"description": "The Zywave identifier for the user type that last updated the policy.",
"nullable": true
},
"createdDateTimeOffset": {
"type": "string",
"description": "The record of when the policy was created.",
"format": "date-time"
},
"updatedDateTimeOffSet": {
"type": "string",
"description": "The record of when the policy was last updated.",
"format": "date-time"
},
"renewedByPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that renews this policy.\n \nIf this property has a value, the Policy is NOT renewable.",
"format": "int32",
"nullable": true
},
"renewedFromPolicyId": {
"type": "integer",
"readOnly": true,
"description": "The id of the Policy that is the predecessor of this policy.",
"format": "int32",
"nullable": true
},
"vendorId": {
"type": "integer",
"readOnly": true,
"description": "Denotes the Zywave ID of the vendor.",
"format": "int32",
"nullable": true
},
"isEndingStatusRetained": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the ending status has the base status of Retained."
},
"isActive": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is active."
},
"isCancelled": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is cancelled."
},
"isExpired": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is expired."
},
"isFuture": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is future."
},
"isPendingCancellation": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending cancellation."
},
"isPendingReinstatement": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is pending reinstatement."
},
"isReinstated": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is reinstated."
},
"isRenewed": {
"type": "boolean",
"readOnly": true,
"description": "Denotes whether or not the status is renewed."
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Policy] | false | none | none |
{
"type": "object",
"description": "Eligibility information for a policy.",
"additionalProperties": false,
"properties": {
"employeeGroup": {
"description": "The employee group or groups to which this eligibility information applies.\n\nThis value can be a bit mask of EmployeeGroupOptions values. ",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
]
},
"hours": {
"type": "integer",
"description": "The minimum weekly hours required for eligibility.",
"format": "int32",
"maximum": 40,
"minimum": 0,
"nullable": true
},
"waitingPeriod": {
"description": "The waiting period between hire date and first coverage.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
]
},
"waitingPeriodAmount": {
"type": "integer",
"description": "The waiting period amount (days/months) used as needed with the WaitingPeriod.",
"format": "int32",
"maximum": 365,
"minimum": 0,
"nullable": true
},
"domesticPartnerCoverage": {
"type": "boolean",
"description": "Indicates if domestic partners are covered by the policy.",
"nullable": true
},
"coverageTermination": {
"description": "The coverage termination relative to employment termination.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
]
},
"description": {
"type": "string",
"description": "The description of the eligibility coverage information.",
"maxLength": 500,
"nullable": true
},
"spouseCoverage": {
"type": "boolean",
"description": "Indicates if spouse is covered by the policy.",
"nullable": true
},
"dependentCoverage": {
"type": "boolean",
"description": "Indicates if dependent or child is covered by the policy.",
"nullable": true
},
"otherCoverage": {
"type": "boolean",
"description": "Indicates if there is anything other covered by the policy.",
"nullable": true
},
"otherCoverageDescription": {
"type": "string",
"description": "The description of the other coverage information.",
"maxLength": 100,
"nullable": true
}
}
}
Eligibility information for a policy.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| employeeGroup | EmployeeGroupOptions|null | false | none | The employee group or groups to which this eligibility information applies. This value can be a bit mask of EmployeeGroupOptions values. |
| hours | integer(int32)|null | false | none | The minimum weekly hours required for eligibility. |
| waitingPeriod | WaitingPeriodOption|null | false | none | The waiting period between hire date and first coverage. |
| waitingPeriodAmount | integer(int32)|null | false | none | The waiting period amount (days/months) used as needed with the WaitingPeriod. |
| domesticPartnerCoverage | boolean|null | false | none | Indicates if domestic partners are covered by the policy. |
| coverageTermination | CoverageTerminationOption|null | false | none | The coverage termination relative to employment termination. |
| description | string|null | false | none | The description of the eligibility coverage information. |
| spouseCoverage | boolean|null | false | none | Indicates if spouse is covered by the policy. |
| dependentCoverage | boolean|null | false | none | Indicates if dependent or child is covered by the policy. |
| otherCoverage | boolean|null | false | none | Indicates if there is anything other covered by the policy. |
| otherCoverageDescription | string|null | false | none | The description of the other coverage information. |
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Salaried |
| anonymous | NonSalaried |
| anonymous | Management |
| anonymous | Union |
| anonymous | FullTime |
| anonymous | All |
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | DateOfHire |
| anonymous | NDaysAfterDateOfHire |
| anonymous | NMonthsAfterDateOfHire |
| anonymous | FirstOfMonthAfterDateOfHire |
| anonymous | FirstOfMonthAfterNDaysAfterDateOfHire |
| anonymous | FirstOfMonthAfterNMonthsAfterDateOfHire |
| anonymous | FifteenthOfMonthAfterNDaysAfterDateOfHire |
| anonymous | FifteenthOfMonthAfterNMonthsAfterDateOfHire |
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Immediate |
| anonymous | LastDayOfMonth |
| anonymous | ThirtyDaysAfter |
| anonymous | FifteenthOfMonth |
{
"allOf": [
{
"type": "object",
"description": "Eligibility information for a policy.",
"additionalProperties": false,
"properties": {
"employeeGroup": {
"description": "The employee group or groups to which this eligibility information applies.\n\nThis value can be a bit mask of EmployeeGroupOptions values. ",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumFlags": true,
"x-enumNames": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
],
"enum": [
"None",
"Salaried",
"NonSalaried",
"Management",
"Union",
"FullTime",
"All"
]
}
]
},
"hours": {
"type": "integer",
"description": "The minimum weekly hours required for eligibility.",
"format": "int32",
"maximum": 40,
"minimum": 0,
"nullable": true
},
"waitingPeriod": {
"description": "The waiting period between hire date and first coverage.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
],
"enum": [
"DateOfHire",
"NDaysAfterDateOfHire",
"NMonthsAfterDateOfHire",
"FirstOfMonthAfterDateOfHire",
"FirstOfMonthAfterNDaysAfterDateOfHire",
"FirstOfMonthAfterNMonthsAfterDateOfHire",
"FifteenthOfMonthAfterNDaysAfterDateOfHire",
"FifteenthOfMonthAfterNMonthsAfterDateOfHire"
]
}
]
},
"waitingPeriodAmount": {
"type": "integer",
"description": "The waiting period amount (days/months) used as needed with the WaitingPeriod.",
"format": "int32",
"maximum": 365,
"minimum": 0,
"nullable": true
},
"domesticPartnerCoverage": {
"type": "boolean",
"description": "Indicates if domestic partners are covered by the policy.",
"nullable": true
},
"coverageTermination": {
"description": "The coverage termination relative to employment termination.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
],
"enum": [
"Immediate",
"LastDayOfMonth",
"ThirtyDaysAfter",
"FifteenthOfMonth"
]
}
]
},
"description": {
"type": "string",
"description": "The description of the eligibility coverage information.",
"maxLength": 500,
"nullable": true
},
"spouseCoverage": {
"type": "boolean",
"description": "Indicates if spouse is covered by the policy.",
"nullable": true
},
"dependentCoverage": {
"type": "boolean",
"description": "Indicates if dependent or child is covered by the policy.",
"nullable": true
},
"otherCoverage": {
"type": "boolean",
"description": "Indicates if there is anything other covered by the policy.",
"nullable": true
},
"otherCoverageDescription": {
"type": "string",
"description": "The description of the other coverage information.",
"maxLength": 100,
"nullable": true
}
}
},
{
"type": "object",
"description": "The Eligibility for the policy.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The ID of the eligibility record.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | EligibilityInfo | false | none | Eligibility information for a policy. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | The Eligibility for the policy. |
| » id | integer(int32) | false | none | The ID of the eligibility record. |
{
"allOf": [
{
"type": "object",
"description": "Fee info",
"additionalProperties": false,
"required": [
"feeTypeId",
"frequency"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount",
"format": "decimal",
"maximum": 999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"count": {
"type": "integer",
"description": "The count",
"format": "int32",
"maximum": 999999,
"minimum": 0,
"nullable": true
},
"feeTypeId": {
"type": "integer",
"description": "The unique identifier of the FeeType",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"frequency": {
"description": "The FrequencyOption",
"default": "Annually",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
]
},
"policyId": {
"type": "integer",
"description": "Gets or sets the policy id",
"format": "int32",
"nullable": true
}
}
},
{
"type": "object",
"description": "A fee record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the fee",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FeeInfo | false | none | Fee info |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | A fee record |
| » id | integer(int32) | true | none | The unique Zywave identifier for the fee |
{
"type": "object",
"description": "Fee info",
"additionalProperties": false,
"required": [
"feeTypeId",
"frequency"
],
"properties": {
"amount": {
"type": "number",
"description": "The amount",
"format": "decimal",
"maximum": 999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
},
"count": {
"type": "integer",
"description": "The count",
"format": "int32",
"maximum": 999999,
"minimum": 0,
"nullable": true
},
"feeTypeId": {
"type": "integer",
"description": "The unique identifier of the FeeType",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"frequency": {
"description": "The FrequencyOption",
"default": "Annually",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
]
},
"policyId": {
"type": "integer",
"description": "Gets or sets the policy id",
"format": "int32",
"nullable": true
}
}
}
Fee info
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amount | number(decimal)|null | false | none | The amount |
| count | integer(int32)|null | false | none | The count |
| feeTypeId | integer(int32) | true | none | The unique identifier of the FeeType |
| frequency | FrequencyOption | true | none | The FrequencyOption |
| policyId | integer(int32)|null | false | none | Gets or sets the policy id |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annually",
"Monthly"
],
"enum": [
"None",
"Annually",
"Monthly"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Annually |
| anonymous | Monthly |
{
"type": "object",
"description": "The policy reinstate information.",
"additionalProperties": false,
"required": [
"reinstatementDate"
],
"properties": {
"reinstatementDate": {
"type": "string",
"description": "The reinstatement date.",
"format": "date-time"
}
}
}
The policy reinstate information.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| reinstatementDate | string(date-time) | true | none | The reinstatement date. |
{
"type": "object",
"description": "The policy cancel information.",
"additionalProperties": false,
"required": [
"cancellationDate",
"endingPolicyStatusId"
],
"properties": {
"cancellationDate": {
"type": "string",
"description": "The cancellation date.",
"format": "date-time"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "The ending policy status id.\nUse GET policystatus to search for allowed values.\nThe ending policy status id must have base type \"Lost\".",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
The policy cancel information.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| cancellationDate | string(date-time) | true | none | The cancellation date. |
| endingPolicyStatusId | integer(int32) | true | none | The ending policy status id. Use GET policystatus to search for allowed values. The ending policy status id must have base type "Lost". |
{
"type": "object",
"description": "The renewal information for a policy.",
"additionalProperties": false,
"required": [
"beginningPolicyStatusId"
],
"properties": {
"beginningPolicyStatusId": {
"type": "integer",
"description": "The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"effectiveDate": {
"type": "string",
"description": "The date that the new policy becomes effective.",
"format": "date-time",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "The date that the new policy expires.",
"format": "date-time",
"nullable": true
},
"policyId": {
"type": "integer",
"description": "The id for the policy to renew. ",
"format": "int32"
},
"carrierCompanyId": {
"type": "integer",
"description": "The carrier company id for the new policy. If left blank will use the old policy for new.",
"format": "int32",
"nullable": true
},
"userPrincipalId": {
"type": "string",
"description": "Gets or sets the user principal id.",
"format": "guid"
},
"userProfileTypeCode": {
"type": "string",
"description": "Gets or sets the user profile type code.",
"maxLength": 4,
"nullable": true
},
"userProfileId": {
"type": "string",
"description": "Gets or sets the user profile id.",
"maxLength": 36,
"nullable": true
},
"policyNumber": {
"type": "string",
"description": "The policy number for the new policy. If left blank will use the old policy for new.",
"maxLength": 75,
"nullable": true
},
"billingCarrierCompanyId": {
"type": "integer",
"description": "The billing carrier company id.\n\nIf missing, the value for billing carrier company is copied from the source policy.\n\nNOTE: simply setting the value for the carrier company underwriting the policy does NOT update this property.\nIt is recommended that callers *always* set this value when renewing.",
"format": "int32",
"nullable": true
},
"needsReview": {
"type": "boolean",
"description": "Indicates if the new policy should be marked as needing review.\nIf this property is null/missing, the value of the flag from the source policy is carried into the new policy.",
"nullable": true
},
"policyGroupId": {
"type": "integer",
"description": "The id of the policy group to add the renewed policy to.\nIf the policy group does not exist, the renewed policy will not be added to any group.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1,
"nullable": true
},
"policyVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the vendor for the new policy (requires CarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"policyVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the vendor for the new policy (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"policyVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the vendor for the new policy (requires CarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceId": {
"type": "string",
"description": "Denotes the source ID of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1).",
"maxLength": 36,
"nullable": true
},
"billingVendorSourceType": {
"type": "string",
"description": "Denotes the source type of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
},
"billingVendorSourceEntityName": {
"type": "string",
"description": "Denotes the source entity name of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1).",
"maxLength": 32,
"nullable": true
}
}
}
The renewal information for a policy.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| beginningPolicyStatusId | integer(int32) | true | none | The identifier for the status of the policy when it is created. Has a dependency on a policy status item. Please use the policy status endpoint for reference. |
| effectiveDate | string(date-time)|null | false | none | The date that the new policy becomes effective. |
| expirationDate | string(date-time)|null | false | none | The date that the new policy expires. |
| policyId | integer(int32) | false | none | The id for the policy to renew. |
| carrierCompanyId | integer(int32)|null | false | none | The carrier company id for the new policy. If left blank will use the old policy for new. |
| userPrincipalId | string(guid) | false | none | Gets or sets the user principal id. |
| userProfileTypeCode | string|null | false | none | Gets or sets the user profile type code. |
| userProfileId | string|null | false | none | Gets or sets the user profile id. |
| policyNumber | string|null | false | none | The policy number for the new policy. If left blank will use the old policy for new. |
| billingCarrierCompanyId | integer(int32)|null | false | none | The billing carrier company id. If missing, the value for billing carrier company is copied from the source policy. NOTE: simply setting the value for the carrier company underwriting the policy does NOT update this property. It is recommended that callers always set this value when renewing. |
| needsReview | boolean|null | false | none | Indicates if the new policy should be marked as needing review. If this property is null/missing, the value of the flag from the source policy is carried into the new policy. |
| policyGroupId | integer(int32)|null | false | none | The id of the policy group to add the renewed policy to. If the policy group does not exist, the renewed policy will not be added to any group. |
| policyVendorSourceId | string|null | false | none | Denotes the source ID of the vendor for the new policy (requires CarrierCompanyId to be -1). |
| policyVendorSourceType | string|null | false | none | Denotes the source type of the vendor for the new policy (requires CarrierCompanyId to be -1). |
| policyVendorSourceEntityName | string|null | false | none | Denotes the source entity name of the vendor for the new policy (requires CarrierCompanyId to be -1). |
| billingVendorSourceId | string|null | false | none | Denotes the source ID of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1). |
| billingVendorSourceType | string|null | false | none | Denotes the source type of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1). |
| billingVendorSourceEntityName | string|null | false | none | Denotes the source entity name of the billing vendor for the new policy (requires BillingCarrierCompanyId to be -1). |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"members": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
},
"isParent": {
"type": "boolean"
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| accountId | integer(int32) | false | none | none |
| name | string|null | false | none | none |
| members | [PolicyGroupMembership] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
},
"isParent": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| policyId | integer(int32) | false | none | none |
| isParent | boolean | false | none | none |
{
"type": "object",
"description": "An array of volume rates with the total premium for all.",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"description": "An array of VolumeRate",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The total monthly premium for all Items.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The total annual premium for all Items.",
"format": "decimal"
}
}
}
An array of volume rates with the total premium for all.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| items | [VolumeRate]|null | false | none | An array of VolumeRate |
| totalMonthlyPremium | number(decimal) | false | read-only | The total monthly premium for all Items. |
| totalAnnualPremium | number(decimal) | false | read-only | The total annual premium for all Items. |
{
"allOf": [
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Volume Rate data",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The record id.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | VolumeRateInfo | false | none | Volume rate create/update data |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Volume Rate data |
| » id | integer(int32) | false | none | The record id. |
{
"type": "object",
"description": "Volume rate create/update data",
"additionalProperties": false,
"required": [
"monthlyRatePerBasisAmount",
"basisAmount",
"coverageOrSalaryAmount",
"amountType",
"description"
],
"properties": {
"monthlyRatePerBasisAmount": {
"type": "number",
"description": "The rate per BasisAmount",
"format": "decimal",
"maximum": 99999.9999,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,4}$"
},
"basisAmount": {
"type": "number",
"description": "The basis amount used when applying the MonthlyRatePerBasisAmount",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"coverageOrSalaryAmount": {
"type": "number",
"description": "The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage).",
"format": "decimal",
"maximum": 99999999999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$"
},
"amountType": {
"description": "Indicates whether the BasisAmount represents Salary or Coverage.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
]
},
"description": {
"type": "string",
"description": "The description for this record. This should be unique with respect to other VolumeRate records for the policy.",
"maxLength": 255,
"minLength": 1
},
"totalMonthlyPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up.",
"format": "decimal"
},
"totalAnnualPremium": {
"type": "number",
"readOnly": true,
"description": "The calculated total annual premium for this Volume Rate record.",
"format": "decimal"
}
}
}
Volume rate create/update data
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| monthlyRatePerBasisAmount | number(decimal) | true | none | The rate per BasisAmount |
| basisAmount | number(decimal) | true | none | The basis amount used when applying the MonthlyRatePerBasisAmount |
| coverageOrSalaryAmount | number(decimal) | true | none | The total amount of coverage (can also be interpreted as salary when that is used to determine volume coverage). |
| amountType | VolumeAmountTypeOption | true | none | Indicates whether the BasisAmount represents Salary or Coverage. |
| description | string | true | none | The description for this record. This should be unique with respect to other VolumeRate records for the policy. |
| totalMonthlyPremium | number(decimal) | false | read-only | The calculated total monthly premium for this Volume Rate record. Fractional cents are rounded up. |
| totalAnnualPremium | number(decimal) | false | read-only | The calculated total annual premium for this Volume Rate record. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Salary",
"Coverage"
],
"enum": [
"Salary",
"Coverage"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Salary |
| anonymous | Coverage |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"coverageTypeId",
"description"
],
"properties": {
"coverageTypeId": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the policy coverage type.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy coverage type is archived.",
"default": false
},
"acordCode": {
"type": "string",
"description": "Gets or sets the value of the ACORD line of business code",
"maxLength": 5,
"minLength": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PolicyCoverageTypeInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the policy coverage type. |
{
"type": "object",
"additionalProperties": false,
"required": [
"coverageTypeId",
"description"
],
"properties": {
"coverageTypeId": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the policy coverage type.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy coverage type is archived.",
"default": false
},
"acordCode": {
"type": "string",
"description": "Gets or sets the value of the ACORD line of business code",
"maxLength": 5,
"minLength": 1,
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| coverageTypeId | integer(int32) | true | none | The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference. |
| description | string | true | none | The description of the policy coverage type. |
| isArchived | boolean | false | none | Indicates whether the policy coverage type is archived. |
| acordCode | string|null | false | none | Gets or sets the value of the ACORD line of business code |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"coverageTypeId",
"description"
],
"properties": {
"coverageTypeId": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type. Has a dependency on a coverage type item. Please use the coverage type endpoint for reference.",
"format": "int32"
},
"description": {
"type": "string",
"description": "The description of the policy coverage type.",
"maxLength": 50,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy coverage type is archived.",
"default": false
},
"acordCode": {
"type": "string",
"description": "Gets or sets the value of the ACORD line of business code",
"maxLength": 5,
"minLength": 1,
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy coverage type.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [PolicyCoverageType] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"basePolicyStatus",
"policyStatusType"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the policy status.",
"maxLength": 50,
"minLength": 1
},
"basePolicyStatus": {
"description": "The base policy status that this policy status derives from.\nEx. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"New",
"Retained",
"Lost"
],
"enum": [
"New",
"Retained",
"Lost"
]
}
]
},
"policyStatusType": {
"description": "The type of policy status.\nEx. Beginning, Ending",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Beginning",
"Ending"
],
"enum": [
"Beginning",
"Ending"
]
}
]
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy status is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy status.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PolicyStatusInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | The unique Zywave identifier for the policy status. |
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"basePolicyStatus",
"policyStatusType"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the policy status.",
"maxLength": 50,
"minLength": 1
},
"basePolicyStatus": {
"description": "The base policy status that this policy status derives from.\nEx. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"New",
"Retained",
"Lost"
],
"enum": [
"New",
"Retained",
"Lost"
]
}
]
},
"policyStatusType": {
"description": "The type of policy status.\nEx. Beginning, Ending",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Beginning",
"Ending"
],
"enum": [
"Beginning",
"Ending"
]
}
]
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy status is archived."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string | true | none | The description of the policy status. |
| basePolicyStatus | BasePolicyStatusOption | true | none | The base policy status that this policy status derives from. Ex. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier |
| policyStatusType | PolicyStatusTypeOption | true | none | The type of policy status. Ex. Beginning, Ending |
| isArchived | boolean | false | none | Indicates whether the policy status is archived. |
{
"type": "string",
"description": "",
"x-enumNames": [
"New",
"Retained",
"Lost"
],
"enum": [
"New",
"Retained",
"Lost"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | New |
| anonymous | Retained |
| anonymous | Lost |
{
"type": "string",
"description": "",
"x-enumNames": [
"Beginning",
"Ending"
],
"enum": [
"Beginning",
"Ending"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Beginning |
| anonymous | Ending |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"description",
"basePolicyStatus",
"policyStatusType"
],
"properties": {
"description": {
"type": "string",
"description": "The description of the policy status.",
"maxLength": 50,
"minLength": 1
},
"basePolicyStatus": {
"description": "The base policy status that this policy status derives from.\nEx. BasePolicyStatus: Retained -> PolicyStatus: Renewed - Same Carrier",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"New",
"Retained",
"Lost"
],
"enum": [
"New",
"Retained",
"Lost"
]
}
]
},
"policyStatusType": {
"description": "The type of policy status.\nEx. Beginning, Ending",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Beginning",
"Ending"
],
"enum": [
"Beginning",
"Ending"
]
}
]
},
"isArchived": {
"type": "boolean",
"description": "Indicates whether the policy status is archived."
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the policy status.",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [PolicyStatus] | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "Tiered rate info",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the tiered rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
},
{
"type": "object",
"description": "Represents a tiered rate",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the tiered rate.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | TieredRateInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Represents a tiered rate |
| » id | integer(int32) | false | none | The unique Zywave identifier for the tiered rate. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
},
{
"type": "object",
"description": "Tiered rate info",
"additionalProperties": false,
"required": [
"policyId"
],
"properties": {
"policyId": {
"type": "integer",
"description": "The identifier for the policy that is tied to the tiered rate record. Has a dependency on a policy item. Please use the policy endpoint for reference.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | TieredRateBaseInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Tiered rate info |
| » policyId | integer(int32) | true | none | The identifier for the policy that is tied to the tiered rate record. Has a dependency on a policy item. Please use the policy endpoint for reference. |
{
"type": "object",
"additionalProperties": false,
"required": [
"rateTierType"
],
"properties": {
"rateTierType": {
"description": "The identifier for the tier type that is tied to the tiered rate record. ",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
],
"enum": [
"Employee",
"EmployeeSpouse",
"EmployeeChildren",
"EmployeeFamily",
"EmployeeChild",
"EmployeeSpouseChild",
"EmployeeTwoChildren",
"EmployeeThreeChildren"
]
}
]
},
"memberCount": {
"type": "integer",
"description": "The number of people included in the tiered rate.",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"monthlyRate": {
"type": "number",
"description": "The monthly rate for the tiered rate.",
"format": "decimal",
"maximum": 99999.99,
"minimum": 0,
"pattern": "^\\d+\\.?\\d{0,2}$",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rateTierType | RateTierTypeOption | true | none | The identifier for the tier type that is tied to the tiered rate record. |
| memberCount | integer(int32)|null | false | none | The number of people included in the tiered rate. |
| monthlyRate | number(decimal)|null | false | none | The monthly rate for the tiered rate. |
{
"allOf": [
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FeeTypeInfo | false | none | Fee type info |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | true | none | none |
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
}
Fee type info
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| baseFeeType | BaseFeeTypeOption | true | none | The BaseFeeTypeOption |
| description | string | true | none | The fee description |
| isArchived | boolean | true | none | If archived |
| isDefault | boolean | true | none | If the fee type should appear in the default list |
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Administrative |
| anonymous | Agency |
| anonymous | Vendor |
| anonymous | Service |
| anonymous | Billing |
| anonymous | Other |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Fee type info",
"additionalProperties": false,
"required": [
"baseFeeType",
"description",
"isArchived",
"isDefault"
],
"properties": {
"baseFeeType": {
"description": "The BaseFeeTypeOption",
"default": "Administrative",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
],
"enum": [
"Administrative",
"Agency",
"Vendor",
"Service",
"Billing",
"Other"
]
}
]
},
"description": {
"type": "string",
"description": "The fee description",
"maxLength": 100,
"minLength": 1
},
"isArchived": {
"type": "boolean",
"description": "If archived",
"default": false
},
"isDefault": {
"type": "boolean",
"description": "If the fee type should appear in the default list",
"default": false
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [FeeType] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 150,
"minLength": 1
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"accountId"
],
"properties": {
"accountId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PolicyGroupInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » accountId | integer(int32) | true | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 150,
"minLength": 1
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"members": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"policyId": {
"type": "integer",
"format": "int32"
},
"isParent": {
"type": "boolean"
}
}
}
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [PolicyGroupWithMembers] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"isPreferred"
],
"properties": {
"benefitItemId": {
"type": "integer",
"description": "The unique identifier for the benefit item.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"isPreferred": {
"type": "boolean",
"description": "Whether the benefit item is preferred for the agency."
},
"enrollmentBookletsSync": {
"type": "boolean",
"description": "Whether the benefit item should be synced to enrollment booklets."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| benefitItemId | integer(int32) | true | none | The unique identifier for the benefit item. |
| isPreferred | boolean | true | none | Whether the benefit item is preferred for the agency. |
| enrollmentBookletsSync | boolean | false | none | Whether the benefit item should be synced to enrollment booklets. |
{
"allOf": [
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
},
{
"type": "object",
"description": "A vendor record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the vendor",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"customName": {
"type": "string",
"description": "The vendor name",
"maxLength": 255,
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | VendorInfo | false | none | Vendor info |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | A vendor record |
| » id | integer(int32) | true | none | The unique Zywave identifier for the vendor |
| » customName | string|null | false | none | The vendor name |
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
}
Vendor info
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sourceId | string | true | none | Id of vendor in source |
| sourceType | string | true | none | Type of source |
| sourceEntityName | string | true | none | Entity name in source |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Vendor info",
"additionalProperties": false,
"required": [
"sourceId",
"sourceType",
"sourceEntityName"
],
"properties": {
"sourceId": {
"type": "string",
"description": "Id of vendor in source",
"maxLength": 36,
"minLength": 1
},
"sourceType": {
"type": "string",
"description": "Type of source",
"maxLength": 32,
"minLength": 1
},
"sourceEntityName": {
"type": "string",
"description": "Entity name in source",
"maxLength": 32,
"minLength": 1
}
}
},
{
"type": "object",
"description": "A vendor record",
"additionalProperties": false,
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "The unique Zywave identifier for the vendor",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"customName": {
"type": "string",
"description": "The vendor name",
"maxLength": 255,
"nullable": true
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Vendor] | false | none | none |
{
"allOf": [
{
"type": "object",
"description": "Vendor name info",
"additionalProperties": false,
"required": [
"customName"
],
"properties": {
"customName": {
"type": "string",
"description": "The custom vendor name",
"maxLength": 255,
"minLength": 1
}
}
},
{
"type": "object",
"description": "A vendor name record",
"additionalProperties": false,
"required": [
"vendorId"
],
"properties": {
"vendorId": {
"type": "integer",
"description": "The unique Zywave identifier for the vendor",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | VendorNameInfo | false | none | Vendor name info |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | A vendor name record |
| » vendorId | integer(int32) | true | none | The unique Zywave identifier for the vendor |
{
"type": "object",
"description": "Vendor name info",
"additionalProperties": false,
"required": [
"customName"
],
"properties": {
"customName": {
"type": "string",
"description": "The custom vendor name",
"maxLength": 255,
"minLength": 1
}
}
}
Vendor name info
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customName | string | true | none | The custom vendor name |