Note
These APIs are specifically designed for customers using the Brokerage Builder solution. If you are seeking similar APIs within Zywave Cloud solutions, these may not be suitable for your needs.
title: BKB 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 /bkb/v2.0/accountcontacts/{accountContactId}
Get an account contact by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountContactId | path | integer(int32) | true | The account contact id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account contact.",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 100,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Gets or sets the birth date of this account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for the location of this account contact.",
"maxLength": 25,
"nullable": true
},
"contactStatus": {
"description": "Gets or sets the status of this account contact.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account contact was created.",
"format": "date-time",
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the two-letter country code.",
"maxLength": 2,
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account contact.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"emailAddress": {
"type": "string",
"description": "Gets or sets the e-mail address for this account contact.",
"maxLength": 100,
"nullable": true
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this account contact has been deleted."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this is primary contact for the account.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "Gets or sets the mobile phone number for the account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"modifiedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"phoneExtension": {
"type": "string",
"description": "Gets or sets the extension for an account contact's primary phone number.",
"maxLength": 10,
"nullable": true
},
"salutation": {
"type": "string",
"description": "Gets or sets the salutation that should precede the account contact's name.",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for the U.S. state/territory or the Canadian, Carribbean or Mexican province.",
"maxLength": 2,
"nullable": true
},
"title": {
"type": "string",
"description": "Gets or sets the account contact's title.",
"maxLength": 100,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account contact.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AccountContact |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /bkb/v2.0/accountcontacts/search
Search for account contacts by criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"description": "Account contact search criteria",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"description": "Gets or sets the criteria used to search for account contacts by \"Account ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"address1": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 1.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address2": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 2.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address3": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 3.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"birthDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Birth date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"city": {
"description": "Gets or sets the criteria used to search for account contacts by \"City.\"\nMaximum of 25 characters.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"country": {
"description": "Gets or sets the criteria used to search for account contacts by \"Country.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Created date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"contactStatus": {
"description": "Gets or sets the criteria used to search for account contacts by \"Contact status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for account contacts by a custom field.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"emailAddress": {
"description": "Gets or sets the criteria used to search for account contacts by \"E-mail address.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"fax": {
"description": "Gets or sets the criteria used to search for account contacts by \"Fax.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"firstName": {
"description": "Gets or sets the criteria used to search for account contacts by \"First name.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the criteria used to search for account contacts by \"ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"isPrimaryContact": {
"description": "Gets or sets the criteria used to search for accounts based on \"Primary contact status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"lastName": {
"description": "Gets or sets the criteria used to search for accounts by \"Last name.\"\nMaximum of 25 characters.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"mobilePhone": {
"description": "Gets or sets the criteria used to search for account contacts by \"Mobile phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"modifiedDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Modified date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"phone": {
"description": "Gets or sets the criteria used to search for account contacts by \"Phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"phoneExtension": {
"description": "Gets or sets the criteria used to search for account contacts by \"Phone extension.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"salutation": {
"description": "Gets or sets the criteria used to search for account contacts by \"Salutation\".",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"stateProvince": {
"description": "Gets or sets the criteria used to search account contacts by \"State.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"title": {
"description": "Gets or sets the criteria used to search account contacts by \"Title.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"zipPostalCode": {
"description": "Gets or sets the criteria used to search for account contacts by \"ZIP/Postal code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"description": "Account contact search options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountContactSearchModel | true | The AccountContactSearchModel. |
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,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account contact.",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 100,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Gets or sets the birth date of this account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for the location of this account contact.",
"maxLength": 25,
"nullable": true
},
"contactStatus": {
"description": "Gets or sets the status of this account contact.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account contact was created.",
"format": "date-time",
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the two-letter country code.",
"maxLength": 2,
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account contact.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"emailAddress": {
"type": "string",
"description": "Gets or sets the e-mail address for this account contact.",
"maxLength": 100,
"nullable": true
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this account contact has been deleted."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this is primary contact for the account.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "Gets or sets the mobile phone number for the account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"modifiedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"phoneExtension": {
"type": "string",
"description": "Gets or sets the extension for an account contact's primary phone number.",
"maxLength": 10,
"nullable": true
},
"salutation": {
"type": "string",
"description": "Gets or sets the salutation that should precede the account contact's name.",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for the U.S. state/territory or the Canadian, Carribbean or Mexican province.",
"maxLength": 2,
"nullable": true
},
"title": {
"type": "string",
"description": "Gets or sets the account contact's title.",
"maxLength": 100,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account contact.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountContact |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
GET /bkb/v2.0/accounts/{accountId}
Get an account by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | integer(int32) | true | The account id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
},
{
"type": "object",
"description": "Account",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Account |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| default | Default | none | ProblemDetails |
GET /bkb/v2.0/accounts/customfields
Get custom field definitions for accounts.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"fieldType": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
],
"enum": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"includeOnRfp": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"lookups": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
},
"name": {
"type": "string",
"nullable": true
},
"showInAmc": {
"type": "boolean"
},
"showOnAccountHomePage": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CustomField] | false | none | none |
| » brokerId | integer(int32) | false | none | none |
| » fieldType | FieldType | false | none | none |
| » id | integer(int32) | false | none | none |
| » includeOnRfp | boolean | false | none | none |
| » isDeleted | boolean | false | none | none |
| » isRequired | boolean | false | none | none |
| » lookups | [Lookup]|null | false | none | none |
| »» customFieldId | integer(int32) | false | none | none |
| »» description | string|null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» sortOrder | integer(int32) | false | none | none |
| » name | string|null | false | none | none |
| » showInAmc | boolean | false | none | none |
| » showOnAccountHomePage | boolean | false | none | none |
| » sortOrder | integer(int32) | false | none | none |
| Property | Value |
|---|---|
| fieldType | Unknown |
| fieldType | AlphaNumeric |
| fieldType | Numeric |
| fieldType | Date |
| fieldType | DropDownList |
| fieldType | YesNo |
| fieldType | StatesProvinces |
| fieldType | |
| fieldType | Phone |
| fieldType | Paragraph |
| fieldType | Currency |
POST /bkb/v2.0/accounts/search
Search for accounts using criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "AccountSearchCriteria",
"additionalProperties": false,
"properties": {
"accountStatus": {
"description": "Gets or sets the criteria used to search accounts by \"BrokerageBuilder Status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
]
},
"address1": {
"description": "Gets or sets the criteria used to search for accounts by \"Address 1.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address2": {
"description": "Gets or sets the criteria used to search for accounts by \"Address 2.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address3": {
"description": "Gets or sets the criteria used to search for accounts by the \"Address 3.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"clientCode": {
"description": "Gets or sets the criteria used to search for accounts by \"AMS ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"benchmarkEmployees": {
"description": "Gets or sets the criteria used to search for accounts by \"Benchmark employees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
}
}
}
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the criteria used to search for accounts by \"Benchmark industry.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
}
}
}
]
}
]
},
"businessLine": {
"description": "Gets or sets the criteria used to search for accounts by \"Business line.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"classification": {
"description": "Gets or sets the criteria used to search for accounts by \"Client type.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
}
}
}
]
}
]
},
"county": {
"description": "Gets or sets the criteria used to search for accounts by \"County.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"country": {
"description": "Gets or sets the criteria used to search for accounts by \"Country.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"city": {
"description": "Gets or sets the criteria used to search for accounts by \"City.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdDate": {
"description": "Gets or sets the criteria used to search for accounts by \"Created date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for account by a custom field.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"fax": {
"description": "Gets or sets the criteria used to search for accounts by \"Fax.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the criteria used to search for accounts based on \"ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"isBenefitClient": {
"description": "Gets or sets the criteria used to search for accounts based on \"Benefits client status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"isBenefitProspect": {
"description": "Gets or sets the criteria used to search for accounts based on \"Benefits prospect status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"productType": {
"description": "Gets or sets the criteria used to search for accounts based on \"Product type.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
}
}
}
]
}
]
},
"lastUpdatedDate": {
"description": "Gets or sets the criteria used to search accounts by \"Last updated date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"name": {
"description": "Gets or sets the criteria used to search for accounts by \"Name.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"numberOfEmployees": {
"description": "Gets or sets the criteria used to search accounts by \"Number of employees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"numberOfRetirees": {
"description": "Gets or sets the criteria used to search accounts by \"Number of retirees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"phone": {
"description": "Gets or sets the criteria used to search for accounts by \"Phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"producerId": {
"description": "Gets or sets the criteria used to search for accounts by \"Producer ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"sicCode": {
"description": "Gets or sets the criteria used to search for accounts by \"SIC code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"stateProvince": {
"description": "Gets or sets the criteria used to search accounts by \"State.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"brokerageBuilderStatus": {
"description": "Gets or sets the criteria used to search accounts by \"TBD.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
}
}
}
]
}
]
},
"url": {
"description": "Gets or sets the criteria used to search for accounts by \"URL.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"yearFounded": {
"description": "Gets or sets the criteria used to search for accounts by \"Year founded.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"zipPostalCode": {
"description": "Gets or sets the criteria used to search for accounts by \"ZIP/Postal code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | AccountSearchModel | true | The AccountSearchModel. |
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": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
},
{
"type": "object",
"description": "Account",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccount |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
PUT /bkb/v2.0/accounts/update/{accountId}
Update an account by id.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"account": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
}
]
},
"crudOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | integer(int32) | true | none |
| body | body | UpdateAccountModel | true | The Account. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
},
{
"type": "object",
"description": "Account",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Account |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| default | Default | none | ProblemDetails |
POST /bkb/v2.0/activities/search
Search for activities using criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Search Criteria for Id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"activityBaseType": {
"description": "Gets or sets the type of the activity base.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"activityTypeId": {
"description": "Gets or sets the activity type id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"accountId": {
"description": "Gets or sets the account id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"censusId": {
"description": "Gets or sets the census id. This can also be refered to as the EmployeeId.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"businessEntityId": {
"description": "Gets or sets the business entity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"accountContactId": {
"description": "Gets or sets the account contact id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"rfpId": {
"description": "Gets or sets the RFP id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planId": {
"description": "Gets or sets the plan id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"proposalId": {
"description": "Gets or sets the proposal id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"massActivityId": {
"description": "Gets or sets the mass activity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"timeSpent": {
"description": "Gets or sets the time spent.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"dueDate": {
"description": "Gets or sets the due date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isOpen": {
"description": "Gets or sets the is open.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"closedDate": {
"description": "Gets or sets the closed date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"subject": {
"description": "Gets or sets the subject.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdById": {
"description": "Gets or sets the created by id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createDate": {
"description": "Gets or sets the create date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedById": {
"description": "Gets or sets the last updated by id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"lastUpdate": {
"description": "Gets or sets the last update.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"assignedUsers": {
"description": "Gets or sets the assigned users.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"notifiedUsers": {
"description": "Gets or sets the notified users.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"hasWorkflowItems": {
"description": "Gets or sets the has workflow items.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"recurrenceId": {
"description": "Gets or sets the recurrence id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"brokerCarrierLinkId": {
"description": "Gets or sets the broker carrier link id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"employeeName": {
"description": "Gets or sets the name of the employee.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"accountLocationId": {
"description": "Gets or sets the account location id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"opportunityId": {
"description": "Gets or sets the opportunity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ActivitySearchModel | true | The ActivitySearchModel. |
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",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfActivity |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
POST /bkb/v2.0/activities/activitytypes/search
Search for activity types using criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Gets or sets the id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"name": {
"description": "Gets or sets the name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"brokerId": {
"description": "Gets or sets the broker id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"sortOrder": {
"description": "Gets or sets the sort order.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isDeleted": {
"description": "Gets or sets the is deleted.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"followUpDateInterval": {
"description": "Gets or sets the follow up date interval.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"allowOverride": {
"description": "Gets or sets the allow override.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"isReserved": {
"description": "Gets or sets the is reserved.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"defaultClosed": {
"description": "Gets or sets the default closed.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnBenefitClients": {
"description": "Gets or sets the show on benefit clients.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnPCClients": {
"description": "Gets or sets the show on PC clients.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnBenefitProspects": {
"description": "Gets or sets the show on benefit prospects.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnPCProspects": {
"description": "Gets or sets the show on PC prospects.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnLeads": {
"description": "Gets or sets the show on leads.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"activityBaseType": {
"description": "Gets or sets the type of the activity base.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ActivityTypeSearchModel | true | The ActivityTypeSearchModel. |
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",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfActivity |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
POST /bkb/v2.0/activities
Create an activity.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"activity": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
]
},
"crudOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | ActivityUpdateModel | true | The ActivityUpdateModel. |
Example responses
200 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | integer |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
GET /bkb/v2.0/activities/{activityId}
Get an activity by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer(int32) | true | The activity id. |
| includeCustomFields | query | boolean | false | "To include custom fields or not". |
Example responses
200 Response
{
"type": "object",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Activity |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| default | Default | none | ProblemDetails |
PUT /bkb/v2.0/activities/{activityId}
Update an activity.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"activity": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
]
},
"crudOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer(int32) | true | The activity id. |
| body | body | ActivityUpdateModel | true | The ActivityUpdateModel. |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| 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 |
| default | Default | none | ProblemDetails |
DELETE /bkb/v2.0/activities/{activityId}
Delete an activity.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| activityId | path | integer(int32) | true | The activity id. |
| body | body | CrudOptions | false | The options. |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /bkb/v2.0/audits
Returns paginated audit event history showing who performed what action and when. At least one of fileId or folderId required. Enforces tenant isolation; returns 404 on cross-tenant resource access.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| FileId | query | string(guid) | false | UUID of file to audit; optional unless FolderId absent. |
| FolderIdentifier | query | string(guid) | false | UUID of folder to audit; optional unless FileId absent. |
| EntityType | query | any | false | Owner entity type; required when FolderIdentifier is provided. |
| PageIndex | query | integer(int32) | false | 1-based page number; minimum value is 1. |
| PageSize | query | integer(int32) | false | Results per page; maximum allowed value is 100. |
Example responses
200 Response
{
"allOf": [
{
"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": {
"folderId": {
"type": "string",
"description": "UUID of folder containing the audited files.",
"format": "guid"
},
"folderLocation": {
"type": "string",
"description": "Full path within the entity hierarchy."
},
"folderName": {
"type": "string",
"description": "Display name of this folder."
},
"files": {
"type": "array",
"description": "Files with their audit histories inside folder.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier of the audited file.",
"format": "guid"
},
"fileName": {
"type": "string",
"description": "Display name including file extension."
},
"audits": {
"type": "array",
"description": "Ordered list of audit events; newest first.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"actionPerformed": {
"type": "string",
"description": "Verb describing event; e.g., Uploaded, Moved."
},
"actionPerformedBy": {
"type": "string",
"description": "Username who performed this specific action."
},
"actionPerformedDate": {
"type": "string",
"description": "UTC ISO 8601 timestamp of the action.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "File status at time of this action."
}
}
}
}
}
}
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the paged audit history. | AuditPagedResult |
| 400 | Bad Request | Bad Request — neither FileId nor FolderId provided, entityType absent when FolderIdentifier present, or pageSize exceeds 100. | ProblemDetails |
| 401 | Unauthorized | Unauthorized — invalid or expired JWT. | ProblemDetails |
| 403 | Forbidden | Forbidden — insufficient scope or tenant access denied. | ProblemDetails |
| 404 | Not Found | Not Found — file or folder does not exist or belongs to another tenant. | ProblemDetails |
| 502 | Bad Gateway | Bad Gateway — AuditTrailEventsAPI is unavailable. | None |
| default | Default | none | ProblemDetails |
GET /bkb/v2.0/plans/{planId}/benefititemvalues
Get the benefit item values for a plan.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | the plan id. |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"planTypeBenefitItemTierId",
"planId",
"benefitItemValueTypeId",
"updatedUserId"
],
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"planId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
},
"customText": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"value": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemValueId"
],
"properties": {
"benefitItemValueId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | 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 | any | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | BulkBenefitItemValueInfo | false | none | none |
| »»» benefitItemId | integer(int32) | true | none | none |
| »»» planTypeBenefitItemTierId | integer(int32) | true | none | none |
| »»» planId | integer(int32) | true | none | none |
| »»» benefitItemValueTypeId | integer(int32) | true | none | none |
| »»» customText | string|null | false | none | none |
| »»» value | string|null | false | none | none |
| »»» effectiveDate | string(date-time)|null | false | none | none |
| »»» updatedUserId | string(guid) | true | none | none |
| »»» updatedDateTime | string(date-time)|null | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| »» anonymous | object | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | none |
| »» benefitItemValueId | integer(int32) | true | none | none |
POST /bkb/v2.0/plans/{planId}/benefititemvalues
Creates a benefit item value under a given plan.
Body parameter
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"customText": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| body | body | BenefitItemValueInfo2 | true | The BenefitItemValueInfo |
Example responses
201 Response
{
"type": "integer",
"format": "int32"
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | integer |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /bkb/v2.0/plans/{planId}/benefititemvalues/{benefitItemValueId}
Gets a benefit item value for a given plan
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| benefitItemValueId | path | integer(int32) | true | The benefit item value id. |
Example responses
200 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"planTypeBenefitItemTierId",
"planId",
"benefitItemValueTypeId",
"updatedUserId"
],
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"planId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
},
"customText": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"value": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemValueId"
],
"properties": {
"benefitItemValueId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BenefitItemValue |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /bkb/v2.0/plans/{planId}/benefititemvalues/{benefitItemValueId}
Updates a benefit item value under a given plan.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"customText": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| benefitItemValueId | path | integer(int32) | true | The benefit item value id. |
| body | body | BenefitItemValueUpdateInfo | true | The BenefitItemValueUpdateInfo |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
},
{
"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 |
DELETE /bkb/v2.0/plans/{planId}/benefititemvalues/{benefitItemValueId}
Deletes a benefit item value under a given plan.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| benefitItemValueId | path | integer(int32) | true | The benefit item value 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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /bkb/v2.0/plans/plantypes/{planTypeId}/benefititems
Get the benefit items for a plan type
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planTypeId | path | integer(int32) | true | none |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"isRequired": {
"type": "boolean"
},
"isImportant": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"isArchived": {
"type": "boolean"
},
"updatedDateTime": {
"type": "string",
"format": "date-time"
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"planTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"benefitItemTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BenefitItem] | false | none | none |
| » id | integer(int32) | false | none | none |
| » isRequired | boolean | false | none | none |
| » isImportant | boolean | false | none | none |
| » sortOrder | integer(int32) | false | none | none |
| » isArchived | boolean | false | none | none |
| » updatedDateTime | string(date-time) | false | none | none |
| » updatedUserId | string(guid) | false | none | none |
| » name | string | false | none | none |
| » planTypeId | integer(int32)|null | false | none | none |
| » benefitItemTypeId | integer(int32)|null | false | none | none |
| » parentBenefitItemId | integer(int32)|null | false | none | none |
GET /bkb/v2.0/plans/plantypes/{planTypeId}/plantypebenefititemtiers
Get the plan type benefit item tiers for a plan type
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planTypeId | path | integer(int32) | true | none |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"planTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string"
},
"benefitItemTierId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"isArchived": {
"type": "boolean"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [PlanTypeBenefitItemTier] | false | none | none |
| » id | integer(int32) | false | none | none |
| » planTypeId | integer(int32)|null | false | none | none |
| » name | string | false | none | none |
| » benefitItemTierId | integer(int32) | false | none | none |
| » sortOrder | integer(int32) | false | none | none |
| » isArchived | boolean | false | none | none |
GET /bkb/v2.0/benefititems/benefititemvaluetypes
Returns the list of benefit item value types
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name",
"sortOrder",
"defaultFormat"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"defaultFormat": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BenefitItemValueType] | false | none | none |
| » id | integer(int32) | false | none | none |
| » name | string | true | none | none |
| » sortOrder | integer(int32) | true | none | none |
| » defaultFormat | string | true | none | none |
GET /bkb/v2.0/brokercontacts/all
Gets all contacts for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"amsCsrid": {
"type": "string",
"nullable": true
},
"amsProducerID": {
"type": "string",
"nullable": true
},
"allowAccountAdd": {
"type": "boolean"
},
"allowAccountDelete": {
"type": "boolean"
},
"allowAdminMenuManagement": {
"type": "boolean"
},
"allowCarrierManagement": {
"type": "boolean"
},
"allowDeleteFiles": {
"type": "boolean"
},
"altMailingAddressId": {
"type": "integer",
"format": "int32"
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"designation": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"faxNumber": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"hasBKBAccess": {
"type": "boolean"
},
"hasGlobalAccess": {
"type": "boolean"
},
"homePageViewID": {
"type": "string",
"description": "",
"x-enumNames": [
"NotSet",
"Account",
"Sales"
],
"enum": [
"NotSet",
"Account",
"Sales"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"isBuilderAdministrator": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"lastName": {
"type": "string",
"nullable": true
},
"lineOfBusinessId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"middleInitial": {
"type": "string",
"nullable": true
},
"numberOfActivitiesShown": {
"type": "integer",
"format": "int32"
},
"parentBrokerContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"reportAccess": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Team",
"All"
],
"enum": [
"None",
"Team",
"All"
]
},
"roleId": {
"type": "string",
"format": "guid",
"nullable": true
},
"salutation": {
"type": "string",
"nullable": true
},
"suppressFromClients": {
"type": "boolean"
},
"title": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"viewAgreementDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BrokerContact] | false | none | none |
| » amsCsrid | string|null | false | none | none |
| » amsProducerID | string|null | false | none | none |
| » allowAccountAdd | boolean | false | none | none |
| » allowAccountDelete | boolean | false | none | none |
| » allowAdminMenuManagement | boolean | false | none | none |
| » allowCarrierManagement | boolean | false | none | none |
| » allowDeleteFiles | boolean | false | none | none |
| » altMailingAddressId | integer(int32) | false | none | none |
| » brokerId | integer(int32) | false | none | none |
| » designation | string|null | false | none | none |
| » emailAddress | string|null | false | none | none |
| » faxNumber | string|null | false | none | none |
| » firstName | string|null | false | none | none |
| » hasBKBAccess | boolean | false | none | none |
| » hasGlobalAccess | boolean | false | none | none |
| » homePageViewID | HomePageViews | false | none | none |
| » id | integer(int32) | false | none | none |
| » isBuilderAdministrator | boolean | false | none | none |
| » isDeleted | boolean | false | none | none |
| » lastName | string|null | false | none | none |
| » lineOfBusinessId | integer(int32)|null | false | none | none |
| » middleInitial | string|null | false | none | none |
| » numberOfActivitiesShown | integer(int32) | false | none | none |
| » parentBrokerContactId | integer(int32)|null | false | none | none |
| » phoneNumber | string|null | false | none | none |
| » reportAccess | Permission | false | none | none |
| » roleId | string(guid)|null | false | none | none |
| » salutation | string|null | false | none | none |
| » suppressFromClients | boolean | false | none | none |
| » title | string|null | false | none | none |
| » username | string|null | false | none | none |
| » viewAgreementDate | string(date-time)|null | false | none | none |
| Property | Value |
|---|---|
| homePageViewID | NotSet |
| homePageViewID | Account |
| homePageViewID | Sales |
| reportAccess | None |
| reportAccess | Team |
| reportAccess | All |
GET /bkb/v2.0/brokercontacts/active
Gets active contacts for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"amsCsrid": {
"type": "string",
"nullable": true
},
"amsProducerID": {
"type": "string",
"nullable": true
},
"allowAccountAdd": {
"type": "boolean"
},
"allowAccountDelete": {
"type": "boolean"
},
"allowAdminMenuManagement": {
"type": "boolean"
},
"allowCarrierManagement": {
"type": "boolean"
},
"allowDeleteFiles": {
"type": "boolean"
},
"altMailingAddressId": {
"type": "integer",
"format": "int32"
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"designation": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"faxNumber": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"hasBKBAccess": {
"type": "boolean"
},
"hasGlobalAccess": {
"type": "boolean"
},
"homePageViewID": {
"type": "string",
"description": "",
"x-enumNames": [
"NotSet",
"Account",
"Sales"
],
"enum": [
"NotSet",
"Account",
"Sales"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"isBuilderAdministrator": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"lastName": {
"type": "string",
"nullable": true
},
"lineOfBusinessId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"middleInitial": {
"type": "string",
"nullable": true
},
"numberOfActivitiesShown": {
"type": "integer",
"format": "int32"
},
"parentBrokerContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"reportAccess": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Team",
"All"
],
"enum": [
"None",
"Team",
"All"
]
},
"roleId": {
"type": "string",
"format": "guid",
"nullable": true
},
"salutation": {
"type": "string",
"nullable": true
},
"suppressFromClients": {
"type": "boolean"
},
"title": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"viewAgreementDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BrokerContact] | false | none | none |
| » amsCsrid | string|null | false | none | none |
| » amsProducerID | string|null | false | none | none |
| » allowAccountAdd | boolean | false | none | none |
| » allowAccountDelete | boolean | false | none | none |
| » allowAdminMenuManagement | boolean | false | none | none |
| » allowCarrierManagement | boolean | false | none | none |
| » allowDeleteFiles | boolean | false | none | none |
| » altMailingAddressId | integer(int32) | false | none | none |
| » brokerId | integer(int32) | false | none | none |
| » designation | string|null | false | none | none |
| » emailAddress | string|null | false | none | none |
| » faxNumber | string|null | false | none | none |
| » firstName | string|null | false | none | none |
| » hasBKBAccess | boolean | false | none | none |
| » hasGlobalAccess | boolean | false | none | none |
| » homePageViewID | HomePageViews | false | none | none |
| » id | integer(int32) | false | none | none |
| » isBuilderAdministrator | boolean | false | none | none |
| » isDeleted | boolean | false | none | none |
| » lastName | string|null | false | none | none |
| » lineOfBusinessId | integer(int32)|null | false | none | none |
| » middleInitial | string|null | false | none | none |
| » numberOfActivitiesShown | integer(int32) | false | none | none |
| » parentBrokerContactId | integer(int32)|null | false | none | none |
| » phoneNumber | string|null | false | none | none |
| » reportAccess | Permission | false | none | none |
| » roleId | string(guid)|null | false | none | none |
| » salutation | string|null | false | none | none |
| » suppressFromClients | boolean | false | none | none |
| » title | string|null | false | none | none |
| » username | string|null | false | none | none |
| » viewAgreementDate | string(date-time)|null | false | none | none |
| Property | Value |
|---|---|
| homePageViewID | NotSet |
| homePageViewID | Account |
| homePageViewID | Sales |
| reportAccess | None |
| reportAccess | Team |
| reportAccess | All |
POST /bkb/v2.0/carriers/search
Search for carriers based on the criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Criteria used to search for BrokerageBuilder carriers",
"additionalProperties": false,
"properties": {
"amBestRating": {
"description": "Gets or sets the search criteria used to find a carrier by A.M. Best rating.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the search criteria used to find a carrier by ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"name": {
"description": "Gets or sets the search criteria used to find a carrier by carrier name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"websiteUrl": {
"description": "Gets or sets the search criteria used to find a carrier using the Web site URL.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CarrierSearchModel | true | The CarrierSearchModel. |
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",
"description": "Gets the BrokerageBuilder carrier.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this BrokerageBuilder carrier.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name of the carrier.",
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this carrier has been deleted."
},
"amBestRating": {
"type": "string",
"description": "Gets or sets the financial strength rating as designated by A.M. Best Co. for this carrier.",
"nullable": true
},
"websiteUrl": {
"type": "string",
"description": "Gets or sets the Web site URL for this carrier.",
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfCarrier |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /bkb/v2.0/carriers/carriercontacts/{carrierContactId}
Gets the carrier contact by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| carrierContactId | path | integer(int32) | true | The carrier contact id. |
Example responses
200 Response
{
"type": "object",
"description": "Carrier Contact",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique ID for this carrier contact.",
"format": "int32"
},
"carrierId": {
"type": "integer",
"description": "Gets the unique ID for this carrier.",
"format": "int32",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets the first name of the carrier contact."
},
"lastName": {
"type": "string",
"description": "Gets the last name of the carrier contact."
},
"department": {
"type": "string",
"description": "Gets the department this carrier contact is a part of."
},
"jobDesc": {
"type": "string",
"description": "Gets the job description for this carrier contact."
},
"phone": {
"type": "string",
"description": "Gets the phone number for this carrier contact."
},
"phone2": {
"type": "string",
"description": "Gets the phone number for this carrier contact."
},
"phoneExtension": {
"type": "string",
"description": "Gets the phone extension for this carrier contact."
},
"phoneExtension2": {
"type": "string",
"description": "Gets the phone extension for this carrier contact."
},
"fax": {
"type": "string",
"description": "Gets the fax number for this carrier contact."
},
"email": {
"type": "string",
"description": "Gets the e-mail address for this carrier contact."
},
"defaultContact": {
"type": "boolean",
"description": "Gets a value that indicates if the contact is the default contact.",
"nullable": true
},
"address": {
"type": "string",
"description": "Gets the street address for this carrier contact."
},
"address2": {
"type": "string",
"description": "Gets the second address line for this carrier contact."
},
"city": {
"type": "string",
"description": "Gets the city for this carrier contact location."
},
"state": {
"type": "string",
"description": "Gets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province."
},
"zip": {
"type": "string",
"description": "Gets the ZIP for this carrier contact location."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this carrier contact has been deleted."
},
"roleId": {
"type": "integer",
"description": "Gets the unique role ID for this carrier contact.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets the date on which this carrier contact was last updated.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | CarrierContact |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| default | Default | none | ProblemDetails |
POST /bkb/v2.0/carriers/carriercodes/search
Search for carrier codes based on the criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "The search criteria used to find a business entity or carrier in BrokerageBuilder by the linked internal codes.",
"additionalProperties": false,
"properties": {
"alternateName": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by alternate carrier name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"code": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by AMS carrier code.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"carrierId": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by carrier ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by carrier code ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CarrierCodeSearchModel | true | The CarrierCodeSearchModel. |
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",
"description": "Gets the BrokerageBuilder carrier along with the internal code.",
"additionalProperties": false,
"properties": {
"alternateName": {
"type": "string",
"description": "Gets the alternate name of the carrier with the code.",
"nullable": true
},
"code": {
"type": "string",
"description": "Gets or sets the carrier code - the carrier ID as entered in a third-party system.",
"nullable": true
},
"carrierId": {
"type": "integer",
"description": "Gets the unique ID for this BrokerageBuilder carrier.",
"format": "int32"
},
"id": {
"type": "integer",
"description": "Gets the unique code ID.",
"format": "int32"
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this carrier code has been deleted."
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfCarrierCode |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /bkb/v2.0/commissions/compensationtypes
Gets compensation types for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "CompensationType",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID.",
"format": "int32"
},
"brokerId": {
"type": "integer",
"description": "Gets or sets the broker ID.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets the description."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has been deleted."
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CompensationType] | false | none | [CompensationType] |
| » id | integer(int32) | false | none | Gets or sets the unique ID. |
| » brokerId | integer(int32) | false | none | Gets or sets the broker ID. |
| » description | string | false | none | Gets the description. |
| » isDeleted | boolean | false | none | Gets or sets a value indicating whether this instance has been deleted. |
GET /bkb/v2.0/commissions/commissionschedules
Gets commission schedules for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Gets the carrier commission schedule.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique ID for this commission schedule.",
"format": "int32"
},
"newOrRenewal": {
"description": "Gets the renewal type applied to this schedule.",
"oneOf": [
{
"type": "string",
"description": "Commission Schedule Renewal Types",
"x-enumNames": [
"Renewal",
"New",
"Both"
],
"enum": [
"Renewal",
"New",
"Both"
]
}
]
},
"accountId": {
"type": "integer",
"description": "Gets the specific account that this commission schedule applies to.",
"format": "int32",
"nullable": true
},
"effectiveDate": {
"type": "string",
"description": "Gets the effective date for this commission schedule.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "Gets the expiration date for this commission schedule.",
"format": "date-time",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets the plan type that this commission schedule applies to.",
"format": "int32"
},
"scheduleType": {
"description": "Gets or sets the schedule type for this commission schedule.",
"oneOf": [
{
"type": "string",
"description": "Commission Schedule Types.",
"x-enumNames": [
"Flat",
"Graded",
"SubscriberBased"
],
"enum": [
"Flat",
"Graded",
"SubscriberBased"
]
}
]
},
"name": {
"type": "string",
"description": "Gets the name of this commission schedule.",
"nullable": true
},
"carrierId": {
"type": "integer",
"description": "Gets the ID for the carrier related to this commission schedule.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets the description for this commission schedule.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets the ID for the user who created this commission schedule.",
"format": "int32"
},
"createdDate": {
"type": "string",
"description": "Gets the date and time on which this commission schedule was created.",
"format": "date-time"
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets the date on which this commission schedule last updated by ID.",
"format": "int32",
"nullable": true
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time on which this commission schedule was last updated.",
"format": "date-time",
"nullable": true
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CommissionSchedule] | false | none | [Gets the carrier commission schedule.] |
| » id | integer(int32) | false | none | Gets the unique ID for this commission schedule. |
| » newOrRenewal | ScheduleRenewalTypes | false | none | Gets the renewal type applied to this schedule. |
| » accountId | integer(int32)|null | false | none | Gets the specific account that this commission schedule applies to. |
| » effectiveDate | string(date-time) | false | none | Gets the effective date for this commission schedule. |
| » expirationDate | string(date-time)|null | false | none | Gets the expiration date for this commission schedule. |
| » planTypeId | integer(int32) | false | none | Gets the plan type that this commission schedule applies to. |
| » scheduleType | ScheduleTypes | false | none | Gets or sets the schedule type for this commission schedule. |
| » name | string|null | false | none | Gets the name of this commission schedule. |
| » carrierId | integer(int32) | false | none | Gets the ID for the carrier related to this commission schedule. |
| » description | string|null | false | none | Gets the description for this commission schedule. |
| » createdById | integer(int32) | false | none | Gets the ID for the user who created this commission schedule. |
| » createdDate | string(date-time) | false | none | Gets the date and time on which this commission schedule was created. |
| » lastUpdatedById | integer(int32)|null | false | none | Gets the date on which this commission schedule last updated by ID. |
| » lastUpdatedDate | string(date-time)|null | false | none | Gets the date and time on which this commission schedule was last updated. |
| Property | Value |
|---|---|
| newOrRenewal | Renewal |
| newOrRenewal | New |
| newOrRenewal | Both |
| scheduleType | Flat |
| scheduleType | Graded |
| scheduleType | SubscriberBased |
GET /bkb/v2.0/plans/{planId}/commissionsplits
Gets commission splits for a plan.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Plan Commission Split",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this commission split.",
"format": "int32"
},
"effectiveDate": {
"type": "string",
"description": "Gets or sets the effective date for this commission split.",
"format": "date-time"
},
"percentage": {
"type": "number",
"description": "Gets or sets the commission percentage for the producer.",
"format": "decimal"
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the commission producer.",
"format": "int32"
},
"compensationTypeId": {
"type": "integer",
"description": "Gets or sets the producer compensation type.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the plan the commission split is for.",
"format": "int32"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CommissionSplit] | false | none | [Plan Commission Split] |
| » id | integer(int32) | false | none | Gets or sets the unique ID for this commission split. |
| » effectiveDate | string(date-time) | false | none | Gets or sets the effective date for this commission split. |
| » percentage | number(decimal) | false | none | Gets or sets the commission percentage for the producer. |
| » commissionProducerId | integer(int32) | false | none | Gets or sets the commission producer. |
| » compensationTypeId | integer(int32)|null | false | none | Gets or sets the producer compensation type. |
| » planId | integer(int32) | false | none | Gets or sets the plan the commission split is for. |
POST /bkb/v2.0/commissionstatements/search
Searches for commission statements based on criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "The search criteria to search for commission statement objects",
"additionalProperties": false,
"properties": {
"id": {
"description": "Gets or sets the unique ID for this search criteria.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"carrierId": {
"description": "Gets or sets the carrier ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"checkNumber": {
"description": "Gets or sets the check number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"depositDate": {
"description": "Gets or sets the deposit date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isPosted": {
"description": "Gets or sets a value indicating whether this instance has been posted.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"postedDate": {
"description": "Gets or sets the posted date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"statementDate": {
"description": "Gets or sets the statement date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"statementNumber": {
"description": "Gets or sets the statement number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"statementTotal": {
"description": "Gets or sets the statement total.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CommissionStatementSearchModel | true | The CommissionStatementSearchModel. |
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",
"description": "Carrier CommissionStatement",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this statement.",
"format": "int32"
},
"carrierId": {
"type": "integer",
"description": "Gets or sets the carrier ID associated with this statement.",
"format": "int32"
},
"checkNumber": {
"type": "string",
"description": "Gets or sets the check number for the payment of the commission.",
"nullable": true
},
"depositDate": {
"type": "string",
"description": "Gets or sets the date on which the commission dollars were deposited.",
"format": "date-time"
},
"isPosted": {
"type": "boolean",
"description": "Gets a value indicating whether this instance is posted."
},
"postedById": {
"type": "integer",
"description": "Gets the ID of the user who posted the statement.",
"format": "int32",
"nullable": true
},
"postedDate": {
"type": "string",
"description": "Gets the date and time the statement was posted.",
"format": "date-time",
"nullable": true
},
"statementDate": {
"type": "string",
"description": "Gets or sets the statement date.",
"format": "date-time"
},
"statementNumber": {
"type": "string",
"description": "Gets or sets the number from the statement.",
"nullable": true
},
"statementTotal": {
"type": "number",
"description": "Gets or sets the total commission paid out (amount of the check).",
"format": "decimal"
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfCommissionStatement |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /bkb/v2.0/commissionstatements/{commissionStatementId}/actualcommissions
Gets actual commissions for specified commission statement id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| commissionStatementId | path | integer(int32) | true | The commission statement id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Actual Commission Reconciliation",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this actual commission.",
"format": "int32"
},
"commissionAmount": {
"type": "number",
"description": "Gets or sets the actual commission amount received.",
"format": "decimal"
},
"commissionStatementId": {
"type": "integer",
"description": "Gets or sets the ID of the commission statement.",
"format": "int32"
},
"expectedCommissionId": {
"type": "integer",
"description": "Gets or sets the ID of the expected commission.",
"format": "int32"
},
"premiumAmount": {
"type": "number",
"description": "Gets or sets the actual premium amount.",
"format": "decimal"
},
"planId": {
"type": "integer",
"description": "Gets or sets the plan ID for the commission is recorded for.",
"format": "int32"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ActualCommission] | false | none | [Actual Commission Reconciliation] |
| » id | integer(int32) | false | none | Gets or sets the unique ID for this actual commission. |
| » commissionAmount | number(decimal) | false | none | Gets or sets the actual commission amount received. |
| » commissionStatementId | integer(int32) | false | none | Gets or sets the ID of the commission statement. |
| » expectedCommissionId | integer(int32) | false | none | Gets or sets the ID of the expected commission. |
| » premiumAmount | number(decimal) | false | none | Gets or sets the actual premium amount. |
| » planId | integer(int32) | false | none | Gets or sets the plan ID for the commission is recorded for. |
GET /bkb/v2.0/file/download
Downloads the binary content of a file attached to an entity as octet-stream. Provide the entityId and fileId returned from the upload response Location header.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Id | query | integer(int32) | false | Entity integer ID owning the file. |
| FileId | query | string(guid) | false | UUID of the file to download. |
Example responses
200 Response
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | string |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| default | Default | none | ProblemDetails |
PATCH /bkb/v2.0/file/{fileId}
Moves a file to another folder or archives it via JSON Patch RFC 6902. Only replace ops on /folderId (positive int) or /status (value: archive) are accepted.
Body parameter
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"value": {
"nullable": true
}
}
}
]
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| fileId | path | string(guid) | true | UUID of file to patch; route parameter |
| X-Idempotency-Key | header | string | false | Optional UUID v4; deduplicates retries 24 hours |
| body | body | array[any] | true | The JSON Patch operations (RFC 6902) to apply. Supported: |
body: The JSON Patch operations (RFC 6902) to apply. Supported:
[{ "op": "replace", "path": "/folderId", "value": "
Example responses
200 Response
{
"type": "object",
"description": "Single file resource response.",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "Unique file GUID.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "Filename with extension.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Parent folder ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "Account, Carrier, or General.",
"nullable": true
},
"accessLevel": {
"type": "string",
"description": "Team visibility restriction.",
"nullable": true
},
"status": {
"type": "string",
"description": "Active or Archived.",
"nullable": true
},
"contentType": {
"type": "string",
"description": "MIME type string.",
"nullable": true
},
"sizeBytes": {
"type": "integer",
"description": "File size bytes.",
"format": "int64",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | File updated successfully. | FileResponse |
| 400 | Bad Request | Bad Request - unsupported or malformed patch document. | ProblemDetails |
| 401 | Unauthorized | Unauthorized - authentication required. | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | Not Found - file does not exist or feature is disabled. | ProblemDetails |
| 409 | Conflict | none | ProblemDetails |
| 422 | Unprocessable Entity | Unprocessable Entity - operation cannot be applied to the current file state. | ProblemDetails |
| default | Default | none | ProblemDetails |
DELETE /bkb/v2.0/file/{fileId}
Soft-deletes a file by moving it to the recycle bin. File is hidden from standard queries but recoverable by administrators. Requires write scope and EnableFileManagement feature flag active.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| fileId | path | string(guid) | true | UUID of active file to recycle |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| 409 | Conflict | none | ProblemDetails |
| 502 | Bad Gateway | none | ProblemDetails |
| default | Default | none | ProblemDetails |
PUT /bkb/v2.0/file/{fileId}
Updates file name, folder assignment, or access level without re-uploading content. Supports optimistic concurrency via If-Match ETag header. Returns 412 on ETag mismatch; 404 when feature disabled.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Optional new filename; include extension; non-empty.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Optional folder ID; null retains current folder.",
"format": "int32",
"nullable": true
},
"accessLevel": {
"description": "Optional; Unrestricted, BenefitTeamOnly, PcTeamOnly, BothTeams.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| fileId | path | string(guid) | true | UUID of file to update; route |
| If-Match | header | string | false | Optional ETag; prevents lost-update race conditions |
| body | body | UpdateFileMetadataRequest | true | Body with optional name, folderId, accessLevel fields |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier; use in download URL.",
"format": "guid"
},
"id": {
"type": "integer",
"description": "Internal integer ID; use in legacy operations.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Display filename including extension.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Containing folder ID; null means root level.",
"format": "int32",
"nullable": true
},
"accessLevel": {
"description": "Unrestricted, BenefitTeamOnly, PcTeamOnly, BothTeams.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
}
]
},
"entityId": {
"type": "integer",
"description": "Owning entity integer identifier.",
"format": "int32",
"nullable": true
},
"updatedDate": {
"type": "string",
"description": "UTC last-modified timestamp; null if unchanged.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | FileMetadataResponse |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| 412 | Precondition Failed | none | ProblemDetails |
| default | Default | none | ProblemDetails |
POST /bkb/v2.0/file
Searches active files for an entity by type, ID, with an optional folder or name keyword filter, and activity date range. If both folderId and search are supplied, the name keyword is used for retrieval and folderId is ignored. Returns flat collection; no pagination applied. EntityType and EntityId required.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"skip": {
"type": "integer",
"description": "Records to skip; zero means no skip.",
"format": "int32"
},
"top": {
"type": "integer",
"description": "Max records to return; zero means all.",
"format": "int32"
},
"entityType": {
"description": "Required; Account, Carrier, or General enum.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"entityId": {
"type": "integer",
"description": "Required; entity positive integer identifier.",
"format": "int32"
},
"folderId": {
"type": "integer",
"description": "Filter to this folder integer ID; optional.",
"format": "int32",
"nullable": true
},
"search": {
"type": "string",
"description": "Partial filename match; case-insensitive; optional.",
"nullable": true
},
"dateFrom": {
"type": "string",
"description": "Activity date lower bound; ISO 8601 format.",
"format": "date-time",
"nullable": true
},
"dateTo": {
"type": "string",
"description": "Activity date upper bound; ISO 8601 format.",
"format": "date-time",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | SearchFilesCriteria | true | Body with entityId + entityType required; folderId and search are optional, and search takes precedence when both are set |
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accessLevel": {
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
},
"attachments": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"isOpen": {
"type": "boolean"
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
],
"enum": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
]
},
"description": {
"type": "string",
"nullable": true
},
"activityInfo": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"baseType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Account",
"Carrier",
"Basic"
],
"enum": [
"None",
"Account",
"Carrier",
"Basic"
]
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"builderFileId": {
"type": "integer",
"format": "int32"
},
"attachedToId": {
"type": "integer",
"format": "int32"
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"fileId": {
"type": "string",
"format": "guid"
},
"fileSize": {
"type": "integer",
"format": "int32"
},
"lastAccessedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"lastAccessedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"removedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"removedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"description": "",
"x-enumNames": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
],
"enum": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
]
},
"updatedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"createdBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"entityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
},
"fileType": {
"type": "string",
"description": "",
"x-enumNames": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
],
"enum": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
]
},
"parentId": {
"type": "integer",
"format": "int32"
},
"isPermanentlyDeletable": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"nullable": true
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| default | Default | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [allOf] | false | none | none |
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | File | false | none | none |
| »» accessLevel | FileAccessLevel | false | none | none |
| »» attachments | [Attachment]|null | false | none | none |
| »»» isOpen | boolean | false | none | none |
| »»» type | AttachmentType | false | none | none |
| »»» description | string|null | false | none | none |
| »»» activityInfo | ActivityInfo|null | false | none | none |
| »»»» id | integer(int32) | false | none | none |
| »»»» baseType | BaseActivityType | false | none | none |
| »»»» dueDate | string(date-time)|null | false | none | none |
| »»» builderFileId | integer(int32) | false | none | none |
| »»» attachedToId | integer(int32) | false | none | none |
| »» description | string|null | false | none | none |
| »» fileId | string(guid) | false | none | none |
| »» fileSize | integer(int32) | false | none | none |
| »» lastAccessedBy | User|null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» type | string|null | false | none | none |
| »»» firstName | string|null | false | none | none |
| »»» lastName | string|null | false | none | none |
| »» lastAccessedDate | string(date-time)|null | false | none | none |
| »» location | string|null | false | none | none |
| »» removedBy | User|null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» type | string|null | false | none | none |
| »»» firstName | string|null | false | none | none |
| »»» lastName | string|null | false | none | none |
| »» removedDate | string(date-time)|null | false | none | none |
| »» status | FileStatus | false | none | none |
| »» updatedBy | User|null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» type | string|null | false | none | none |
| »»» firstName | string|null | false | none | none |
| »»» lastName | string|null | false | none | none |
| »» updatedDate | string(date-time)|null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» name | string|null | false | none | none |
| »» createdBy | User|null | false | none | none |
| »»» id | integer(int32) | false | none | none |
| »»» type | string|null | false | none | none |
| »»» firstName | string|null | false | none | none |
| »»» lastName | string|null | false | none | none |
| »» createDate | string(date-time)|null | false | none | none |
| »» entityId | integer(int32)|null | false | none | none |
| »» entityType | EntityType | false | none | none |
| »» fileType | FileType | false | none | none |
| »» parentId | integer(int32) | false | none | none |
| »» isPermanentlyDeletable | boolean | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | none |
| »» extension | string|null | false | none | none |
| Property | Value |
|---|---|
| accessLevel | Unrestricted |
| accessLevel | BothTeams |
| accessLevel | BenefitTeamOnly |
| accessLevel | PcTeamOnly |
| type | RFP |
| type | RFPCarrier |
| type | RFPEmail |
| type | Activity |
| type | CarrierQuestionnaire |
| type | ProposalAttachment |
| type | PlanAttachment |
| baseType | None |
| baseType | Account |
| baseType | Carrier |
| baseType | Basic |
| status | Exists |
| status | Failed |
| status | Quarantined |
| status | Uploading |
| entityType | General |
| entityType | Account |
| entityType | Carrier |
| fileType | File |
| fileType | Folder |
| fileType | ArchiveFile |
| fileType | RecycleFile |
POST /bkb/v2.0/file/upload
Uploads a file as multipart/form-data to an entity. Validates extension and enforces 100 MB size limit. Requires X-Idempotency-Key header and write scope. Returns 201 with Location header.
Body parameter
type: object
properties:
File:
type: string
format: binary
nullable: true
Description:
type: string
nullable: true
EntityId:
type: string
nullable: true
EntityType:
type: string
description: ''
x-enumNames:
- General
- Account
- Carrier
enum:
- General
- Account
- Carrier
FolderId:
type: string
nullable: true
AccessLevel:
type: string
description: ''
x-enumNames:
- Unrestricted
- BothTeams
- BenefitTeamOnly
- PcTeamOnly
enum:
- Unrestricted
- BothTeams
- BenefitTeamOnly
- PcTeamOnly
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| X-Idempotency-Key | header | string | false | Required UUID v4; prevents duplicate uploads 24 hours |
| body | body | object | false | none |
| » File | body | string(binary)|null | false | none |
| » Description | body | string|null | false | none |
| » EntityId | body | string|null | false | none |
| » EntityType | body | EntityType | false | none |
| » FolderId | body | string|null | false | none |
| » AccessLevel | body | FileAccessLevel | false | none |
| Parameter | Value |
|---|---|
| » EntityType | General |
| » EntityType | Account |
| » EntityType | Carrier |
| » AccessLevel | Unrestricted |
| » AccessLevel | BothTeams |
| » AccessLevel | BenefitTeamOnly |
| » AccessLevel | PcTeamOnly |
Example responses
201 Response
{
"type": "object",
"description": "Single file resource response.",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "Unique file GUID.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "Filename with extension.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Parent folder ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "Account, Carrier, or General.",
"nullable": true
},
"accessLevel": {
"type": "string",
"description": "Team visibility restriction.",
"nullable": true
},
"status": {
"type": "string",
"description": "Active or Archived.",
"nullable": true
},
"contentType": {
"type": "string",
"description": "MIME type string.",
"nullable": true
},
"sizeBytes": {
"type": "integer",
"description": "File size bytes.",
"format": "int64",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | FileResponse |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 409 | Conflict | none | ProblemDetails |
| 413 | Payload Too Large | none | ProblemDetails |
| 422 | Unprocessable Entity | none | ProblemDetails |
| 502 | Bad Gateway | none | ProblemDetails |
| default | Default | none | ProblemDetails |
GET /bkb/v2.0/folder
Returns all active folders for an entity. Provide entityId (integer) and entityType (Account, Carrier, or General) as query params. Transparently routes between file management service and legacy WCF backend.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| entityId | query | integer(int32) | false | Required positive integer; entity's unique identifier |
| entityType | query | EntityType | false | Required enum; Account, Carrier, or General |
| Parameter | Value |
|---|---|
| entityType | General |
| entityType | Account |
| entityType | Carrier |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"folderIdentifier": {
"type": "string",
"format": "guid",
"nullable": true
},
"childFolders": {
"type": "array",
"nullable": true,
"items": "[Circular]"
},
"defaultFolderId": {
"type": "integer",
"format": "int32"
},
"isRoot": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"createdBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"entityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
},
"parentId": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the collection of folders. | Folder |
| 400 | Bad Request | Bad Request - invalid entity type provided. | ProblemDetails |
| 401 | Unauthorized | Unauthorized - authentication required. | ProblemDetails |
| 403 | Forbidden | Forbidden - insufficient permissions to access folders. | ProblemDetails |
| 404 | Not Found | Not Found - entity does not exist. | ProblemDetails |
| default | Default | none | ProblemDetails |
POST /bkb/v2.0/folder
Creates a folder for an Account or Carrier entity. Supports optional parent folder nesting via parentFolderId. Requires X-Idempotency-Key header and write scope. Returns 201 with Location header on success.
Body parameter
{
"type": "object",
"description": "New folder creation request.",
"additionalProperties": false,
"required": [
"entityId",
"name"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Owner entity integer ID.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"entityType": {
"description": "Account or Carrier only.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"name": {
"type": "string",
"description": "Unique folder name.",
"minLength": 1
},
"parentFolderId": {
"type": "integer",
"description": "Parent folder integer ID.",
"format": "int32",
"nullable": true
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | CreateFolderRequest | false | Body; entityId, entityType, name required; parentFolderId optional |
Example responses
201 Response
{
"type": "object",
"description": "Folder resource response model.",
"additionalProperties": false,
"properties": {
"folderId": {
"type": "integer",
"description": "Folder integer ID.",
"format": "int32"
},
"folderIdentifier": {
"type": "string",
"description": "Folder GUID identifier.",
"format": "guid"
},
"name": {
"type": "string",
"description": "Folder display name.",
"nullable": true
},
"parentFolderId": {
"type": "integer",
"description": "Parent folder integer ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32"
},
"entityType": {
"description": "Account, Carrier, or General.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"status": {
"type": "string",
"description": "Active or Archived."
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Folder created successfully. | FolderResponse |
| 400 | Bad Request | Bad Request - missing or invalid required field. | ProblemDetails |
| 401 | Unauthorized | Unauthorized - authentication required. | ProblemDetails |
| 403 | Forbidden | Forbidden - insufficient scope; requires api.bkb. | ProblemDetails |
| 404 | Not Found | Not Found - feature flag disabled. | ProblemDetails |
| 409 | Conflict | Conflict - idempotency key already used for an in-flight request. | ProblemDetails |
| 500 | Internal Server Error | none | None |
| 502 | Bad Gateway | none | None |
| default | Default | none | ProblemDetails |
PUT /bkb/v2.0/folder/{folderIdentifier}
Renames a folder by its GUID using full replacement semantics. New name must be 1-255 characters and unique within the parent entity. Feature-flagged; returns 404 when file management is disabled.
Body parameter
{
"type": "object",
"description": "Rename folder request.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "New folder name.",
"maxLength": 255,
"minLength": 1
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| folderIdentifier | path | string(guid) | true | Folder GUID route param; identifies folder to rename. |
| entityType | query | EntityType | false | Entity type: Account, Carrier, or General. |
| entityId | query | integer(int32) | false | Entity integer ID owning this folder. |
| body | body | RenameFolderRequest | true | Body; name field required; 1-255 characters. |
| Parameter | Value |
|---|---|
| entityType | General |
| entityType | Account |
| entityType | Carrier |
Example responses
200 Response
{
"type": "object",
"description": "Folder resource response model.",
"additionalProperties": false,
"properties": {
"folderId": {
"type": "integer",
"description": "Folder integer ID.",
"format": "int32"
},
"folderIdentifier": {
"type": "string",
"description": "Folder GUID identifier.",
"format": "guid"
},
"name": {
"type": "string",
"description": "Folder display name.",
"nullable": true
},
"parentFolderId": {
"type": "integer",
"description": "Parent folder integer ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32"
},
"entityType": {
"description": "Account, Carrier, or General.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"status": {
"type": "string",
"description": "Active or Archived."
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the renamed folder. | FolderResponse |
| 400 | Bad Request | Bad Request - invalid input or folder name. | ProblemDetails |
| 401 | Unauthorized | Unauthorized - authentication required. | ProblemDetails |
| 403 | Forbidden | Forbidden - insufficient permissions. | ProblemDetails |
| 404 | Not Found | Not Found - folder does not exist or file management is disabled. | ProblemDetails |
| 409 | Conflict | Conflict - folder name already in use. | ProblemDetails |
| default | Default | none | ProblemDetails |
PATCH /bkb/v2.0/folder/{folderIdentifier}
Archives a folder via JSON Patch replace on /status with value archive. Archived folders reject new file uploads. Optional X-Idempotency-Key header deduplicates retries within a 24-hour window.
Body parameter
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"value": {
"nullable": true
}
}
}
]
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| folderIdentifier | path | string(guid) | true | Folder GUID route param; identifies folder to archive. |
| entityType | query | EntityType | false | Entity type: Account, Carrier, or General. |
| entityId | query | integer(int32) | false | Entity integer ID owning this folder. |
| X-Idempotency-Key | header | string | false | Optional UUID v4; 24-hour deduplication window. |
| body | body | array[any] | true | Replace /status with value "archive" only. |
| Parameter | Value |
|---|---|
| entityType | General |
| entityType | Account |
| entityType | Carrier |
Example responses
200 Response
{
"type": "object",
"description": "Folder resource response model.",
"additionalProperties": false,
"properties": {
"folderId": {
"type": "integer",
"description": "Folder integer ID.",
"format": "int32"
},
"folderIdentifier": {
"type": "string",
"description": "Folder GUID identifier.",
"format": "guid"
},
"name": {
"type": "string",
"description": "Folder display name.",
"nullable": true
},
"parentFolderId": {
"type": "integer",
"description": "Parent folder integer ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32"
},
"entityType": {
"description": "Account, Carrier, or General.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"status": {
"type": "string",
"description": "Active or Archived."
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Returns the archived folder. | FolderResponse |
| 202 | Accepted | Accepted - duplicate request; prior response not yet available. | None |
| 400 | Bad Request | Bad Request - invalid patch operation or folder cannot be archived. | ProblemDetails |
| 401 | Unauthorized | Unauthorized - authentication required. | ProblemDetails |
| 403 | Forbidden | Forbidden - insufficient permissions. | ProblemDetails |
| 404 | Not Found | Not Found - folder does not exist or file management is disabled. | ProblemDetails |
| default | Default | none | ProblemDetails |
DELETE /bkb/v2.0/folder/{folderIdentifier}
Permanently deletes an empty folder. Returns 409 if folder contains files. Requires folderIdentifier GUID as route param; entityId and entityType as query params for two-factor deletion safety.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| folderIdentifier | path | string(guid) | true | Folder GUID route param; two-factor deletion confirmation. |
| entityId | query | integer(int32) | false | Entity integer ID owning this folder. |
| entityType | query | EntityType2 | false | Entity type: Account, Carrier, or General. |
| Parameter | Value |
|---|---|
| entityType | General |
| entityType | Account |
| entityType | Carrier |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Folder deleted successfully. | None |
| 400 | Bad Request | Bad Request - the request was invalid. | ProblemDetails |
| 401 | Unauthorized | Unauthorized - authentication required. | ProblemDetails |
| 403 | Forbidden | Forbidden - insufficient permissions. | ProblemDetails |
| 404 | Not Found | Not Found - folder does not exist or belongs to another tenant. | ProblemDetails |
| 409 | Conflict | Conflict - folder contains one or more files and cannot be deleted. | ProblemDetails |
| default | Default | none | ProblemDetails |
GET /bkb/v2.0/plans/{planId}
Gets the account plan (planhistory) by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
},
{
"type": "object",
"description": "BrokerageBuilder Plan.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the plan's unique id.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Plan |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /bkb/v2.0/plans/update/{planId}
Updates the plan with options.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"plan": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
}
]
},
"options": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| body | body | PlanWithOptionsRequestModel | true | The PlanWithOptionsRequestModel. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
},
{
"type": "object",
"description": "BrokerageBuilder Plan.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the plan's unique id.",
"format": "int32"
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Plan |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /bkb/v2.0/plans/search
Searches for account plans based on the criteria.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Search criteria used to search for plans.",
"additionalProperties": false,
"properties": {
"accountId": {
"description": "Gets or sets the account id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planCode": {
"description": "Gets or sets the ams plan code.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"basePlanTypeId": {
"description": "Gets or sets the type of the base plan id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"beginningPolicyStatusId": {
"description": "Gets or sets the beginning policy status id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"billingCarrierId": {
"description": "Gets or sets the billing carrier id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"billingCarrierCodeId": {
"description": "Gets or sets the billing carrier code id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"billingModeId": {
"description": "Gets or sets the billing mode id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"carrierPolicyNumber": {
"description": "Gets or sets the carrier policy number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"commissionProducerId": {
"description": "Gets or sets the commission producer id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"commissionRate": {
"description": "Gets or sets the commission rate.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"commissionScheduleId": {
"description": "Gets or sets the commission schedule id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"commissionType": {
"description": "Gets or sets the type of the commission.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"currentSubscribers": {
"description": "Gets or sets the current subscribers.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customerServiceRepId": {
"description": "Gets or sets the customer service rep id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for plan by custom field.\nMaximum of 5 custom field searches allowed.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true
}
}
}
},
"departmentId": {
"description": "Gets or sets the department id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"endingPolicyStatusId": {
"description": "Gets or sets the ending policy status id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"expectedCommission": {
"description": "Gets or sets the expected commission.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"expectedPremium": {
"description": "Gets or sets the expected premium.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"id": {
"description": "Gets or sets the id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"issuingCarrierId": {
"description": "Gets or sets the issuing carrier id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"issuingCarrierCodeId": {
"description": "Gets or sets the issuing carrier code id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"payModeId": {
"description": "Gets or sets the pay mode id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planTypeId": {
"description": "Gets or sets the plan type id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planName": {
"description": "Gets or sets the name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"firstWrittenDate": {
"description": "Gets or sets the first written date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedDate": {
"description": "Gets or sets the last updated date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lostEffectiveDate": {
"description": "Gets or sets the lost effective date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"planYearStartDate": {
"description": "Gets or sets the start date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"planYearEndDate": {
"description": "Gets or sets the end date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"rateType": {
"description": "Gets or sets the type of the rate.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isPlanAtRisk": {
"description": "Gets or sets the is plan at risk.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"syncPlan": {
"description": "Gets or sets the is plan synced.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | PlanSearchRequestModel | true | The search request PlanSearchRequestModel. |
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,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
},
{
"type": "object",
"description": "BrokerageBuilder Plan.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the plan's unique id.",
"format": "int32"
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfPlan |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /bkb/v2.0/plans/baseplantypes
Gets base plan types.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Base plan type.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the name."
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [BasePlanType] | false | none | [Base plan type.] |
| » id | integer(int32) | false | none | Gets the unique id. |
| » name | string | false | none | Gets the name. |
GET /bkb/v2.0/plans/plantypes
Gets plan types for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "BrokerageBuilder Plan Type.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique id.",
"format": "int32"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the type of the base plan id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the name."
},
"amsCode": {
"type": "string",
"description": "Gets the plan type's code in a third-party system."
},
"showOutOfNetwork": {
"type": "boolean",
"description": "Gets a value indicating whether Out of Network benefit items are displayed."
},
"hrConnectionPlanTypeId": {
"type": "integer",
"description": "Gets the mapped HrConnection plan type id.",
"format": "int32"
},
"portalBenefitsTitle": {
"type": "string",
"description": "Gets the plantype's title that displays in Portal Benefits."
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [PlanType] | false | none | [BrokerageBuilder Plan Type.] |
| » id | integer(int32) | false | none | Gets the unique id. |
| » basePlanTypeId | integer(int32) | false | none | Gets the type of the base plan id. |
| » name | string | false | none | Gets the name. |
| » amsCode | string | false | none | Gets the plan type's code in a third-party system. |
| » showOutOfNetwork | boolean | false | none | Gets a value indicating whether Out of Network benefit items are displayed. |
| » hrConnectionPlanTypeId | integer(int32) | false | none | Gets the mapped HrConnection plan type id. |
| » portalBenefitsTitle | string | false | none | Gets the plantype's title that displays in Portal Benefits. |
GET /bkb/v2.0/plans/departments
Gets departments an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Departments within the broker agency.",
"additionalProperties": false
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 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 | Lookup3 | false | none | Agency-defined Plan Lookup |
| »» id | integer(int32) | false | none | Gets or sets the lookup's unique id. |
| »» description | string | false | none | Gets or sets the description. |
| »» amsCode | string | false | none | Gets the lookup code - the lookup id in a third-party system. |
| »» isDeleted | boolean | false | none | Gets or sets a value indicating whether this lookup is deleted. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | Departments within the broker agency. |
GET /bkb/v2.0/plans/endingstatuses
Gets plan ending statuses for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Policy status the plan ends with.",
"additionalProperties": false,
"properties": {
"salesTrackingStatus": {
"description": "Gets or sets the sales tracking status.",
"oneOf": [
{
"type": "string",
"description": "EndingSalesTrackingStatuses",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 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 | Lookup3 | false | none | Agency-defined Plan Lookup |
| »» id | integer(int32) | false | none | Gets or sets the lookup's unique id. |
| »» description | string | false | none | Gets or sets the description. |
| »» amsCode | string | false | none | Gets the lookup code - the lookup id in a third-party system. |
| »» isDeleted | boolean | false | none | Gets or sets a value indicating whether this lookup is deleted. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | Policy status the plan ends with. |
| »» salesTrackingStatus | EndingSalesTrackingStatuses2 | false | none | Gets or sets the sales tracking status. |
| Property | Value |
|---|---|
| salesTrackingStatus | None |
| salesTrackingStatus | RetainedSameCarrier |
| salesTrackingStatus | Lost |
| salesTrackingStatus | RetainedDifferentCarrier |
GET /bkb/v2.0/plans/beginningstatuses
Gets plan beginning statuses for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Policy status the BrokerageBuilder plan starts with.",
"additionalProperties": false,
"properties": {
"salesTrackingStatus": {
"description": "Gets the sales tracking status.",
"oneOf": [
{
"type": "string",
"description": "Plan BeginningSalesTrackingStatuses",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 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 | Lookup3 | false | none | Agency-defined Plan Lookup |
| »» id | integer(int32) | false | none | Gets or sets the lookup's unique id. |
| »» description | string | false | none | Gets or sets the description. |
| »» amsCode | string | false | none | Gets the lookup code - the lookup id in a third-party system. |
| »» isDeleted | boolean | false | none | Gets or sets a value indicating whether this lookup is deleted. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | Policy status the BrokerageBuilder plan starts with. |
| »» salesTrackingStatus | BeginningSalesTrackingStatuses | false | none | Gets the sales tracking status. |
| Property | Value |
|---|---|
| salesTrackingStatus | None |
| salesTrackingStatus | New |
| salesTrackingStatus | Retain |
| salesTrackingStatus | QuotedOnly |
GET /bkb/v2.0/plans/billingmodes
Gets billing modes for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Billing mode that determines how premiums are paid.",
"additionalProperties": false
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 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 | Lookup3 | false | none | Agency-defined Plan Lookup |
| »» id | integer(int32) | false | none | Gets or sets the lookup's unique id. |
| »» description | string | false | none | Gets or sets the description. |
| »» amsCode | string | false | none | Gets the lookup code - the lookup id in a third-party system. |
| »» isDeleted | boolean | false | none | Gets or sets a value indicating whether this lookup is deleted. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | Billing mode that determines how premiums are paid. |
GET /bkb/v2.0/plans/paymodes
Gets pay modes for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "The timeline on which commissions are recorded for a plan.",
"additionalProperties": false,
"properties": {
"paymentsPerYear": {
"type": "integer",
"description": "Gets or sets the number of payments per year.",
"format": "int32"
}
}
}
]
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 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 | Lookup3 | false | none | Agency-defined Plan Lookup |
| »» id | integer(int32) | false | none | Gets or sets the lookup's unique id. |
| »» description | string | false | none | Gets or sets the description. |
| »» amsCode | string | false | none | Gets the lookup code - the lookup id in a third-party system. |
| »» isDeleted | boolean | false | none | Gets or sets a value indicating whether this lookup is deleted. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| » anonymous | object | false | none | The timeline on which commissions are recorded for a plan. |
| »» paymentsPerYear | integer(int32) | false | none | Gets or sets the number of payments per year. |
GET /bkb/v2.0/plans/customfielddefinitions
Gets the custom field definitions for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"fieldType": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
],
"enum": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"includeOnRfp": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"lookups": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
},
"name": {
"type": "string",
"nullable": true
},
"showInAmc": {
"type": "boolean"
},
"showOnAccountHomePage": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [CustomField] | false | none | none |
| » brokerId | integer(int32) | false | none | none |
| » fieldType | FieldType | false | none | none |
| » id | integer(int32) | false | none | none |
| » includeOnRfp | boolean | false | none | none |
| » isDeleted | boolean | false | none | none |
| » isRequired | boolean | false | none | none |
| » lookups | [Lookup]|null | false | none | none |
| »» customFieldId | integer(int32) | false | none | none |
| »» description | string|null | false | none | none |
| »» id | integer(int32) | false | none | none |
| »» sortOrder | integer(int32) | false | none | none |
| » name | string|null | false | none | none |
| » showInAmc | boolean | false | none | none |
| » showOnAccountHomePage | boolean | false | none | none |
| » sortOrder | integer(int32) | false | none | none |
| Property | Value |
|---|---|
| fieldType | Unknown |
| fieldType | AlphaNumeric |
| fieldType | Numeric |
| fieldType | Date |
| fieldType | DropDownList |
| fieldType | YesNo |
| fieldType | StatesProvinces |
| fieldType | |
| fieldType | Phone |
| fieldType | Paragraph |
| fieldType | Currency |
GET /bkb/v2.0/plans/{planId}/newhirewaitingperiods
Gets the new hire waiting periods for plan.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Plan New Hire Waiting Period",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the waiting period's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the waiting period description."
},
"planId": {
"type": "integer",
"description": "Gets or sets the plan id.",
"format": "int32"
},
"waitingPeriodInterval": {
"type": "integer",
"description": "Gets or sets the waiting period interval.",
"format": "int32",
"nullable": true
},
"waitingPeriodRule": {
"description": "Gets or sets the waiting period rule.",
"oneOf": [
{
"type": "string",
"description": "Available rules for Plan Hew Hire Waiting Periods.",
"x-enumNames": [
"None",
"SameAsHireDate",
"FirstOfMonthByMonthAfterHire",
"FirstOfMonthByDaysAfterHire",
"NumberDaysAfterHire",
"Other",
"FifteenthOfMonthByDays",
"NumberMonthsAfterHire",
"FirstOfMonthAfterHire"
],
"enum": [
"None",
"SameAsHireDate",
"FirstOfMonthByMonthAfterHire",
"FirstOfMonthByDaysAfterHire",
"NumberDaysAfterHire",
"Other",
"FifteenthOfMonthByDays",
"NumberMonthsAfterHire",
"FirstOfMonthAfterHire"
]
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [PlanNewHireWaitingPeriod2] | false | none | [Plan New Hire Waiting Period] |
| » id | integer(int32) | false | none | Gets or sets the waiting period's unique id. |
| » description | string | false | none | Gets or sets the waiting period description. |
| » planId | integer(int32) | false | none | Gets or sets the plan id. |
| » waitingPeriodInterval | integer(int32)|null | false | none | Gets or sets the waiting period interval. |
| » waitingPeriodRule | NewHireWaitingPeriodRules | false | none | Gets or sets the waiting period rule. |
| Property | Value |
|---|---|
| waitingPeriodRule | None |
| waitingPeriodRule | SameAsHireDate |
| waitingPeriodRule | FirstOfMonthByMonthAfterHire |
| waitingPeriodRule | FirstOfMonthByDaysAfterHire |
| waitingPeriodRule | NumberDaysAfterHire |
| waitingPeriodRule | Other |
| waitingPeriodRule | FifteenthOfMonthByDays |
| waitingPeriodRule | NumberMonthsAfterHire |
| waitingPeriodRule | FirstOfMonthAfterHire |
GET /bkb/v2.0/plans/{planId}/rates
Gets plan rates by plan id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [Rate] | false | none | [Plan Rate] |
| » discriminator | string | true | none | none |
PUT /bkb/v2.0/plans/{planId}/rates
Modifies the plan's rates. The plan will be updated if the rate type has been changed, with the exception of switching to a Complex rate type. Complex: Structure cannot be modified, only the values will be saved. Tiered, SelfFunded: Structure will be completely modified based on the collection passed in.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"rates"
],
"properties": {
"rates": {
"type": "array",
"description": "The list of rates",
"items": {
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
}
},
"options": {
"description": "The request options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
},
"planRateMetadata": {
"description": "The plan rate metadata. Used for modifying Self-Funded rates.",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"urBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Utilization Review administrator.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"slBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Stop Loss carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"pbmBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the PBM carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"adminHasNetwork": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Network fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasPbm": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include PBM fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasStopLoss": {
"type": "boolean",
"description": "Gets or sets a value indicating whether Administrative fees include Stop Loss fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"networkHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Network fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"stopLossHasAggregate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Stop Loss rates include Aggregate fees.\nApplies to Self-Funded rates.",
"nullable": true
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| body | body | RatesWithOptionsRequestModel | true | The RatesWithOptionsRequestModel |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| 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 |
DELETE /bkb/v2.0/plans/{planId}/rates
Deletes all rates for the plan.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
404 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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 404 | Not Found | none | ProblemDetails |
GET /bkb/v2.0/rates/feetypes
Gets fee types.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Self-Funded Fee Type",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique fee type id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee type description."
},
"section": {
"description": "Gets or sets the self-funded rate section the fee type applies to.",
"oneOf": [
{
"type": "string",
"description": "SelfFundedSections",
"x-enumNames": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
],
"enum": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
]
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [FeeType] | false | none | [Self-Funded Fee Type] |
| » id | integer(int32) | false | none | Gets or sets the unique fee type id. |
| » description | string | false | none | Gets or sets the fee type description. |
| » section | SelfFundedSections | false | none | Gets or sets the self-funded rate section the fee type applies to. |
| Property | Value |
|---|---|
| section | Administative |
| section | StopLoss |
| section | UtilizationReview |
| section | Network |
| section | PrescriptionBenefitManagement |
GET /bkb/v2.0/plans/{planId}/otherfees
Gets other plan fees by plan id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Other Plan Fee",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee description."
},
"fee": {
"type": "number",
"description": "Gets or sets the monthly fee.",
"format": "decimal"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [OtherFee] | false | none | [Other Plan Fee] |
| » id | integer(int32) | false | none | Gets or sets the unique id. |
| » description | string | false | none | Gets or sets the fee description. |
| » fee | number(decimal) | false | none | Gets or sets the monthly fee. |
PUT /bkb/v2.0/plans/{planId}/otherfees
Modifies the other/additional plan fees. The plan's other fees will be completely modified based on the collection passed in, meaning items not included in the list will be deleted.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"otherFees"
],
"properties": {
"otherFees": {
"type": "array",
"description": "The list of other fees",
"items": {
"type": "object",
"description": "Other Plan Fee",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee description."
},
"fee": {
"type": "number",
"description": "Gets or sets the monthly fee.",
"format": "decimal"
}
}
}
},
"options": {
"description": "The request options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| body | body | OtherFeesWithOptionsRequestModel | true | The OtherFeesWithOptionsRequestModel |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| 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 /bkb/v2.0/plans/{planId}/contributionrates
Gets the plan contribution rates.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Plan Contribution Rates",
"additionalProperties": false,
"properties": {
"contributionType": {
"description": "Gets or sets the type of the contribution.",
"oneOf": [
{
"type": "string",
"description": "Type of contribtution rate.",
"x-enumNames": [
"Percent",
"Dollar"
],
"enum": [
"Percent",
"Dollar"
]
}
]
},
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"employerRate": {
"type": "number",
"description": "Gets or sets the employer rate.",
"format": "decimal",
"nullable": true
},
"employeeRate": {
"type": "number",
"description": "Gets or sets the employee rate.",
"format": "decimal",
"nullable": true
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [ContributionRate] | false | none | [Plan Contribution Rates] |
| » contributionType | ContributionTypes | false | none | Gets or sets the type of the contribution. |
| » tierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| » employerRate | number(decimal)|null | false | none | Gets or sets the employer rate. |
| » employeeRate | number(decimal)|null | false | none | Gets or sets the employee rate. |
| Property | Value |
|---|---|
| contributionType | Percent |
| contributionType | Dollar |
PUT /bkb/v2.0/plans/{planId}/contributionrates
Adds or updates the plan contribution rates. All rates must be the same ContributionType. Percent rates are required to have Employee and Employer rates equal 100 percent. The plan's contribution rates will be completely modified based on the collection passed in, meaning items not included in the list will be deleted.
Body parameter
{
"type": "object",
"additionalProperties": false,
"required": [
"contributionRates"
],
"properties": {
"contributionRates": {
"type": "array",
"description": "The list of contribution rates",
"items": {
"type": "object",
"description": "Plan Contribution Rates",
"additionalProperties": false,
"properties": {
"contributionType": {
"description": "Gets or sets the type of the contribution.",
"oneOf": [
{
"type": "string",
"description": "Type of contribtution rate.",
"x-enumNames": [
"Percent",
"Dollar"
],
"enum": [
"Percent",
"Dollar"
]
}
]
},
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"employerRate": {
"type": "number",
"description": "Gets or sets the employer rate.",
"format": "decimal",
"nullable": true
},
"employeeRate": {
"type": "number",
"description": "Gets or sets the employee rate.",
"format": "decimal",
"nullable": true
}
}
}
},
"options": {
"description": "The request options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
| body | body | ContributionRatesWithOptionsRequestModel | true | The ContributionRatesWithOptionsRequestModel |
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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| 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 /bkb/v2.0/rates/tieredrates/tiertypes
Gets the tiered rate tier types
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "TierType",
"additionalProperties": false,
"properties": {
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is deleted."
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [TierType] | false | none | [TierType] |
| » tierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| » name | string | false | none | Gets or sets the name. |
| » isDeleted | boolean | false | none | Gets or sets a value indicating whether this instance is deleted. |
GET /bkb/v2.0/rates/selffundedrates/tiertypes
Gets the self funded tier types
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "SelfFundedTierType",
"additionalProperties": false,
"properties": {
"selfFundedTierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is deleted."
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [SelfFundedTierType] | false | none | [SelfFundedTierType] |
| » selfFundedTierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| » name | string | false | none | Gets or sets the name. |
| » isDeleted | boolean | false | none | Gets or sets a value indicating whether this instance is deleted. |
GET /bkb/v2.0/plan/{planId}/rates/selffundedrates/ratemetadata
Gets the self funded rates plan rate metadata for the specified plan.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| planId | path | integer(int32) | true | The plan id. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"urBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Utilization Review administrator.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"slBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Stop Loss carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"pbmBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the PBM carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"adminHasNetwork": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Network fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasPbm": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include PBM fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasStopLoss": {
"type": "boolean",
"description": "Gets or sets a value indicating whether Administrative fees include Stop Loss fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"networkHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Network fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"stopLossHasAggregate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Stop Loss rates include Aggregate fees.\nApplies to Self-Funded rates.",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PlanRateMetadata |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /bkb/v2.0/accounts/{accountId}/roles
Get roles for a specific account id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| accountId | path | integer(int32) | true | The account id. |
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Represents the role an agency user has on an account.",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"roleId": {
"type": "integer",
"description": "Gets or sets the unique ID for this role.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the unique ID for this broker contact.",
"format": "int32"
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [AssignedRole] | false | none | [Represents the role an agency user has on an account.] |
| » accountId | integer(int32) | false | none | Gets or sets the unique ID for this account. |
| » roleId | integer(int32) | false | none | Gets or sets the unique ID for this role. |
| » brokerContactId | integer(int32) | false | none | Gets or sets the unique ID for this broker contact. |
GET /bkb/v2.0/roles
Get all user roles for an agency.
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"description": "Represents a role a user may have on an account.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this role.",
"format": "int32"
},
"brokerId": {
"type": "integer",
"description": "Gets or sets the unique broker ID for this role.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the role name."
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Inline |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| default | Default | none | ProblemDetails |
Status Code 200
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | [UserRole] | false | none | [Represents a role a user may have on an account.] |
| » id | integer(int32) | false | none | Gets or sets the unique ID for this role. |
| » brokerId | integer(int32) | false | none | Gets or sets the unique broker ID for this role. |
| » name | string | false | none | Gets or sets the role name. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account contact.",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 100,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Gets or sets the birth date of this account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for the location of this account contact.",
"maxLength": 25,
"nullable": true
},
"contactStatus": {
"description": "Gets or sets the status of this account contact.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account contact was created.",
"format": "date-time",
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the two-letter country code.",
"maxLength": 2,
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account contact.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"emailAddress": {
"type": "string",
"description": "Gets or sets the e-mail address for this account contact.",
"maxLength": 100,
"nullable": true
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this account contact has been deleted."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this is primary contact for the account.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "Gets or sets the mobile phone number for the account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"modifiedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"phoneExtension": {
"type": "string",
"description": "Gets or sets the extension for an account contact's primary phone number.",
"maxLength": 10,
"nullable": true
},
"salutation": {
"type": "string",
"description": "Gets or sets the salutation that should precede the account contact's name.",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for the U.S. state/territory or the Canadian, Carribbean or Mexican province.",
"maxLength": 2,
"nullable": true
},
"title": {
"type": "string",
"description": "Gets or sets the account contact's title.",
"maxLength": 100,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account contact.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountContactInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | Gets or sets the unique ID for this account contact. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account contact.",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 100,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Gets or sets the birth date of this account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for the location of this account contact.",
"maxLength": 25,
"nullable": true
},
"contactStatus": {
"description": "Gets or sets the status of this account contact.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account contact was created.",
"format": "date-time",
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the two-letter country code.",
"maxLength": 2,
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account contact.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"emailAddress": {
"type": "string",
"description": "Gets or sets the e-mail address for this account contact.",
"maxLength": 100,
"nullable": true
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this account contact has been deleted."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this is primary contact for the account.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "Gets or sets the mobile phone number for the account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"modifiedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"phoneExtension": {
"type": "string",
"description": "Gets or sets the extension for an account contact's primary phone number.",
"maxLength": 10,
"nullable": true
},
"salutation": {
"type": "string",
"description": "Gets or sets the salutation that should precede the account contact's name.",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for the U.S. state/territory or the Canadian, Carribbean or Mexican province.",
"maxLength": 2,
"nullable": true
},
"title": {
"type": "string",
"description": "Gets or sets the account contact's title.",
"maxLength": 100,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | Gets or sets the unique ID for this account. |
| address1 | string|null | false | none | Gets or sets the street address for this account contact. |
| address2 | string|null | false | none | Gets or sets the second address line. |
| address3 | string|null | false | none | Gets or sets the third address line. |
| birthDate | string(date-time)|null | false | none | Gets or sets the birth date of this account contact. |
| city | string|null | false | none | Gets or sets the city for the location of this account contact. |
| contactStatus | ContactStatus|null | false | none | Gets or sets the status of this account contact. |
| createdDate | string(date-time)|null | false | none | Gets the date and time the account contact was created. |
| country | string|null | false | none | Gets or sets the two-letter country code. |
| customFields | [CustomFieldValue] | false | none | Gets or sets the custom fields, as defined by the agency, for this account contact. |
| emailAddress | string|null | false | none | Gets or sets the e-mail address for this account contact. |
| fax | string|null | false | none | Gets or sets the fax number for this account. |
| firstName | string|null | false | none | Gets or sets the first name of the account contact. |
| isDeleted | boolean | false | none | Gets a value indicating whether this account contact has been deleted. |
| isPrimaryContact | boolean|null | false | none | Gets or sets a value indicating whether this is primary contact for the account. |
| lastName | string|null | false | none | Gets or sets the first name of the account contact. |
| mobilePhone | string|null | false | none | Gets or sets the mobile phone number for the account contact. |
| modifiedDate | string(date-time)|null | false | none | Gets the date and time the account was modified. |
| phone | string|null | false | none | Gets or sets the phone number for this account contact. |
| phoneExtension | string|null | false | none | Gets or sets the extension for an account contact's primary phone number. |
| salutation | string|null | false | none | Gets or sets the salutation that should precede the account contact's name. |
| stateProvince | string|null | false | none | Gets or sets the two-letter abbreviation for the U.S. state/territory or the Canadian, Carribbean or Mexican province. |
| title | string|null | false | none | Gets or sets the account contact's title. |
| zipPostalCode | string|null | false | none | Gets or sets the ZIP or postal code for this account. |
{
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Active |
| anonymous | Inactive |
{
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| brokerId | integer(int32) | false | none | none |
| customFieldId | integer(int32) | false | none | none |
| id | integer(int32) | false | none | none |
| itemId | integer(int32) | false | none | none |
| value | string|null | 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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
}
| 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 |
| extensions | object | false | none | none |
| » additionalProperties | any | 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,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account contact.",
"maxLength": 100,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 100,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"maxLength": 100,
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Gets or sets the birth date of this account contact.",
"format": "date-time",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for the location of this account contact.",
"maxLength": 25,
"nullable": true
},
"contactStatus": {
"description": "Gets or sets the status of this account contact.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account contact was created.",
"format": "date-time",
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the two-letter country code.",
"maxLength": 2,
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account contact.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"emailAddress": {
"type": "string",
"description": "Gets or sets the e-mail address for this account contact.",
"maxLength": 100,
"nullable": true
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this account contact has been deleted."
},
"isPrimaryContact": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this is primary contact for the account.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Gets or sets the first name of the account contact.",
"maxLength": 25,
"nullable": true
},
"mobilePhone": {
"type": "string",
"description": "Gets or sets the mobile phone number for the account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"modifiedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account contact.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"phoneExtension": {
"type": "string",
"description": "Gets or sets the extension for an account contact's primary phone number.",
"maxLength": 10,
"nullable": true
},
"salutation": {
"type": "string",
"description": "Gets or sets the salutation that should precede the account contact's name.",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for the U.S. state/territory or the Canadian, Carribbean or Mexican province.",
"maxLength": 2,
"nullable": true
},
"title": {
"type": "string",
"description": "Gets or sets the account contact's title.",
"maxLength": 100,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account contact.",
"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 | [AccountContact] | 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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
},
{
"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
},
"extensions": {
"type": "object",
"additionalProperties": {}
}
}
},
{
"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 |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"description": "Account contact search criteria",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"description": "Gets or sets the criteria used to search for account contacts by \"Account ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"address1": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 1.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address2": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 2.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address3": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 3.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"birthDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Birth date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"city": {
"description": "Gets or sets the criteria used to search for account contacts by \"City.\"\nMaximum of 25 characters.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"country": {
"description": "Gets or sets the criteria used to search for account contacts by \"Country.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Created date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"contactStatus": {
"description": "Gets or sets the criteria used to search for account contacts by \"Contact status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for account contacts by a custom field.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"emailAddress": {
"description": "Gets or sets the criteria used to search for account contacts by \"E-mail address.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"fax": {
"description": "Gets or sets the criteria used to search for account contacts by \"Fax.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"firstName": {
"description": "Gets or sets the criteria used to search for account contacts by \"First name.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the criteria used to search for account contacts by \"ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"isPrimaryContact": {
"description": "Gets or sets the criteria used to search for accounts based on \"Primary contact status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"lastName": {
"description": "Gets or sets the criteria used to search for accounts by \"Last name.\"\nMaximum of 25 characters.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"mobilePhone": {
"description": "Gets or sets the criteria used to search for account contacts by \"Mobile phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"modifiedDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Modified date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"phone": {
"description": "Gets or sets the criteria used to search for account contacts by \"Phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"phoneExtension": {
"description": "Gets or sets the criteria used to search for account contacts by \"Phone extension.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"salutation": {
"description": "Gets or sets the criteria used to search for account contacts by \"Salutation\".",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"stateProvince": {
"description": "Gets or sets the criteria used to search account contacts by \"State.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"title": {
"description": "Gets or sets the criteria used to search account contacts by \"Title.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"zipPostalCode": {
"description": "Gets or sets the criteria used to search for account contacts by \"ZIP/Postal code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"description": "Account contact search options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | AccountContactSearchCriteria|null | false | none | Account contact search criteria |
| searchOptions | SearchOptions|null | false | none | Account contact search options |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"description": "Gets or sets the criteria used to search for account contacts by \"Account ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"address1": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 1.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address2": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 2.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address3": {
"description": "Gets or sets the criteria used to search for account contacts by \"Address 3.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"birthDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Birth date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"city": {
"description": "Gets or sets the criteria used to search for account contacts by \"City.\"\nMaximum of 25 characters.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"country": {
"description": "Gets or sets the criteria used to search for account contacts by \"Country.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Created date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"contactStatus": {
"description": "Gets or sets the criteria used to search for account contacts by \"Contact status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for account contacts by a custom field.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"emailAddress": {
"description": "Gets or sets the criteria used to search for account contacts by \"E-mail address.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"fax": {
"description": "Gets or sets the criteria used to search for account contacts by \"Fax.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"firstName": {
"description": "Gets or sets the criteria used to search for account contacts by \"First name.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the criteria used to search for account contacts by \"ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"isPrimaryContact": {
"description": "Gets or sets the criteria used to search for accounts based on \"Primary contact status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"lastName": {
"description": "Gets or sets the criteria used to search for accounts by \"Last name.\"\nMaximum of 25 characters.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"mobilePhone": {
"description": "Gets or sets the criteria used to search for account contacts by \"Mobile phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"modifiedDate": {
"description": "Gets or sets the criteria used to search for account contacts by \"Modified date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"phone": {
"description": "Gets or sets the criteria used to search for account contacts by \"Phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"phoneExtension": {
"description": "Gets or sets the criteria used to search for account contacts by \"Phone extension.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"salutation": {
"description": "Gets or sets the criteria used to search for account contacts by \"Salutation\".",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"stateProvince": {
"description": "Gets or sets the criteria used to search account contacts by \"State.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"title": {
"description": "Gets or sets the criteria used to search account contacts by \"Title.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"zipPostalCode": {
"description": "Gets or sets the criteria used to search for account contacts by \"ZIP/Postal code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | IdListSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Account ID." |
| address1 | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Address 1." |
| address2 | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Address 2." |
| address3 | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Address 3." |
| birthDate | DateTimeSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Birth date." |
| city | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "City." Maximum of 25 characters. |
| country | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Country." |
| createdDate | DateTimeSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Created date." |
| contactStatus | EnumSearchCriteriaOfContactStatus|null | false | none | Gets or sets the criteria used to search for account contacts by "Contact status." |
| customFields | [CustomFieldSearchValue]|null | false | none | Gets or sets the criteria used to search for account contacts by a custom field. |
| emailAddress | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "E-mail address." |
| fax | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Fax." |
| firstName | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "First name." |
| id | IdListSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "ID." |
| isPrimaryContact | BooleanSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts based on "Primary contact status." |
| lastName | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Last name." Maximum of 25 characters. |
| mobilePhone | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Mobile phone." |
| modifiedDate | DateTimeSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Modified date." |
| phone | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Phone." |
| phoneExtension | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Phone extension." |
| salutation | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "Salutation". |
| stateProvince | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search account contacts by "State." |
| title | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search account contacts by "Title." |
| zipPostalCode | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for account contacts by "ZIP/Postal code." |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | IdListSearchType | false | none | none |
| » value | integer(int32) | false | none | none |
| » valueList | [integer]|null | false | none | none |
| » inclusiveNulls | boolean | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | Contains |
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sort | SortType | false | none | none |
| sortOrder | integer(int32) | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Ascending |
| anonymous | Descending |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | StringSearchType | false | none | none |
| » value | string|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | Contains |
| anonymous | IsNullOrEmpty |
| anonymous | StartsWith |
| anonymous | EndsWith |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ValueSearchCriteriaOfInteger | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » rangeEndValue | integer(int32)|null | false | none | none |
| » rangeStartValue | integer(int32)|null | false | none | none |
| » searchType | ValueSearchType | false | none | none |
| » value | integer(int32)|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | GreaterThan |
| anonymous | GreaterThanEquals |
| anonymous | LessThan |
| anonymous | LessThanEquals |
| anonymous | Between |
| anonymous | NotBetween |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "double",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "double",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ValueSearchCriteriaOfDouble | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "double",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "double",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » rangeEndValue | number(double)|null | false | none | none |
| » rangeStartValue | number(double)|null | false | none | none |
| » searchType | ValueSearchType | false | none | none |
| » value | number(double)|null | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ValueSearchCriteriaOfDecimal | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » rangeEndValue | number(decimal)|null | false | none | none |
| » rangeStartValue | number(decimal)|null | false | none | none |
| » searchType | ValueSearchType | false | none | none |
| » value | number(decimal)|null | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | ValueSearchCriteriaOfDateTime | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » rangeEndValue | string(date-time)|null | false | none | none |
| » rangeStartValue | string(date-time)|null | false | none | none |
| » searchType | ValueSearchType | false | none | none |
| » value | string(date-time)|null | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | BooleanSearchType | false | none | none |
| » value | boolean | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | ContactStatus | false | none | none |
| » valueList | [ContactStatus]|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | Contains |
{
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customFieldId | integer(int32) | false | none | none |
| searchCriteria | SearchCriteriaBase|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"deletedOnly": {
"type": "boolean"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchOptions | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » deletedOnly | boolean | false | none | none |
{
"allOf": [
{
"type": "object",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
},
{
"type": "object",
"description": "Account",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountInfo | false | none | AccountInfo |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Account |
| » id | integer(int32) | false | none | Gets or sets the unique ID for this account. |
{
"type": "object",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
}
AccountInfo
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountStatus | AccountStatus | false | none | Gets or sets the status of this account. |
| productType | ProductType | false | none | Gets or sets the account product type. |
| address1 | string|null | false | none | Gets or sets the street address for this account. |
| address2 | string|null | false | none | Gets or sets the second address line. |
| address3 | string|null | false | none | Gets or sets the third address line. |
| city | string|null | false | none | Gets or sets the city for this account location. |
| createdDate | string(date-time)|null | false | none | Gets the date and time the account was created. |
| customFields | [CustomFieldValue]|null | false | none | Gets or sets the custom fields, as defined by the agency, for this account. |
| fax | string|null | false | none | Gets or sets the fax number for this account. |
| isDeleted | boolean | false | none | Gets a value that indicates whether this instance has been deleted. |
| lastUpdatedDate | string(date-time)|null | false | none | Gets the date and time the account was modified. |
| name | string | true | none | Gets or sets the account name. |
| phone | string|null | false | none | Gets or sets the phone number for this account. |
| stateProvince | string|null | false | none | Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province. |
| url | string|null | false | none | Gets or sets the URL for this account's Web page. |
| zipPostalCode | string|null | false | none | Gets or sets the ZIP or postal code for this account. |
| bkbStatusLastUpdatedById | integer(int32)|null | false | none | Gets the id of the last user to update the BrokerageBuilder status. This field is read-only. |
| bkbStatusLastUpdatedDate | string(date-time)|null | false | none | Gets the date and time the BrokerageBuilder status was last updated. This field is read-only. |
| clientCode | string|null | false | none | Gets or sets the client code - the account id in a third-party system. |
| producerId | integer(int32)|null | false | none | Gets or sets the account's producer id. |
| brokerageBuilderStatus | BrokerageBuilderStatus|null | false | none | Gets or sets the BrokerageBuilder status. |
| brokerageBuilderDeactivatedReason | string|null | false | none | Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder. |
| benchmarkEmployees | BenchmarkEmployees | false | none | Gets or sets the id of the employee benchmark value. |
| benchmarkIndustry | BenchmarkIndustry | false | none | Gets or sets the benchmark industry. |
| businessLine | string|null | false | none | Gets or sets a description about the account's business line. |
| classification | Classifications | false | none | Gets or sets the Classification of the account. |
| county | string|null | false | none | Gets or sets the account's county. |
| country | string|null | false | none | Gets or sets the account's two letter country code. |
| isBenefitClient | boolean | false | none | Gets or sets a value indicating whether this instance is benefit client. This field is read-only. |
| isBenefitProspect | boolean | false | none | Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only. |
| numberOfEmployees | integer(int32)|null | false | none | Gets or sets the number of employees. |
| numberOfRetirees | integer(int32)|null | false | none | Gets or sets the number of retirees. |
| sicCode | string|null | false | none | Gets or sets the SIC (Standard Industrial Classification) Code. |
| yearFounded | integer(int32)|null | false | none | Gets or sets the year founded. |
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
AccountStatus
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | AccountStatus |
| Property | Value |
|---|---|
| anonymous | Active |
| anonymous | Inactive |
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
ProductType
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | ProductType |
| Property | Value |
|---|---|
| anonymous | Other |
| anonymous | BrokerageBuilder |
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
Available BKB Account Statuses
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Available BKB Account Statuses |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | Active |
| anonymous | Inactive |
| anonymous | Dead |
| anonymous | Test |
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
BenchmarkEmployee
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | BenchmarkEmployee |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | _0000to0025 |
| anonymous | _0026to0050 |
| anonymous | _0051to0099 |
| anonymous | _0100to0499 |
| anonymous | _0500to0999 |
| anonymous | _1000to2499 |
| anonymous | _2500to4999 |
| anonymous | _5000Plus |
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
Benchmark Industry
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Benchmark Industry |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | AgricultureForestryFishing |
| anonymous | Education |
| anonymous | FinanceInsuranceRealEstate |
| anonymous | Healthcare |
| anonymous | Manufacturing |
| anonymous | MiningConstructionWholesale |
| anonymous | Retail |
| anonymous | Service |
| anonymous | StateLocalGovernment |
| anonymous | TransportationCommUtilities |
| anonymous | Other |
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
Available BrokerageBuilder Account Classifications
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Available BrokerageBuilder Account Classifications |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | IndividualPersonal |
| anonymous | GroupCommercial |
{
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"fieldType": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
],
"enum": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"includeOnRfp": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"lookups": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
},
"name": {
"type": "string",
"nullable": true
},
"showInAmc": {
"type": "boolean"
},
"showOnAccountHomePage": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| brokerId | integer(int32) | false | none | none |
| fieldType | FieldType | false | none | none |
| id | integer(int32) | false | none | none |
| includeOnRfp | boolean | false | none | none |
| isDeleted | boolean | false | none | none |
| isRequired | boolean | false | none | none |
| lookups | [Lookup]|null | false | none | none |
| name | string|null | false | none | none |
| showInAmc | boolean | false | none | none |
| showOnAccountHomePage | boolean | false | none | none |
| sortOrder | integer(int32) | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
],
"enum": [
"Unknown",
"AlphaNumeric",
"Numeric",
"Date",
"DropDownList",
"YesNo",
"StatesProvinces",
"Email",
"Phone",
"Paragraph",
"Currency"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | AlphaNumeric |
| anonymous | Numeric |
| anonymous | Date |
| anonymous | DropDownList |
| anonymous | YesNo |
| anonymous | StatesProvinces |
| anonymous | |
| anonymous | Phone |
| anonymous | Paragraph |
| anonymous | Currency |
{
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customFieldId | integer(int32) | false | none | none |
| description | string|null | false | none | none |
| id | integer(int32) | false | none | none |
| sortOrder | 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",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
},
{
"type": "object",
"description": "Account",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"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 | [Account] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "AccountSearchCriteria",
"additionalProperties": false,
"properties": {
"accountStatus": {
"description": "Gets or sets the criteria used to search accounts by \"BrokerageBuilder Status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
]
},
"address1": {
"description": "Gets or sets the criteria used to search for accounts by \"Address 1.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address2": {
"description": "Gets or sets the criteria used to search for accounts by \"Address 2.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address3": {
"description": "Gets or sets the criteria used to search for accounts by the \"Address 3.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"clientCode": {
"description": "Gets or sets the criteria used to search for accounts by \"AMS ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"benchmarkEmployees": {
"description": "Gets or sets the criteria used to search for accounts by \"Benchmark employees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
}
}
}
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the criteria used to search for accounts by \"Benchmark industry.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
}
}
}
]
}
]
},
"businessLine": {
"description": "Gets or sets the criteria used to search for accounts by \"Business line.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"classification": {
"description": "Gets or sets the criteria used to search for accounts by \"Client type.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
}
}
}
]
}
]
},
"county": {
"description": "Gets or sets the criteria used to search for accounts by \"County.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"country": {
"description": "Gets or sets the criteria used to search for accounts by \"Country.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"city": {
"description": "Gets or sets the criteria used to search for accounts by \"City.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdDate": {
"description": "Gets or sets the criteria used to search for accounts by \"Created date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for account by a custom field.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"fax": {
"description": "Gets or sets the criteria used to search for accounts by \"Fax.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the criteria used to search for accounts based on \"ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"isBenefitClient": {
"description": "Gets or sets the criteria used to search for accounts based on \"Benefits client status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"isBenefitProspect": {
"description": "Gets or sets the criteria used to search for accounts based on \"Benefits prospect status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"productType": {
"description": "Gets or sets the criteria used to search for accounts based on \"Product type.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
}
}
}
]
}
]
},
"lastUpdatedDate": {
"description": "Gets or sets the criteria used to search accounts by \"Last updated date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"name": {
"description": "Gets or sets the criteria used to search for accounts by \"Name.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"numberOfEmployees": {
"description": "Gets or sets the criteria used to search accounts by \"Number of employees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"numberOfRetirees": {
"description": "Gets or sets the criteria used to search accounts by \"Number of retirees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"phone": {
"description": "Gets or sets the criteria used to search for accounts by \"Phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"producerId": {
"description": "Gets or sets the criteria used to search for accounts by \"Producer ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"sicCode": {
"description": "Gets or sets the criteria used to search for accounts by \"SIC code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"stateProvince": {
"description": "Gets or sets the criteria used to search accounts by \"State.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"brokerageBuilderStatus": {
"description": "Gets or sets the criteria used to search accounts by \"TBD.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
}
}
}
]
}
]
},
"url": {
"description": "Gets or sets the criteria used to search for accounts by \"URL.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"yearFounded": {
"description": "Gets or sets the criteria used to search for accounts by \"Year founded.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"zipPostalCode": {
"description": "Gets or sets the criteria used to search for accounts by \"ZIP/Postal code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | AccountSearchCriteria|null | false | none | AccountSearchCriteria |
| searchOptions | SearchOptions|null | false | none | none |
{
"type": "object",
"description": "AccountSearchCriteria",
"additionalProperties": false,
"properties": {
"accountStatus": {
"description": "Gets or sets the criteria used to search accounts by \"BrokerageBuilder Status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
]
},
"address1": {
"description": "Gets or sets the criteria used to search for accounts by \"Address 1.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address2": {
"description": "Gets or sets the criteria used to search for accounts by \"Address 2.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"address3": {
"description": "Gets or sets the criteria used to search for accounts by the \"Address 3.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"clientCode": {
"description": "Gets or sets the criteria used to search for accounts by \"AMS ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"benchmarkEmployees": {
"description": "Gets or sets the criteria used to search for accounts by \"Benchmark employees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
}
}
}
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the criteria used to search for accounts by \"Benchmark industry.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
}
}
}
]
}
]
},
"businessLine": {
"description": "Gets or sets the criteria used to search for accounts by \"Business line.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"classification": {
"description": "Gets or sets the criteria used to search for accounts by \"Client type.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
}
}
}
]
}
]
},
"county": {
"description": "Gets or sets the criteria used to search for accounts by \"County.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"country": {
"description": "Gets or sets the criteria used to search for accounts by \"Country.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"city": {
"description": "Gets or sets the criteria used to search for accounts by \"City.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdDate": {
"description": "Gets or sets the criteria used to search for accounts by \"Created date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for account by a custom field.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"fax": {
"description": "Gets or sets the criteria used to search for accounts by \"Fax.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the criteria used to search for accounts based on \"ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"isBenefitClient": {
"description": "Gets or sets the criteria used to search for accounts based on \"Benefits client status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"isBenefitProspect": {
"description": "Gets or sets the criteria used to search for accounts based on \"Benefits prospect status.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"productType": {
"description": "Gets or sets the criteria used to search for accounts based on \"Product type.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
}
}
}
]
}
]
},
"lastUpdatedDate": {
"description": "Gets or sets the criteria used to search accounts by \"Last updated date.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"name": {
"description": "Gets or sets the criteria used to search for accounts by \"Name.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"numberOfEmployees": {
"description": "Gets or sets the criteria used to search accounts by \"Number of employees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"numberOfRetirees": {
"description": "Gets or sets the criteria used to search accounts by \"Number of retirees.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"phone": {
"description": "Gets or sets the criteria used to search for accounts by \"Phone.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"producerId": {
"description": "Gets or sets the criteria used to search for accounts by \"Producer ID.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"sicCode": {
"description": "Gets or sets the criteria used to search for accounts by \"SIC code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"stateProvince": {
"description": "Gets or sets the criteria used to search accounts by \"State.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"brokerageBuilderStatus": {
"description": "Gets or sets the criteria used to search accounts by \"TBD.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
}
}
}
]
}
]
},
"url": {
"description": "Gets or sets the criteria used to search for accounts by \"URL.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"yearFounded": {
"description": "Gets or sets the criteria used to search for accounts by \"Year founded.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"zipPostalCode": {
"description": "Gets or sets the criteria used to search for accounts by \"ZIP/Postal code.\"",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
AccountSearchCriteria
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountStatus | EnumSearchCriteriaOfAccountStatus|null | false | none | Gets or sets the criteria used to search accounts by "BrokerageBuilder Status." |
| address1 | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Address 1." |
| address2 | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Address 2." |
| address3 | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by the "Address 3." |
| clientCode | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "AMS ID." |
| benchmarkEmployees | EnumSearchCriteriaOfBenchmarkEmployees|null | false | none | Gets or sets the criteria used to search for accounts by "Benchmark employees." |
| benchmarkIndustry | EnumSearchCriteriaOfBenchmarkIndustry|null | false | none | Gets or sets the criteria used to search for accounts by "Benchmark industry." |
| businessLine | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Business line." |
| classification | EnumSearchCriteriaOfClassifications|null | false | none | Gets or sets the criteria used to search for accounts by "Client type." |
| county | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "County." |
| country | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Country." |
| city | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "City." |
| createdDate | DateTimeSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Created date." |
| customFields | [CustomFieldSearchValue]|null | false | none | Gets or sets the criteria used to search for account by a custom field. |
| fax | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Fax." |
| id | IdListSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts based on "ID." |
| isBenefitClient | BooleanSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts based on "Benefits client status." |
| isBenefitProspect | BooleanSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts based on "Benefits prospect status." |
| productType | EnumSearchCriteriaOfProductType|null | false | none | Gets or sets the criteria used to search for accounts based on "Product type." |
| lastUpdatedDate | DateTimeSearchCriteria|null | false | none | Gets or sets the criteria used to search accounts by "Last updated date." |
| name | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Name." |
| numberOfEmployees | IntSearchCriteria|null | false | none | Gets or sets the criteria used to search accounts by "Number of employees." |
| numberOfRetirees | IntSearchCriteria|null | false | none | Gets or sets the criteria used to search accounts by "Number of retirees." |
| phone | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Phone." |
| producerId | IdListSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Producer ID." |
| sicCode | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "SIC code." |
| stateProvince | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search accounts by "State." |
| brokerageBuilderStatus | EnumSearchCriteriaOfBrokerageBuilderStatus|null | false | none | Gets or sets the criteria used to search accounts by "TBD." |
| url | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "URL." |
| yearFounded | IntSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "Year founded." |
| zipPostalCode | StringSearchCriteria|null | false | none | Gets or sets the criteria used to search for accounts by "ZIP/Postal code." |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | AccountStatus | false | none | AccountStatus |
| » valueList | [AccountStatus]|null | false | none | [AccountStatus] |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | BenchmarkEmployees | false | none | BenchmarkEmployee |
| » valueList | [BenchmarkEmployees]|null | false | none | [BenchmarkEmployee] |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | BenchmarkIndustry | false | none | Benchmark Industry |
| » valueList | [BenchmarkIndustry]|null | false | none | [Benchmark Industry] |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | Classifications | false | none | Available BrokerageBuilder Account Classifications |
| » valueList | [Classifications]|null | false | none | [Available BrokerageBuilder Account Classifications] |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | ProductType | false | none | ProductType |
| » valueList | [ProductType]|null | false | none | [ProductType] |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | BrokerageBuilderStatus | false | none | Available BKB Account Statuses |
| » valueList | [BrokerageBuilderStatus]|null | false | none | [Available BKB Account Statuses] |
{
"type": "object",
"additionalProperties": false,
"properties": {
"account": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "AccountInfo",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"accountStatus": {
"description": "Gets or sets the status of this account.\n ",
"oneOf": [
{
"type": "string",
"description": "AccountStatus",
"x-enumNames": [
"Active",
"Inactive"
],
"enum": [
"Active",
"Inactive"
]
}
]
},
"productType": {
"description": "Gets or sets the account product type.",
"oneOf": [
{
"type": "string",
"description": "ProductType",
"x-enumNames": [
"Other",
"BrokerageBuilder"
],
"enum": [
"Other",
"BrokerageBuilder"
]
}
]
},
"address1": {
"type": "string",
"description": "Gets or sets the street address for this account.",
"maxLength": 75,
"nullable": true
},
"address2": {
"type": "string",
"description": "Gets or sets the second address line.",
"maxLength": 75,
"nullable": true
},
"address3": {
"type": "string",
"description": "Gets or sets the third address line.",
"nullable": true
},
"city": {
"type": "string",
"description": "Gets or sets the city for this account location.",
"maxLength": 25,
"nullable": true
},
"createdDate": {
"type": "string",
"description": "Gets the date and time the account was created.",
"format": "date-time",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields, as defined by the agency, for this account.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"fax": {
"type": "string",
"description": "Gets or sets the fax number for this account.",
"maxLength": 25,
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value that indicates whether this instance has been deleted."
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the account was modified.",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"description": "Gets or sets the account name.",
"maxLength": 255,
"minLength": 1
},
"phone": {
"type": "string",
"description": "Gets or sets the phone number for this account.",
"maxLength": 25,
"pattern": "^(\\(?[0-9]{3}[\\)-\\.]?\\ ?)?[0-9]{3}[-\\.]?[0-9]{4}$",
"nullable": true
},
"stateProvince": {
"type": "string",
"description": "Gets or sets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province.",
"nullable": true
},
"url": {
"type": "string",
"description": "Gets or sets the URL for this account's Web page.",
"maxLength": 255,
"nullable": true
},
"zipPostalCode": {
"type": "string",
"description": "Gets or sets the ZIP or postal code for this account.",
"maxLength": 10,
"pattern": "^(\\d{5}-\\d{4}|\\d{5})$|^([a-zA-Z]\\d[a-zA-Z] \\d[a-zA-Z]\\d)$",
"nullable": true
},
"bkbStatusLastUpdatedById": {
"type": "integer",
"description": "Gets the id of the last user to update the BrokerageBuilder status. This field is read-only.",
"format": "int32",
"nullable": true
},
"bkbStatusLastUpdatedDate": {
"type": "string",
"description": "Gets the date and time the BrokerageBuilder status was last updated. This field is read-only.",
"format": "date-time",
"nullable": true
},
"clientCode": {
"type": "string",
"description": "Gets or sets the client code - the account id in a third-party system.",
"maxLength": 50,
"nullable": true
},
"producerId": {
"type": "integer",
"description": "Gets or sets the account's producer id.",
"format": "int32",
"nullable": true
},
"brokerageBuilderStatus": {
"description": "Gets or sets the BrokerageBuilder status.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "Available BKB Account Statuses",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"brokerageBuilderDeactivatedReason": {
"type": "string",
"description": "Gets or sets the reason the account was set to InActive or Dead in BrokerageBuilder.",
"nullable": true
},
"benchmarkEmployees": {
"description": "Gets or sets the id of the employee benchmark value.",
"oneOf": [
{
"type": "string",
"description": "BenchmarkEmployee",
"x-enumNames": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
],
"enum": [
"Unknown",
"_0000to0025",
"_0026to0050",
"_0051to0099",
"_0100to0499",
"_0500to0999",
"_1000to2499",
"_2500to4999",
"_5000Plus"
]
}
]
},
"benchmarkIndustry": {
"description": "Gets or sets the benchmark industry.",
"oneOf": [
{
"type": "string",
"description": "Benchmark Industry",
"x-enumNames": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
],
"enum": [
"Unknown",
"AgricultureForestryFishing",
"Education",
"FinanceInsuranceRealEstate",
"Healthcare",
"Manufacturing",
"MiningConstructionWholesale",
"Retail",
"Service",
"StateLocalGovernment",
"TransportationCommUtilities",
"Other"
]
}
]
},
"businessLine": {
"type": "string",
"description": "Gets or sets a description about the account's business line.",
"maxLength": 255,
"nullable": true
},
"classification": {
"description": "Gets or sets the Classification of the account.",
"oneOf": [
{
"type": "string",
"description": "Available BrokerageBuilder Account Classifications",
"x-enumNames": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
],
"enum": [
"Unknown",
"IndividualPersonal",
"GroupCommercial"
]
}
]
},
"county": {
"type": "string",
"description": "Gets or sets the account's county.",
"maxLength": 50,
"nullable": true
},
"country": {
"type": "string",
"description": "Gets or sets the account's two letter country code.",
"maxLength": 2,
"nullable": true
},
"isBenefitClient": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit client. This field is read-only."
},
"isBenefitProspect": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is benefit prospect. This field is read-only."
},
"numberOfEmployees": {
"type": "integer",
"description": "Gets or sets the number of employees.",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"description": "Gets or sets the number of retirees.",
"format": "int32",
"nullable": true
},
"sicCode": {
"type": "string",
"description": "Gets or sets the SIC (Standard Industrial Classification) Code. ",
"nullable": true
},
"yearFounded": {
"type": "integer",
"description": "Gets or sets the year founded.",
"format": "int32",
"maximum": 9999,
"minimum": 0,
"nullable": true
}
}
}
]
},
"crudOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| account | AccountInfo|null | false | none | AccountInfo |
| crudOptions | CrudOptions|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| force | boolean | false | none | none |
| validateOnly | boolean | false | none | none |
{
"type": "object",
"description": "Represents the role an agency user has on an account.",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the unique ID for this account.",
"format": "int32"
},
"roleId": {
"type": "integer",
"description": "Gets or sets the unique ID for this role.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the unique ID for this broker contact.",
"format": "int32"
}
}
}
Represents the role an agency user has on an account.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | Gets or sets the unique ID for this account. |
| roleId | integer(int32) | false | none | Gets or sets the unique ID for this role. |
| brokerContactId | integer(int32) | false | none | Gets or sets the unique ID for this broker contact. |
{
"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",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"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 | [Activity] | false | none | [Represents a full activity object used for adding, editing and viewing a single item.] |
{
"type": "object",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
Represents a full activity object used for adding, editing and viewing a single item.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the activity id. This field is ready-only. Any data modified in this field will not be saved. |
| activityTypeId | integer(int32) | false | none | Gets or sets the activity type id. |
| timeSpent | integer(int32)|null | false | none | Gets or sets the time spent completing the activity. Time is represented in minutes. |
| dueDate | string(date-time)|null | false | none | Gets or sets the due date of the activity. |
| isOpen | boolean | false | none | Gets or sets a value indicating whether this activity is open or closed. |
| subject | string|null | false | none | Gets or sets the activity subject. |
| notes | string|null | false | none | Gets or sets the saved activity notes. This field is ready-only. Any data modified in this field will not be saved. |
| first25Notes | string|null | false | none | Gets or sets the first 25 characters of the activity notes. This field is ready-only. Any data modified in this field will not be saved. |
| createdById | integer(int32)|null | false | none | Gets or sets the id of the user who created the activity. This field is ready-only. Any data modified in this field will not be saved. |
| createDate | string(date-time)|null | false | none | Gets or sets the create date. This field is ready-only. Any data modified in this field will not be saved. |
| createdByType | UserType|null | false | none | Gets or sets the type of the created by. |
| lastUpdatedById | integer(int32)|null | false | none | Gets or sets the id of the user who last updated information on the activity. This field is ready-only. Any data modified in this field will not be saved. |
| lastUpdateDate | string(date-time)|null | false | none | Gets or sets the last update date. This field is ready-only. Any data modified in this field will not be saved. |
| lastUpdatedByType | UserType|null | false | none | Gets or sets the last type of the updated by. |
| closedDate | string(date-time)|null | false | none | Gets or sets the date the activity was closed. This field is ready-only. Any data modified in this field will not be saved. |
| assignedUsers | [ActivityUsers]|null | false | none | Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids. |
| notifiedUsers | [ActivityUsers]|null | false | none | Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids. |
| accountId | integer(int32)|null | false | none | Gets or sets the account id. |
| businessEntityId | integer(int32)|null | false | none | Gets or sets the related business entity id. |
| planId | integer(int32)|null | false | none | Gets or sets the related plan id. |
| opportunityId | integer(int32)|null | false | none | Gets or sets the related opportunity id. |
| accountContactId | integer(int32)|null | false | none | Gets or sets the id of the related account contact. |
| censusId | integer(int32)|null | false | none | Gets or sets the related census id. This can also be refered to as the EmployeeId. |
| employeeName | string|null | false | none | Gets or sets the name of the related employee. |
| accountLocationId | integer(int32)|null | false | none | Gets or sets the related account location id. |
| rfpId | integer(int32)|null | false | none | Gets or sets the related RFP id. |
| proposalId | integer(int32)|null | false | none | Gets or sets the related proposal id. |
| recurrenceId | integer(int32)|null | false | none | Gets or sets the recurrence id. |
| recurrenceType | string|null | false | none | Gets or sets the text describing the recurrence. |
| massAddId | integer(int32)|null | false | none | Gets or sets the id indicating which mass add process created the activity. |
| brokerCarrierLinkId | integer(int32)|null | false | none | Gets or sets the broker carrier link id. |
| activityBaseType | BaseType | false | none | Gets or sets the base type. |
| hasWorkflowItems | boolean|null | false | none | Gets or sets a value indicating whether this instance has workflow items. |
| customFields | [CustomFieldValue]|null | false | none | Gets or sets the custom fields. |
| recreate | boolean|null | false | none | Gets or sets a value indicating whether this Activity should be recreated when it is closed. This field is used only by mass activities created by plantypes. |
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
UserType Enumeration
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | UserType Enumeration |
| Property | Value |
|---|---|
| anonymous | ClientContact |
| anonymous | BrokerContact |
| anonymous | ZywaveUser |
| anonymous | HRCEmployee |
| anonymous | HRCDivision |
| anonymous | HRCClient |
| anonymous | HRCClientAdmin |
| anonymous | HRCDemo |
| anonymous | BKBCarrierContact |
| anonymous | BKBSync |
| anonymous | Automated |
| anonymous | Employee |
| anonymous | ProspectContact |
| anonymous | Unknown |
| anonymous | Broker |
{
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
Users class for Notified and Assigned users
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the id. |
| brokerContactId | integer(int32) | false | none | Gets or sets the broker contact id. |
| activityId | integer(int32) | false | none | Gets or sets the activity id. |
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
Indicates the base type of an activity
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Indicates the base type of an activity |
| Property | Value |
|---|---|
| anonymous | Account |
| anonymous | Carrier |
| anonymous | Basic |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Search Criteria for Id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"activityBaseType": {
"description": "Gets or sets the type of the activity base.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"activityTypeId": {
"description": "Gets or sets the activity type id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"accountId": {
"description": "Gets or sets the account id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"censusId": {
"description": "Gets or sets the census id. This can also be refered to as the EmployeeId.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"businessEntityId": {
"description": "Gets or sets the business entity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"accountContactId": {
"description": "Gets or sets the account contact id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"rfpId": {
"description": "Gets or sets the RFP id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planId": {
"description": "Gets or sets the plan id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"proposalId": {
"description": "Gets or sets the proposal id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"massActivityId": {
"description": "Gets or sets the mass activity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"timeSpent": {
"description": "Gets or sets the time spent.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"dueDate": {
"description": "Gets or sets the due date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isOpen": {
"description": "Gets or sets the is open.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"closedDate": {
"description": "Gets or sets the closed date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"subject": {
"description": "Gets or sets the subject.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdById": {
"description": "Gets or sets the created by id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createDate": {
"description": "Gets or sets the create date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedById": {
"description": "Gets or sets the last updated by id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"lastUpdate": {
"description": "Gets or sets the last update.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"assignedUsers": {
"description": "Gets or sets the assigned users.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"notifiedUsers": {
"description": "Gets or sets the notified users.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"hasWorkflowItems": {
"description": "Gets or sets the has workflow items.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"recurrenceId": {
"description": "Gets or sets the recurrence id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"brokerCarrierLinkId": {
"description": "Gets or sets the broker carrier link id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"employeeName": {
"description": "Gets or sets the name of the employee.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"accountLocationId": {
"description": "Gets or sets the account location id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"opportunityId": {
"description": "Gets or sets the opportunity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | ActivitiySearchCriteria|null | false | none | none |
| searchOptions | SearchOptions|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Search Criteria for Id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"activityBaseType": {
"description": "Gets or sets the type of the activity base.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
"activityTypeId": {
"description": "Gets or sets the activity type id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"accountId": {
"description": "Gets or sets the account id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"censusId": {
"description": "Gets or sets the census id. This can also be refered to as the EmployeeId.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"businessEntityId": {
"description": "Gets or sets the business entity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"accountContactId": {
"description": "Gets or sets the account contact id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"rfpId": {
"description": "Gets or sets the RFP id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planId": {
"description": "Gets or sets the plan id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"proposalId": {
"description": "Gets or sets the proposal id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"massActivityId": {
"description": "Gets or sets the mass activity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"timeSpent": {
"description": "Gets or sets the time spent.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"dueDate": {
"description": "Gets or sets the due date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isOpen": {
"description": "Gets or sets the is open.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"closedDate": {
"description": "Gets or sets the closed date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"subject": {
"description": "Gets or sets the subject.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createdById": {
"description": "Gets or sets the created by id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"createDate": {
"description": "Gets or sets the create date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedById": {
"description": "Gets or sets the last updated by id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"lastUpdate": {
"description": "Gets or sets the last update.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"assignedUsers": {
"description": "Gets or sets the assigned users.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"notifiedUsers": {
"description": "Gets or sets the notified users.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"hasWorkflowItems": {
"description": "Gets or sets the has workflow items.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"recurrenceId": {
"description": "Gets or sets the recurrence id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"brokerCarrierLinkId": {
"description": "Gets or sets the broker carrier link id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"employeeName": {
"description": "Gets or sets the name of the employee.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"accountLocationId": {
"description": "Gets or sets the account location id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"opportunityId": {
"description": "Gets or sets the opportunity id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | IdListSearchCriteria|null | false | none | Search Criteria for Id. |
| activityBaseType | EnumSearchCriteriaOfBaseType|null | false | none | Gets or sets the type of the activity base. |
| customFields | [CustomFieldSearchValue]|null | false | none | Gets or sets the custom fields. |
| activityTypeId | IdListSearchCriteria|null | false | none | Gets or sets the activity type id. |
| accountId | IdListSearchCriteria|null | false | none | Gets or sets the account id. |
| censusId | IntSearchCriteria|null | false | none | Gets or sets the census id. This can also be refered to as the EmployeeId. |
| businessEntityId | IdListSearchCriteria|null | false | none | Gets or sets the business entity id. |
| accountContactId | IdListSearchCriteria|null | false | none | Gets or sets the account contact id. |
| rfpId | IdListSearchCriteria|null | false | none | Gets or sets the RFP id. |
| planId | IdListSearchCriteria|null | false | none | Gets or sets the plan id. |
| proposalId | IdListSearchCriteria|null | false | none | Gets or sets the proposal id. |
| massActivityId | IdListSearchCriteria|null | false | none | Gets or sets the mass activity id. |
| timeSpent | IntSearchCriteria|null | false | none | Gets or sets the time spent. |
| dueDate | DateTimeSearchCriteria|null | false | none | Gets or sets the due date. |
| isOpen | BooleanSearchCriteria|null | false | none | Gets or sets the is open. |
| closedDate | DateTimeSearchCriteria|null | false | none | Gets or sets the closed date. |
| subject | StringSearchCriteria|null | false | none | Gets or sets the subject. |
| createdById | IntSearchCriteria|null | false | none | Gets or sets the created by id. |
| createdByType | StringSearchCriteria|null | false | none | Gets or sets the type of the created by. |
| createDate | DateTimeSearchCriteria|null | false | none | Gets or sets the create date. |
| lastUpdatedById | IntSearchCriteria|null | false | none | Gets or sets the last updated by id. |
| lastUpdatedByType | StringSearchCriteria|null | false | none | Gets or sets the last type of the updated by. |
| lastUpdate | DateTimeSearchCriteria|null | false | none | Gets or sets the last update. |
| assignedUsers | IdListSearchCriteria|null | false | none | Gets or sets the assigned users. |
| notifiedUsers | IdListSearchCriteria|null | false | none | Gets or sets the notified users. |
| hasWorkflowItems | BooleanSearchCriteria|null | false | none | Gets or sets the has workflow items. |
| recurrenceId | NullableIdListSearchCriteria|null | false | none | Gets or sets the recurrence id. |
| brokerCarrierLinkId | IntSearchCriteria|null | false | none | Gets or sets the broker carrier link id. |
| employeeName | StringSearchCriteria|null | false | none | Gets or sets the name of the employee. |
| accountLocationId | IntSearchCriteria|null | false | none | Gets or sets the account location id. |
| opportunityId | IntSearchCriteria|null | false | none | Gets or sets the opportunity id. |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | BaseType | false | none | Indicates the base type of an activity |
| » valueList | [BaseType]|null | false | none | [Indicates the base type of an activity] |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | IdListSearchCriteria | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Gets or sets the id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"name": {
"description": "Gets or sets the name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"brokerId": {
"description": "Gets or sets the broker id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"sortOrder": {
"description": "Gets or sets the sort order.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isDeleted": {
"description": "Gets or sets the is deleted.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"followUpDateInterval": {
"description": "Gets or sets the follow up date interval.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"allowOverride": {
"description": "Gets or sets the allow override.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"isReserved": {
"description": "Gets or sets the is reserved.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"defaultClosed": {
"description": "Gets or sets the default closed.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnBenefitClients": {
"description": "Gets or sets the show on benefit clients.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnPCClients": {
"description": "Gets or sets the show on PC clients.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnBenefitProspects": {
"description": "Gets or sets the show on benefit prospects.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnPCProspects": {
"description": "Gets or sets the show on PC prospects.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnLeads": {
"description": "Gets or sets the show on leads.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"activityBaseType": {
"description": "Gets or sets the type of the activity base.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | ActivityTypeSearchCriteria|null | false | none | none |
| searchOptions | SearchOptions|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Gets or sets the id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"name": {
"description": "Gets or sets the name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"brokerId": {
"description": "Gets or sets the broker id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"sortOrder": {
"description": "Gets or sets the sort order.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isDeleted": {
"description": "Gets or sets the is deleted.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"followUpDateInterval": {
"description": "Gets or sets the follow up date interval.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"allowOverride": {
"description": "Gets or sets the allow override.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"isReserved": {
"description": "Gets or sets the is reserved.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"defaultClosed": {
"description": "Gets or sets the default closed.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnBenefitClients": {
"description": "Gets or sets the show on benefit clients.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnPCClients": {
"description": "Gets or sets the show on PC clients.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnBenefitProspects": {
"description": "Gets or sets the show on benefit prospects.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnPCProspects": {
"description": "Gets or sets the show on PC prospects.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"showOnLeads": {
"description": "Gets or sets the show on leads.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"activityBaseType": {
"description": "Gets or sets the type of the activity base.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
}
}
}
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | IdListSearchCriteria|null | false | none | Gets or sets the id. |
| name | StringSearchCriteria|null | false | none | Gets or sets the name. |
| brokerId | IdListSearchCriteria|null | false | none | Gets or sets the broker id. |
| sortOrder | IntSearchCriteria|null | false | none | Gets or sets the sort order. |
| isDeleted | BooleanSearchCriteria|null | false | none | Gets or sets the is deleted. |
| followUpDateInterval | IntSearchCriteria|null | false | none | Gets or sets the follow up date interval. |
| allowOverride | BooleanSearchCriteria|null | false | none | Gets or sets the allow override. |
| isReserved | BooleanSearchCriteria|null | false | none | Gets or sets the is reserved. |
| defaultClosed | BooleanSearchCriteria|null | false | none | Gets or sets the default closed. |
| showOnBenefitClients | BooleanSearchCriteria|null | false | none | Gets or sets the show on benefit clients. |
| showOnPCClients | BooleanSearchCriteria|null | false | none | Gets or sets the show on PC clients. |
| showOnBenefitProspects | BooleanSearchCriteria|null | false | none | Gets or sets the show on benefit prospects. |
| showOnPCProspects | BooleanSearchCriteria|null | false | none | Gets or sets the show on PC prospects. |
| showOnLeads | BooleanSearchCriteria|null | false | none | Gets or sets the show on leads. |
| activityBaseType | EnumSearchCriteriaOfBaseType|null | false | none | Gets or sets the type of the activity base. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"activity": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Represents a full activity object used for adding, editing and viewing a single item.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the activity id.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32"
},
"activityTypeId": {
"type": "integer",
"description": "Gets or sets the activity type id.",
"format": "int32"
},
"timeSpent": {
"type": "integer",
"description": "Gets or sets the time spent completing the activity. Time is represented in minutes.",
"format": "int32",
"nullable": true
},
"dueDate": {
"type": "string",
"description": "Gets or sets the due date of the activity.",
"format": "date-time",
"nullable": true
},
"isOpen": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this activity is open or closed."
},
"subject": {
"type": "string",
"description": "Gets or sets the activity subject.",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the saved activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"first25Notes": {
"type": "string",
"description": "Gets or sets the first 25 characters of the activity notes.\nThis field is ready-only. Any data modified in this field will not be saved.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets or sets the id of the user who created the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"createDate": {
"type": "string",
"description": "Gets or sets the create date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"createdByType": {
"description": "Gets or sets the type of the created by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets or sets the id of the user who last updated information on the activity.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets or sets the last update date.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"lastUpdatedByType": {
"description": "Gets or sets the last type of the updated by.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "UserType Enumeration",
"x-enumNames": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
],
"enum": [
"ClientContact",
"BrokerContact",
"ZywaveUser",
"HRCEmployee",
"HRCDivision",
"HRCClient",
"HRCClientAdmin",
"HRCDemo",
"BKBCarrierContact",
"BKBSync",
"Automated",
"Employee",
"ProspectContact",
"Unknown",
"Broker"
]
}
]
},
"closedDate": {
"type": "string",
"description": "Gets or sets the date the activity was closed.\nThis field is ready-only. Any data modified in this field will not be saved.",
"format": "date-time",
"nullable": true
},
"assignedUsers": {
"type": "array",
"description": "Gets or sets the list of users who are assigned to the activity. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"notifiedUsers": {
"type": "array",
"description": "Gets or sets the list of users who get notified on activity updates. List contains brokercontact ids.",
"nullable": true,
"items": {
"type": "object",
"description": "Users class for Notified and Assigned users",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the id.",
"format": "int32"
},
"brokerContactId": {
"type": "integer",
"description": "Gets or sets the broker contact id.",
"format": "int32"
},
"activityId": {
"type": "integer",
"description": "Gets or sets the activity id.",
"format": "int32"
}
}
}
},
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32",
"nullable": true
},
"businessEntityId": {
"type": "integer",
"description": "Gets or sets the related business entity id.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the related plan id.",
"format": "int32",
"nullable": true
},
"opportunityId": {
"type": "integer",
"description": "Gets or sets the related opportunity id.",
"format": "int32",
"nullable": true
},
"accountContactId": {
"type": "integer",
"description": "Gets or sets the id of the related account contact.",
"format": "int32",
"nullable": true
},
"censusId": {
"type": "integer",
"description": "Gets or sets the related census id. This can also be refered to as the EmployeeId.",
"format": "int32",
"nullable": true
},
"employeeName": {
"type": "string",
"description": "Gets or sets the name of the related employee.",
"nullable": true
},
"accountLocationId": {
"type": "integer",
"description": "Gets or sets the related account location id.",
"format": "int32",
"nullable": true
},
"rfpId": {
"type": "integer",
"description": "Gets or sets the related RFP id.",
"format": "int32",
"nullable": true
},
"proposalId": {
"type": "integer",
"description": "Gets or sets the related proposal id.",
"format": "int32",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"description": "Gets or sets the recurrence id.",
"format": "int32",
"nullable": true
},
"recurrenceType": {
"type": "string",
"description": "Gets or sets the text describing the recurrence.",
"nullable": true
},
"massAddId": {
"type": "integer",
"description": "Gets or sets the id indicating which mass add process created the activity.",
"format": "int32",
"nullable": true
},
"brokerCarrierLinkId": {
"type": "integer",
"description": "Gets or sets the broker carrier link id.",
"format": "int32",
"nullable": true
},
"activityBaseType": {
"description": "Gets or sets the base type.",
"oneOf": [
{
"type": "string",
"description": "Indicates the base type of an activity",
"x-enumNames": [
"Account",
"Carrier",
"Basic"
],
"enum": [
"Account",
"Carrier",
"Basic"
]
}
]
},
"hasWorkflowItems": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has workflow items.",
"nullable": true
},
"customFields": {
"type": "array",
"description": "Gets or sets the custom fields.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"recreate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this Activity should be recreated when it is closed. \nThis field is used only by mass activities created by plantypes.",
"nullable": true
}
}
}
]
},
"crudOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| activity | Activity|null | false | none | Represents a full activity object used for adding, editing and viewing a single item. |
| crudOptions | CrudOptions|null | false | none | none |
{
"allOf": [
{
"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": {
"folderId": {
"type": "string",
"description": "UUID of folder containing the audited files.",
"format": "guid"
},
"folderLocation": {
"type": "string",
"description": "Full path within the entity hierarchy."
},
"folderName": {
"type": "string",
"description": "Display name of this folder."
},
"files": {
"type": "array",
"description": "Files with their audit histories inside folder.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier of the audited file.",
"format": "guid"
},
"fileName": {
"type": "string",
"description": "Display name including file extension."
},
"audits": {
"type": "array",
"description": "Ordered list of audit events; newest first.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"actionPerformed": {
"type": "string",
"description": "Verb describing event; e.g., Uploaded, Moved."
},
"actionPerformedBy": {
"type": "string",
"description": "Username who performed this specific action."
},
"actionPerformedDate": {
"type": "string",
"description": "UTC ISO 8601 timestamp of the action.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "File status at time of this action."
}
}
}
}
}
}
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PagedResultOfAuditResponse | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | 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": {
"type": "object",
"additionalProperties": false,
"properties": {
"folderId": {
"type": "string",
"description": "UUID of folder containing the audited files.",
"format": "guid"
},
"folderLocation": {
"type": "string",
"description": "Full path within the entity hierarchy."
},
"folderName": {
"type": "string",
"description": "Display name of this folder."
},
"files": {
"type": "array",
"description": "Files with their audit histories inside folder.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier of the audited file.",
"format": "guid"
},
"fileName": {
"type": "string",
"description": "Display name including file extension."
},
"audits": {
"type": "array",
"description": "Ordered list of audit events; newest first.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"actionPerformed": {
"type": "string",
"description": "Verb describing event; e.g., Uploaded, Moved."
},
"actionPerformedBy": {
"type": "string",
"description": "Username who performed this specific action."
},
"actionPerformedDate": {
"type": "string",
"description": "UTC ISO 8601 timestamp of the action.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "File status at time of this action."
}
}
}
}
}
}
}
}
}
}
}
}
| 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 | [AuditResponse] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"folderId": {
"type": "string",
"description": "UUID of folder containing the audited files.",
"format": "guid"
},
"folderLocation": {
"type": "string",
"description": "Full path within the entity hierarchy."
},
"folderName": {
"type": "string",
"description": "Display name of this folder."
},
"files": {
"type": "array",
"description": "Files with their audit histories inside folder.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier of the audited file.",
"format": "guid"
},
"fileName": {
"type": "string",
"description": "Display name including file extension."
},
"audits": {
"type": "array",
"description": "Ordered list of audit events; newest first.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"actionPerformed": {
"type": "string",
"description": "Verb describing event; e.g., Uploaded, Moved."
},
"actionPerformedBy": {
"type": "string",
"description": "Username who performed this specific action."
},
"actionPerformedDate": {
"type": "string",
"description": "UTC ISO 8601 timestamp of the action.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "File status at time of this action."
}
}
}
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| folderId | string(guid) | false | none | UUID of folder containing the audited files. |
| folderLocation | string | false | none | Full path within the entity hierarchy. |
| folderName | string | false | none | Display name of this folder. |
| files | [AuditFileItem] | false | none | Files with their audit histories inside folder. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier of the audited file.",
"format": "guid"
},
"fileName": {
"type": "string",
"description": "Display name including file extension."
},
"audits": {
"type": "array",
"description": "Ordered list of audit events; newest first.",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"actionPerformed": {
"type": "string",
"description": "Verb describing event; e.g., Uploaded, Moved."
},
"actionPerformedBy": {
"type": "string",
"description": "Username who performed this specific action."
},
"actionPerformedDate": {
"type": "string",
"description": "UTC ISO 8601 timestamp of the action.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "File status at time of this action."
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fileId | string(guid) | false | none | UUID public identifier of the audited file. |
| fileName | string | false | none | Display name including file extension. |
| audits | [AuditEntry] | false | none | Ordered list of audit events; newest first. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"actionPerformed": {
"type": "string",
"description": "Verb describing event; e.g., Uploaded, Moved."
},
"actionPerformedBy": {
"type": "string",
"description": "Username who performed this specific action."
},
"actionPerformedDate": {
"type": "string",
"description": "UTC ISO 8601 timestamp of the action.",
"format": "date-time"
},
"status": {
"type": "string",
"description": "File status at time of this action."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| actionPerformed | string | false | none | Verb describing event; e.g., Uploaded, Moved. |
| actionPerformedBy | string | false | none | Username who performed this specific action. |
| actionPerformedDate | string(date-time) | false | none | UTC ISO 8601 timestamp of the action. |
| status | string | false | none | File status at time of this action. |
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | General |
| anonymous | Account |
| anonymous | Carrier |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"planTypeBenefitItemTierId",
"planId",
"benefitItemValueTypeId",
"updatedUserId"
],
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"planId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
},
"customText": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"value": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemValueId"
],
"properties": {
"benefitItemValueId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemValueInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » benefitItemValueId | integer(int32) | true | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"planTypeBenefitItemTierId",
"planId",
"benefitItemValueTypeId",
"updatedUserId"
],
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"planId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
},
"customText": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"value": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BulkBenefitItemValueInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"benefitItemId",
"planTypeBenefitItemTierId",
"planId",
"benefitItemValueTypeId",
"updatedUserId"
],
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"planId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
},
"customText": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"value": {
"type": "string",
"maxLength": 1000,
"minLength": 0,
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| benefitItemId | integer(int32) | true | none | none |
| planTypeBenefitItemTierId | integer(int32) | true | none | none |
| planId | integer(int32) | true | none | none |
| benefitItemValueTypeId | integer(int32) | true | none | none |
| customText | string|null | false | none | none |
| value | string|null | false | none | none |
| effectiveDate | string(date-time)|null | false | none | none |
| updatedUserId | string(guid) | true | none | none |
| updatedDateTime | string(date-time)|null | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"customText": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"benefitItemId": {
"type": "integer",
"format": "int32"
},
"planTypeBenefitItemTierId": {
"type": "integer",
"format": "int32"
},
"benefitItemValueTypeId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | BenefitItemValueUpdateInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » benefitItemId | integer(int32) | false | none | none |
| » planTypeBenefitItemTierId | integer(int32) | false | none | none |
| » benefitItemValueTypeId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"customText": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customText | string|null | false | none | none |
| value | string|null | false | none | none |
| effectiveDate | string(date-time)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"isRequired": {
"type": "boolean"
},
"isImportant": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"isArchived": {
"type": "boolean"
},
"updatedDateTime": {
"type": "string",
"format": "date-time"
},
"updatedUserId": {
"type": "string",
"format": "guid"
},
"name": {
"type": "string"
},
"planTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"benefitItemTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"parentBenefitItemId": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| isRequired | boolean | false | none | none |
| isImportant | boolean | false | none | none |
| sortOrder | integer(int32) | false | none | none |
| isArchived | boolean | false | none | none |
| updatedDateTime | string(date-time) | false | none | none |
| updatedUserId | string(guid) | false | none | none |
| name | string | false | none | none |
| planTypeId | integer(int32)|null | false | none | none |
| benefitItemTypeId | integer(int32)|null | false | none | none |
| parentBenefitItemId | integer(int32)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"planTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"name": {
"type": "string"
},
"benefitItemTierId": {
"type": "integer",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"isArchived": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| planTypeId | integer(int32)|null | false | none | none |
| name | string | false | none | none |
| benefitItemTierId | integer(int32) | false | none | none |
| sortOrder | integer(int32) | false | none | none |
| isArchived | boolean | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"sortOrder",
"defaultFormat"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"defaultFormat": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string | true | none | none |
| sortOrder | integer(int32) | true | none | none |
| defaultFormat | string | true | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCsrid": {
"type": "string",
"nullable": true
},
"amsProducerID": {
"type": "string",
"nullable": true
},
"allowAccountAdd": {
"type": "boolean"
},
"allowAccountDelete": {
"type": "boolean"
},
"allowAdminMenuManagement": {
"type": "boolean"
},
"allowCarrierManagement": {
"type": "boolean"
},
"allowDeleteFiles": {
"type": "boolean"
},
"altMailingAddressId": {
"type": "integer",
"format": "int32"
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"designation": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"faxNumber": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"hasBKBAccess": {
"type": "boolean"
},
"hasGlobalAccess": {
"type": "boolean"
},
"homePageViewID": {
"type": "string",
"description": "",
"x-enumNames": [
"NotSet",
"Account",
"Sales"
],
"enum": [
"NotSet",
"Account",
"Sales"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"isBuilderAdministrator": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"lastName": {
"type": "string",
"nullable": true
},
"lineOfBusinessId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"middleInitial": {
"type": "string",
"nullable": true
},
"numberOfActivitiesShown": {
"type": "integer",
"format": "int32"
},
"parentBrokerContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"reportAccess": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Team",
"All"
],
"enum": [
"None",
"Team",
"All"
]
},
"roleId": {
"type": "string",
"format": "guid",
"nullable": true
},
"salutation": {
"type": "string",
"nullable": true
},
"suppressFromClients": {
"type": "boolean"
},
"title": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"viewAgreementDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amsCsrid | string|null | false | none | none |
| amsProducerID | string|null | false | none | none |
| allowAccountAdd | boolean | false | none | none |
| allowAccountDelete | boolean | false | none | none |
| allowAdminMenuManagement | boolean | false | none | none |
| allowCarrierManagement | boolean | false | none | none |
| allowDeleteFiles | boolean | false | none | none |
| altMailingAddressId | integer(int32) | false | none | none |
| brokerId | integer(int32) | false | none | none |
| designation | string|null | false | none | none |
| emailAddress | string|null | false | none | none |
| faxNumber | string|null | false | none | none |
| firstName | string|null | false | none | none |
| hasBKBAccess | boolean | false | none | none |
| hasGlobalAccess | boolean | false | none | none |
| homePageViewID | HomePageViews | false | none | none |
| id | integer(int32) | false | none | none |
| isBuilderAdministrator | boolean | false | none | none |
| isDeleted | boolean | false | none | none |
| lastName | string|null | false | none | none |
| lineOfBusinessId | integer(int32)|null | false | none | none |
| middleInitial | string|null | false | none | none |
| numberOfActivitiesShown | integer(int32) | false | none | none |
| parentBrokerContactId | integer(int32)|null | false | none | none |
| phoneNumber | string|null | false | none | none |
| reportAccess | Permission | false | none | none |
| roleId | string(guid)|null | false | none | none |
| salutation | string|null | false | none | none |
| suppressFromClients | boolean | false | none | none |
| title | string|null | false | none | none |
| username | string|null | false | none | none |
| viewAgreementDate | string(date-time)|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"NotSet",
"Account",
"Sales"
],
"enum": [
"NotSet",
"Account",
"Sales"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | NotSet |
| anonymous | Account |
| anonymous | Sales |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Team",
"All"
],
"enum": [
"None",
"Team",
"All"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Team |
| anonymous | All |
{
"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",
"description": "Gets the BrokerageBuilder carrier.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this BrokerageBuilder carrier.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name of the carrier.",
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this carrier has been deleted."
},
"amBestRating": {
"type": "string",
"description": "Gets or sets the financial strength rating as designated by A.M. Best Co. for this carrier.",
"nullable": true
},
"websiteUrl": {
"type": "string",
"description": "Gets or sets the Web site URL for this carrier.",
"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 | [Carrier] | false | none | [Gets the BrokerageBuilder carrier.] |
{
"type": "object",
"description": "Gets the BrokerageBuilder carrier.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this BrokerageBuilder carrier.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name of the carrier.",
"nullable": true
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this carrier has been deleted."
},
"amBestRating": {
"type": "string",
"description": "Gets or sets the financial strength rating as designated by A.M. Best Co. for this carrier.",
"nullable": true
},
"websiteUrl": {
"type": "string",
"description": "Gets or sets the Web site URL for this carrier.",
"nullable": true
}
}
}
Gets the BrokerageBuilder carrier.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique ID for this BrokerageBuilder carrier. |
| name | string|null | false | none | Gets or sets the name of the carrier. |
| isDeleted | boolean | false | none | Gets or sets a value indicating whether this carrier has been deleted. |
| amBestRating | string|null | false | none | Gets or sets the financial strength rating as designated by A.M. Best Co. for this carrier. |
| websiteUrl | string|null | false | none | Gets or sets the Web site URL for this carrier. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Criteria used to search for BrokerageBuilder carriers",
"additionalProperties": false,
"properties": {
"amBestRating": {
"description": "Gets or sets the search criteria used to find a carrier by A.M. Best rating.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the search criteria used to find a carrier by ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"name": {
"description": "Gets or sets the search criteria used to find a carrier by carrier name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"websiteUrl": {
"description": "Gets or sets the search criteria used to find a carrier using the Web site URL.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | CarrierSearchCriteria|null | false | none | Criteria used to search for BrokerageBuilder carriers |
| searchOptions | SearchOptions|null | false | none | none |
{
"type": "object",
"description": "Criteria used to search for BrokerageBuilder carriers",
"additionalProperties": false,
"properties": {
"amBestRating": {
"description": "Gets or sets the search criteria used to find a carrier by A.M. Best rating.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the search criteria used to find a carrier by ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"name": {
"description": "Gets or sets the search criteria used to find a carrier by carrier name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"websiteUrl": {
"description": "Gets or sets the search criteria used to find a carrier using the Web site URL.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
}
}
}
Criteria used to search for BrokerageBuilder carriers
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amBestRating | StringSearchCriteria|null | false | none | Gets or sets the search criteria used to find a carrier by A.M. Best rating. |
| id | IdListSearchCriteria|null | false | none | Gets or sets the search criteria used to find a carrier by ID. |
| name | StringSearchCriteria|null | false | none | Gets or sets the search criteria used to find a carrier by carrier name. |
| websiteUrl | StringSearchCriteria|null | false | none | Gets or sets the search criteria used to find a carrier using the Web site URL. |
{
"type": "object",
"description": "Carrier Contact",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique ID for this carrier contact.",
"format": "int32"
},
"carrierId": {
"type": "integer",
"description": "Gets the unique ID for this carrier.",
"format": "int32",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Gets the first name of the carrier contact."
},
"lastName": {
"type": "string",
"description": "Gets the last name of the carrier contact."
},
"department": {
"type": "string",
"description": "Gets the department this carrier contact is a part of."
},
"jobDesc": {
"type": "string",
"description": "Gets the job description for this carrier contact."
},
"phone": {
"type": "string",
"description": "Gets the phone number for this carrier contact."
},
"phone2": {
"type": "string",
"description": "Gets the phone number for this carrier contact."
},
"phoneExtension": {
"type": "string",
"description": "Gets the phone extension for this carrier contact."
},
"phoneExtension2": {
"type": "string",
"description": "Gets the phone extension for this carrier contact."
},
"fax": {
"type": "string",
"description": "Gets the fax number for this carrier contact."
},
"email": {
"type": "string",
"description": "Gets the e-mail address for this carrier contact."
},
"defaultContact": {
"type": "boolean",
"description": "Gets a value that indicates if the contact is the default contact.",
"nullable": true
},
"address": {
"type": "string",
"description": "Gets the street address for this carrier contact."
},
"address2": {
"type": "string",
"description": "Gets the second address line for this carrier contact."
},
"city": {
"type": "string",
"description": "Gets the city for this carrier contact location."
},
"state": {
"type": "string",
"description": "Gets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province."
},
"zip": {
"type": "string",
"description": "Gets the ZIP for this carrier contact location."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this carrier contact has been deleted."
},
"roleId": {
"type": "integer",
"description": "Gets the unique role ID for this carrier contact.",
"format": "int32",
"nullable": true
},
"lastUpdateDate": {
"type": "string",
"description": "Gets the date on which this carrier contact was last updated.",
"format": "date-time",
"nullable": true
}
}
}
Carrier Contact
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets the unique ID for this carrier contact. |
| carrierId | integer(int32)|null | false | none | Gets the unique ID for this carrier. |
| firstName | string | false | none | Gets the first name of the carrier contact. |
| lastName | string | false | none | Gets the last name of the carrier contact. |
| department | string | false | none | Gets the department this carrier contact is a part of. |
| jobDesc | string | false | none | Gets the job description for this carrier contact. |
| phone | string | false | none | Gets the phone number for this carrier contact. |
| phone2 | string | false | none | Gets the phone number for this carrier contact. |
| phoneExtension | string | false | none | Gets the phone extension for this carrier contact. |
| phoneExtension2 | string | false | none | Gets the phone extension for this carrier contact. |
| fax | string | false | none | Gets the fax number for this carrier contact. |
| string | false | none | Gets the e-mail address for this carrier contact. | |
| defaultContact | boolean|null | false | none | Gets a value that indicates if the contact is the default contact. |
| address | string | false | none | Gets the street address for this carrier contact. |
| address2 | string | false | none | Gets the second address line for this carrier contact. |
| city | string | false | none | Gets the city for this carrier contact location. |
| state | string | false | none | Gets the two-letter abbreviation for U.S. state/territory, Canadian, Carribbean or Mexican province. |
| zip | string | false | none | Gets the ZIP for this carrier contact location. |
| isDeleted | boolean | false | none | Gets a value indicating whether this carrier contact has been deleted. |
| roleId | integer(int32)|null | false | none | Gets the unique role ID for this carrier contact. |
| lastUpdateDate | string(date-time)|null | false | none | Gets the date on which this carrier contact was last updated. |
{
"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",
"description": "Gets the BrokerageBuilder carrier along with the internal code.",
"additionalProperties": false,
"properties": {
"alternateName": {
"type": "string",
"description": "Gets the alternate name of the carrier with the code.",
"nullable": true
},
"code": {
"type": "string",
"description": "Gets or sets the carrier code - the carrier ID as entered in a third-party system.",
"nullable": true
},
"carrierId": {
"type": "integer",
"description": "Gets the unique ID for this BrokerageBuilder carrier.",
"format": "int32"
},
"id": {
"type": "integer",
"description": "Gets the unique code ID.",
"format": "int32"
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this carrier code has been deleted."
}
}
}
}
}
}
| 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 | [CarrierCode] | false | none | [Gets the BrokerageBuilder carrier along with the internal code.] |
{
"type": "object",
"description": "Gets the BrokerageBuilder carrier along with the internal code.",
"additionalProperties": false,
"properties": {
"alternateName": {
"type": "string",
"description": "Gets the alternate name of the carrier with the code.",
"nullable": true
},
"code": {
"type": "string",
"description": "Gets or sets the carrier code - the carrier ID as entered in a third-party system.",
"nullable": true
},
"carrierId": {
"type": "integer",
"description": "Gets the unique ID for this BrokerageBuilder carrier.",
"format": "int32"
},
"id": {
"type": "integer",
"description": "Gets the unique code ID.",
"format": "int32"
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether this carrier code has been deleted."
}
}
}
Gets the BrokerageBuilder carrier along with the internal code.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| alternateName | string|null | false | none | Gets the alternate name of the carrier with the code. |
| code | string|null | false | none | Gets or sets the carrier code - the carrier ID as entered in a third-party system. |
| carrierId | integer(int32) | false | none | Gets the unique ID for this BrokerageBuilder carrier. |
| id | integer(int32) | false | none | Gets the unique code ID. |
| isDeleted | boolean | false | none | Gets a value indicating whether this carrier code has been deleted. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "The search criteria used to find a business entity or carrier in BrokerageBuilder by the linked internal codes.",
"additionalProperties": false,
"properties": {
"alternateName": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by alternate carrier name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"code": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by AMS carrier code.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"carrierId": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by carrier ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by carrier code ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | CarrierCodeSearchCriteria|null | false | none | The search criteria used to find a business entity or carrier in BrokerageBuilder by the linked internal codes. |
| searchOptions | SearchOptions|null | false | none | none |
{
"type": "object",
"description": "The search criteria used to find a business entity or carrier in BrokerageBuilder by the linked internal codes.",
"additionalProperties": false,
"properties": {
"alternateName": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by alternate carrier name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"code": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by AMS carrier code.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"carrierId": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by carrier ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"id": {
"description": "Gets or sets the search criteria used to find a business entity or carrier by carrier code ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
}
}
}
The search criteria used to find a business entity or carrier in BrokerageBuilder by the linked internal codes.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| alternateName | StringSearchCriteria|null | false | none | Gets or sets the search criteria used to find a business entity or carrier by alternate carrier name. |
| code | StringSearchCriteria|null | false | none | Gets or sets the search criteria used to find a business entity or carrier by AMS carrier code. |
| carrierId | IdListSearchCriteria|null | false | none | Gets or sets the search criteria used to find a business entity or carrier by carrier ID. |
| id | IdListSearchCriteria|null | false | none | Gets or sets the search criteria used to find a business entity or carrier by carrier code ID. |
{
"type": "object",
"description": "CompensationType",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID.",
"format": "int32"
},
"brokerId": {
"type": "integer",
"description": "Gets or sets the broker ID.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets the description."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance has been deleted."
}
}
}
CompensationType
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique ID. |
| brokerId | integer(int32) | false | none | Gets or sets the broker ID. |
| description | string | false | none | Gets the description. |
| isDeleted | boolean | false | none | Gets or sets a value indicating whether this instance has been deleted. |
{
"type": "object",
"description": "Gets the carrier commission schedule.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique ID for this commission schedule.",
"format": "int32"
},
"newOrRenewal": {
"description": "Gets the renewal type applied to this schedule.",
"oneOf": [
{
"type": "string",
"description": "Commission Schedule Renewal Types",
"x-enumNames": [
"Renewal",
"New",
"Both"
],
"enum": [
"Renewal",
"New",
"Both"
]
}
]
},
"accountId": {
"type": "integer",
"description": "Gets the specific account that this commission schedule applies to.",
"format": "int32",
"nullable": true
},
"effectiveDate": {
"type": "string",
"description": "Gets the effective date for this commission schedule.",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"description": "Gets the expiration date for this commission schedule.",
"format": "date-time",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets the plan type that this commission schedule applies to.",
"format": "int32"
},
"scheduleType": {
"description": "Gets or sets the schedule type for this commission schedule.",
"oneOf": [
{
"type": "string",
"description": "Commission Schedule Types.",
"x-enumNames": [
"Flat",
"Graded",
"SubscriberBased"
],
"enum": [
"Flat",
"Graded",
"SubscriberBased"
]
}
]
},
"name": {
"type": "string",
"description": "Gets the name of this commission schedule.",
"nullable": true
},
"carrierId": {
"type": "integer",
"description": "Gets the ID for the carrier related to this commission schedule.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets the description for this commission schedule.",
"nullable": true
},
"createdById": {
"type": "integer",
"description": "Gets the ID for the user who created this commission schedule.",
"format": "int32"
},
"createdDate": {
"type": "string",
"description": "Gets the date and time on which this commission schedule was created.",
"format": "date-time"
},
"lastUpdatedById": {
"type": "integer",
"description": "Gets the date on which this commission schedule last updated by ID.",
"format": "int32",
"nullable": true
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time on which this commission schedule was last updated.",
"format": "date-time",
"nullable": true
}
}
}
Gets the carrier commission schedule.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets the unique ID for this commission schedule. |
| newOrRenewal | ScheduleRenewalTypes | false | none | Gets the renewal type applied to this schedule. |
| accountId | integer(int32)|null | false | none | Gets the specific account that this commission schedule applies to. |
| effectiveDate | string(date-time) | false | none | Gets the effective date for this commission schedule. |
| expirationDate | string(date-time)|null | false | none | Gets the expiration date for this commission schedule. |
| planTypeId | integer(int32) | false | none | Gets the plan type that this commission schedule applies to. |
| scheduleType | ScheduleTypes | false | none | Gets or sets the schedule type for this commission schedule. |
| name | string|null | false | none | Gets the name of this commission schedule. |
| carrierId | integer(int32) | false | none | Gets the ID for the carrier related to this commission schedule. |
| description | string|null | false | none | Gets the description for this commission schedule. |
| createdById | integer(int32) | false | none | Gets the ID for the user who created this commission schedule. |
| createdDate | string(date-time) | false | none | Gets the date and time on which this commission schedule was created. |
| lastUpdatedById | integer(int32)|null | false | none | Gets the date on which this commission schedule last updated by ID. |
| lastUpdatedDate | string(date-time)|null | false | none | Gets the date and time on which this commission schedule was last updated. |
{
"type": "string",
"description": "Commission Schedule Renewal Types",
"x-enumNames": [
"Renewal",
"New",
"Both"
],
"enum": [
"Renewal",
"New",
"Both"
]
}
Commission Schedule Renewal Types
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Commission Schedule Renewal Types |
| Property | Value |
|---|---|
| anonymous | Renewal |
| anonymous | New |
| anonymous | Both |
{
"type": "string",
"description": "Commission Schedule Types.",
"x-enumNames": [
"Flat",
"Graded",
"SubscriberBased"
],
"enum": [
"Flat",
"Graded",
"SubscriberBased"
]
}
Commission Schedule Types.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Commission Schedule Types. |
| Property | Value |
|---|---|
| anonymous | Flat |
| anonymous | Graded |
| anonymous | SubscriberBased |
{
"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",
"description": "Carrier CommissionStatement",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this statement.",
"format": "int32"
},
"carrierId": {
"type": "integer",
"description": "Gets or sets the carrier ID associated with this statement.",
"format": "int32"
},
"checkNumber": {
"type": "string",
"description": "Gets or sets the check number for the payment of the commission.",
"nullable": true
},
"depositDate": {
"type": "string",
"description": "Gets or sets the date on which the commission dollars were deposited.",
"format": "date-time"
},
"isPosted": {
"type": "boolean",
"description": "Gets a value indicating whether this instance is posted."
},
"postedById": {
"type": "integer",
"description": "Gets the ID of the user who posted the statement.",
"format": "int32",
"nullable": true
},
"postedDate": {
"type": "string",
"description": "Gets the date and time the statement was posted.",
"format": "date-time",
"nullable": true
},
"statementDate": {
"type": "string",
"description": "Gets or sets the statement date.",
"format": "date-time"
},
"statementNumber": {
"type": "string",
"description": "Gets or sets the number from the statement.",
"nullable": true
},
"statementTotal": {
"type": "number",
"description": "Gets or sets the total commission paid out (amount of the check).",
"format": "decimal"
}
}
}
}
}
}
| 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 | [CommissionStatement] | false | none | [Carrier CommissionStatement] |
{
"type": "object",
"description": "Carrier CommissionStatement",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this statement.",
"format": "int32"
},
"carrierId": {
"type": "integer",
"description": "Gets or sets the carrier ID associated with this statement.",
"format": "int32"
},
"checkNumber": {
"type": "string",
"description": "Gets or sets the check number for the payment of the commission.",
"nullable": true
},
"depositDate": {
"type": "string",
"description": "Gets or sets the date on which the commission dollars were deposited.",
"format": "date-time"
},
"isPosted": {
"type": "boolean",
"description": "Gets a value indicating whether this instance is posted."
},
"postedById": {
"type": "integer",
"description": "Gets the ID of the user who posted the statement.",
"format": "int32",
"nullable": true
},
"postedDate": {
"type": "string",
"description": "Gets the date and time the statement was posted.",
"format": "date-time",
"nullable": true
},
"statementDate": {
"type": "string",
"description": "Gets or sets the statement date.",
"format": "date-time"
},
"statementNumber": {
"type": "string",
"description": "Gets or sets the number from the statement.",
"nullable": true
},
"statementTotal": {
"type": "number",
"description": "Gets or sets the total commission paid out (amount of the check).",
"format": "decimal"
}
}
}
Carrier CommissionStatement
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique ID for this statement. |
| carrierId | integer(int32) | false | none | Gets or sets the carrier ID associated with this statement. |
| checkNumber | string|null | false | none | Gets or sets the check number for the payment of the commission. |
| depositDate | string(date-time) | false | none | Gets or sets the date on which the commission dollars were deposited. |
| isPosted | boolean | false | none | Gets a value indicating whether this instance is posted. |
| postedById | integer(int32)|null | false | none | Gets the ID of the user who posted the statement. |
| postedDate | string(date-time)|null | false | none | Gets the date and time the statement was posted. |
| statementDate | string(date-time) | false | none | Gets or sets the statement date. |
| statementNumber | string|null | false | none | Gets or sets the number from the statement. |
| statementTotal | number(decimal) | false | none | Gets or sets the total commission paid out (amount of the check). |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "The search criteria to search for commission statement objects",
"additionalProperties": false,
"properties": {
"id": {
"description": "Gets or sets the unique ID for this search criteria.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"carrierId": {
"description": "Gets or sets the carrier ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"checkNumber": {
"description": "Gets or sets the check number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"depositDate": {
"description": "Gets or sets the deposit date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isPosted": {
"description": "Gets or sets a value indicating whether this instance has been posted.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"postedDate": {
"description": "Gets or sets the posted date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"statementDate": {
"description": "Gets or sets the statement date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"statementNumber": {
"description": "Gets or sets the statement number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"statementTotal": {
"description": "Gets or sets the statement total.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | CommissionStatementSearchCriteria|null | false | none | The search criteria to search for commission statement objects |
| searchOptions | SearchOptions2|null | false | none | none |
{
"type": "object",
"description": "The search criteria to search for commission statement objects",
"additionalProperties": false,
"properties": {
"id": {
"description": "Gets or sets the unique ID for this search criteria.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"carrierId": {
"description": "Gets or sets the carrier ID.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"checkNumber": {
"description": "Gets or sets the check number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"depositDate": {
"description": "Gets or sets the deposit date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isPosted": {
"description": "Gets or sets a value indicating whether this instance has been posted.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"postedDate": {
"description": "Gets or sets the posted date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"statementDate": {
"description": "Gets or sets the statement date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"statementNumber": {
"description": "Gets or sets the statement number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"statementTotal": {
"description": "Gets or sets the statement total.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
}
}
}
The search criteria to search for commission statement objects
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | IdListSearchCriteria|null | false | none | Gets or sets the unique ID for this search criteria. |
| carrierId | IdListSearchCriteria|null | false | none | Gets or sets the carrier ID. |
| checkNumber | StringSearchCriteria|null | false | none | Gets or sets the check number. |
| depositDate | DateTimeSearchCriteria|null | false | none | Gets or sets the deposit date. |
| isPosted | BooleanSearchCriteria|null | false | none | Gets or sets a value indicating whether this instance has been posted. |
| postedDate | DateTimeSearchCriteria|null | false | none | Gets or sets the posted date. |
| statementDate | DateTimeSearchCriteria|null | false | none | Gets or sets the statement date. |
| statementNumber | StringSearchCriteria|null | false | none | Gets or sets the statement number. |
| statementTotal | DecimalSearchCriteria|null | false | none | Gets or sets the statement total. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
{
"type": "object",
"description": "Actual Commission Reconciliation",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this actual commission.",
"format": "int32"
},
"commissionAmount": {
"type": "number",
"description": "Gets or sets the actual commission amount received.",
"format": "decimal"
},
"commissionStatementId": {
"type": "integer",
"description": "Gets or sets the ID of the commission statement.",
"format": "int32"
},
"expectedCommissionId": {
"type": "integer",
"description": "Gets or sets the ID of the expected commission.",
"format": "int32"
},
"premiumAmount": {
"type": "number",
"description": "Gets or sets the actual premium amount.",
"format": "decimal"
},
"planId": {
"type": "integer",
"description": "Gets or sets the plan ID for the commission is recorded for.",
"format": "int32"
}
}
}
Actual Commission Reconciliation
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique ID for this actual commission. |
| commissionAmount | number(decimal) | false | none | Gets or sets the actual commission amount received. |
| commissionStatementId | integer(int32) | false | none | Gets or sets the ID of the commission statement. |
| expectedCommissionId | integer(int32) | false | none | Gets or sets the ID of the expected commission. |
| premiumAmount | number(decimal) | false | none | Gets or sets the actual premium amount. |
| planId | integer(int32) | false | none | Gets or sets the plan ID for the commission is recorded for. |
{
"type": "object",
"description": "Single file resource response.",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "Unique file GUID.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "Filename with extension.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Parent folder ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "Account, Carrier, or General.",
"nullable": true
},
"accessLevel": {
"type": "string",
"description": "Team visibility restriction.",
"nullable": true
},
"status": {
"type": "string",
"description": "Active or Archived.",
"nullable": true
},
"contentType": {
"type": "string",
"description": "MIME type string.",
"nullable": true
},
"sizeBytes": {
"type": "integer",
"description": "File size bytes.",
"format": "int64",
"nullable": true
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
Single file resource response.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fileId | string(guid)|null | false | none | Unique file GUID. |
| name | string|null | false | none | Filename with extension. |
| folderId | integer(int32)|null | false | none | Parent folder ID. |
| entityId | integer(int32)|null | false | none | Owner entity ID. |
| entityType | string|null | false | none | Account, Carrier, or General. |
| accessLevel | string|null | false | none | Team visibility restriction. |
| status | string|null | false | none | Active or Archived. |
| contentType | string|null | false | none | MIME type string. |
| sizeBytes | integer(int64)|null | false | none | File size bytes. |
| createdAt | string(date-time)|null | false | none | UTC creation timestamp. |
| updatedAt | string(date-time)|null | false | none | UTC update timestamp. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"value": {
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | OperationBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » value | any | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| path | string|null | false | none | none |
| op | string|null | false | none | none |
| from | string|null | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accessLevel": {
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
},
"attachments": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"isOpen": {
"type": "boolean"
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
],
"enum": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
]
},
"description": {
"type": "string",
"nullable": true
},
"activityInfo": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"baseType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Account",
"Carrier",
"Basic"
],
"enum": [
"None",
"Account",
"Carrier",
"Basic"
]
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"builderFileId": {
"type": "integer",
"format": "int32"
},
"attachedToId": {
"type": "integer",
"format": "int32"
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"fileId": {
"type": "string",
"format": "guid"
},
"fileSize": {
"type": "integer",
"format": "int32"
},
"lastAccessedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"lastAccessedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"removedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"removedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"description": "",
"x-enumNames": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
],
"enum": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
]
},
"updatedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"createdBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"entityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
},
"fileType": {
"type": "string",
"description": "",
"x-enumNames": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
],
"enum": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
]
},
"parentId": {
"type": "integer",
"format": "int32"
},
"isPermanentlyDeletable": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | File | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » extension | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accessLevel": {
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
},
"attachments": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"isOpen": {
"type": "boolean"
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
],
"enum": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
]
},
"description": {
"type": "string",
"nullable": true
},
"activityInfo": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"baseType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Account",
"Carrier",
"Basic"
],
"enum": [
"None",
"Account",
"Carrier",
"Basic"
]
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"builderFileId": {
"type": "integer",
"format": "int32"
},
"attachedToId": {
"type": "integer",
"format": "int32"
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"fileId": {
"type": "string",
"format": "guid"
},
"fileSize": {
"type": "integer",
"format": "int32"
},
"lastAccessedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"lastAccessedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"removedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"removedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"status": {
"type": "string",
"description": "",
"x-enumNames": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
],
"enum": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
]
},
"updatedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"createdBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"entityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
},
"fileType": {
"type": "string",
"description": "",
"x-enumNames": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
],
"enum": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
]
},
"parentId": {
"type": "integer",
"format": "int32"
},
"isPermanentlyDeletable": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accessLevel | FileAccessLevel | false | none | none |
| attachments | [Attachment]|null | false | none | none |
| description | string|null | false | none | none |
| fileId | string(guid) | false | none | none |
| fileSize | integer(int32) | false | none | none |
| lastAccessedBy | User|null | false | none | none |
| lastAccessedDate | string(date-time)|null | false | none | none |
| location | string|null | false | none | none |
| removedBy | User|null | false | none | none |
| removedDate | string(date-time)|null | false | none | none |
| status | FileStatus | false | none | none |
| updatedBy | User|null | false | none | none |
| updatedDate | string(date-time)|null | false | none | none |
| id | integer(int32) | false | none | none |
| name | string|null | false | none | none |
| createdBy | User|null | false | none | none |
| createDate | string(date-time)|null | false | none | none |
| entityId | integer(int32)|null | false | none | none |
| entityType | EntityType | false | none | none |
| fileType | FileType | false | none | none |
| parentId | integer(int32) | false | none | none |
| isPermanentlyDeletable | boolean | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Unrestricted |
| anonymous | BothTeams |
| anonymous | BenefitTeamOnly |
| anonymous | PcTeamOnly |
{
"type": "object",
"additionalProperties": false,
"properties": {
"isOpen": {
"type": "boolean"
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
],
"enum": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
]
},
"description": {
"type": "string",
"nullable": true
},
"activityInfo": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"baseType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Account",
"Carrier",
"Basic"
],
"enum": [
"None",
"Account",
"Carrier",
"Basic"
]
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"builderFileId": {
"type": "integer",
"format": "int32"
},
"attachedToId": {
"type": "integer",
"format": "int32"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isOpen | boolean | false | none | none |
| type | AttachmentType | false | none | none |
| description | string|null | false | none | none |
| activityInfo | ActivityInfo|null | false | none | none |
| builderFileId | integer(int32) | false | none | none |
| attachedToId | integer(int32) | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
],
"enum": [
"RFP",
"RFPCarrier",
"RFPEmail",
"Activity",
"CarrierQuestionnaire",
"ProposalAttachment",
"PlanAttachment"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | RFP |
| anonymous | RFPCarrier |
| anonymous | RFPEmail |
| anonymous | Activity |
| anonymous | CarrierQuestionnaire |
| anonymous | ProposalAttachment |
| anonymous | PlanAttachment |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"baseType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Account",
"Carrier",
"Basic"
],
"enum": [
"None",
"Account",
"Carrier",
"Basic"
]
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| baseType | BaseActivityType | false | none | none |
| dueDate | string(date-time)|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Account",
"Carrier",
"Basic"
],
"enum": [
"None",
"Account",
"Carrier",
"Basic"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Account |
| anonymous | Carrier |
| anonymous | Basic |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| type | string|null | false | none | none |
| firstName | string|null | false | none | none |
| lastName | string|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
],
"enum": [
"Exists",
"Failed",
"Quarantined",
"Uploading"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Exists |
| anonymous | Failed |
| anonymous | Quarantined |
| anonymous | Uploading |
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | General |
| anonymous | Account |
| anonymous | Carrier |
{
"type": "string",
"description": "",
"x-enumNames": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
],
"enum": [
"File",
"Folder",
"ArchiveFile",
"RecycleFile"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | File |
| anonymous | Folder |
| anonymous | ArchiveFile |
| anonymous | RecycleFile |
{
"type": "object",
"additionalProperties": false,
"properties": {
"skip": {
"type": "integer",
"description": "Records to skip; zero means no skip.",
"format": "int32"
},
"top": {
"type": "integer",
"description": "Max records to return; zero means all.",
"format": "int32"
},
"entityType": {
"description": "Required; Account, Carrier, or General enum.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"entityId": {
"type": "integer",
"description": "Required; entity positive integer identifier.",
"format": "int32"
},
"folderId": {
"type": "integer",
"description": "Filter to this folder integer ID; optional.",
"format": "int32",
"nullable": true
},
"search": {
"type": "string",
"description": "Partial filename match; case-insensitive; optional.",
"nullable": true
},
"dateFrom": {
"type": "string",
"description": "Activity date lower bound; ISO 8601 format.",
"format": "date-time",
"nullable": true
},
"dateTo": {
"type": "string",
"description": "Activity date upper bound; ISO 8601 format.",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| skip | integer(int32) | false | none | Records to skip; zero means no skip. |
| top | integer(int32) | false | none | Max records to return; zero means all. |
| entityType | EntityType | false | none | Required; Account, Carrier, or General enum. |
| entityId | integer(int32) | false | none | Required; entity positive integer identifier. |
| folderId | integer(int32)|null | false | none | Filter to this folder integer ID; optional. |
| search | string|null | false | none | Partial filename match; case-insensitive; optional. |
| dateFrom | string(date-time)|null | false | none | Activity date lower bound; ISO 8601 format. |
| dateTo | string(date-time)|null | false | none | Activity date upper bound; ISO 8601 format. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"fileId": {
"type": "string",
"description": "UUID public identifier; use in download URL.",
"format": "guid"
},
"id": {
"type": "integer",
"description": "Internal integer ID; use in legacy operations.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Display filename including extension.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Containing folder ID; null means root level.",
"format": "int32",
"nullable": true
},
"accessLevel": {
"description": "Unrestricted, BenefitTeamOnly, PcTeamOnly, BothTeams.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
}
]
},
"entityId": {
"type": "integer",
"description": "Owning entity integer identifier.",
"format": "int32",
"nullable": true
},
"updatedDate": {
"type": "string",
"description": "UTC last-modified timestamp; null if unchanged.",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fileId | string(guid) | false | none | UUID public identifier; use in download URL. |
| id | integer(int32) | false | none | Internal integer ID; use in legacy operations. |
| name | string|null | false | none | Display filename including extension. |
| folderId | integer(int32)|null | false | none | Containing folder ID; null means root level. |
| accessLevel | FileAccessLevel|null | false | none | Unrestricted, BenefitTeamOnly, PcTeamOnly, BothTeams. |
| entityId | integer(int32)|null | false | none | Owning entity integer identifier. |
| updatedDate | string(date-time)|null | false | none | UTC last-modified timestamp; null if unchanged. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Optional new filename; include extension; non-empty.",
"nullable": true
},
"folderId": {
"type": "integer",
"description": "Optional folder ID; null retains current folder.",
"format": "int32",
"nullable": true
},
"accessLevel": {
"description": "Optional; Unrestricted, BenefitTeamOnly, PcTeamOnly, BothTeams.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
],
"enum": [
"Unrestricted",
"BothTeams",
"BenefitTeamOnly",
"PcTeamOnly"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string|null | false | none | Optional new filename; include extension; non-empty. |
| folderId | integer(int32)|null | false | none | Optional folder ID; null retains current folder. |
| accessLevel | FileAccessLevel|null | false | none | Optional; Unrestricted, BenefitTeamOnly, PcTeamOnly, BothTeams. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"folderIdentifier": {
"type": "string",
"format": "guid",
"nullable": true
},
"childFolders": {
"type": "array",
"nullable": true,
"items": "[Circular]"
},
"defaultFolderId": {
"type": "integer",
"format": "int32"
},
"isRoot": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"createdBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"createDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updatedBy": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
}
}
]
},
"updatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"entityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"entityType": {
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
},
"parentId": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| folderIdentifier | string(guid)|null | false | none | none |
| childFolders | [Folder]|null | false | none | none |
| defaultFolderId | integer(int32) | false | none | none |
| isRoot | boolean | false | none | none |
| id | integer(int32) | false | none | none |
| name | string|null | false | none | none |
| createdBy | User|null | false | none | none |
| createDate | string(date-time)|null | false | none | none |
| updatedBy | User|null | false | none | none |
| updatedDate | string(date-time)|null | false | none | none |
| entityId | integer(int32)|null | false | none | none |
| entityType | EntityType | false | none | none |
| parentId | integer(int32)|null | false | none | none |
{
"type": "object",
"description": "Folder resource response model.",
"additionalProperties": false,
"properties": {
"folderId": {
"type": "integer",
"description": "Folder integer ID.",
"format": "int32"
},
"folderIdentifier": {
"type": "string",
"description": "Folder GUID identifier.",
"format": "guid"
},
"name": {
"type": "string",
"description": "Folder display name.",
"nullable": true
},
"parentFolderId": {
"type": "integer",
"description": "Parent folder integer ID.",
"format": "int32",
"nullable": true
},
"entityId": {
"type": "integer",
"description": "Owner entity ID.",
"format": "int32"
},
"entityType": {
"description": "Account, Carrier, or General.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"status": {
"type": "string",
"description": "Active or Archived."
},
"createdAt": {
"type": "string",
"description": "UTC creation timestamp.",
"format": "date-time",
"nullable": true
},
"updatedAt": {
"type": "string",
"description": "UTC update timestamp.",
"format": "date-time",
"nullable": true
}
}
}
Folder resource response model.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| folderId | integer(int32) | false | none | Folder integer ID. |
| folderIdentifier | string(guid) | false | none | Folder GUID identifier. |
| name | string|null | false | none | Folder display name. |
| parentFolderId | integer(int32)|null | false | none | Parent folder integer ID. |
| entityId | integer(int32) | false | none | Owner entity ID. |
| entityType | EntityType2 | false | none | Account, Carrier, or General. |
| status | string | false | none | Active or Archived. |
| createdAt | string(date-time)|null | false | none | UTC creation timestamp. |
| updatedAt | string(date-time)|null | false | none | UTC update timestamp. |
{
"type": "object",
"description": "Rename folder request.",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "New folder name.",
"maxLength": 255,
"minLength": 1
}
}
}
Rename folder request.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string | true | none | New folder name. |
{
"type": "object",
"description": "New folder creation request.",
"additionalProperties": false,
"required": [
"entityId",
"name"
],
"properties": {
"entityId": {
"type": "integer",
"description": "Owner entity integer ID.",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"entityType": {
"description": "Account or Carrier only.",
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"General",
"Account",
"Carrier"
],
"enum": [
"General",
"Account",
"Carrier"
]
}
]
},
"name": {
"type": "string",
"description": "Unique folder name.",
"minLength": 1
},
"parentFolderId": {
"type": "integer",
"description": "Parent folder integer ID.",
"format": "int32",
"nullable": true
}
}
}
New folder creation request.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entityId | integer(int32) | true | none | Owner entity integer ID. |
| entityType | EntityType2 | false | none | Account or Carrier only. |
| name | string | true | none | Unique folder name. |
| parentFolderId | integer(int32)|null | false | none | Parent folder integer ID. |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
},
{
"type": "object",
"description": "BrokerageBuilder Plan.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the plan's unique id.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PlanInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | BrokerageBuilder Plan. |
| » id | integer(int32) | false | none | Gets or sets the plan's unique id. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | Gets or sets the account id. |
| billingCarrierId | integer(int32) | false | none | Gets or sets the billing carrier id. |
| isPlanAtRisk | boolean | false | none | Gets or sets a value indicating whether the plan is at risk. |
| isDeleted | boolean | false | none | Gets a value indicating whether the plan is deleted. |
| issuingCarrierId | integer(int32) | false | none | Gets or sets the issuing carrier id. |
| billingCarrierCodeId | integer(int32)|null | false | none | Gets or sets the billing carrier code id. |
| issuingCarrierCodeId | integer(int32)|null | false | none | Gets or sets the issuing carrier code id. |
| planCode | string|null | false | none | Gets or sets the plan's code in a third-party system. |
| planTypeId | integer(int32) | false | none | Gets or sets the plan type id. |
| expectedCommission | number(decimal) | false | none | Gets or sets the total expected commission. |
| expectedPremium | number(decimal) | false | none | Gets or sets the expected premium. |
| basePlanTypeId | integer(int32) | false | none | Gets the base plan type id. |
| billingModeId | integer(int32)|null | false | none | Gets or sets the billing mode id. |
| carrierPolicyNumber | string|null | false | none | Gets or sets the number that the carrier has assigned to the plan. |
| commissionProducerId | integer(int32) | false | none | Gets or sets the primary producer for the plan. |
| commissionRate | number(decimal)|null | false | none | Gets or sets the commission percentage rate. |
| commissionScheduleId | integer(int32)|null | false | none | Gets or sets the commission schedule id. |
| commissionType | CommissionTypes | false | none | Gets or sets the type of the plan commission. |
| createdById | integer(int32)|null | false | none | Gets the id of the user who created the plan. |
| currentSubscribers | integer(int32)|null | false | none | Gets or sets the current number of subscribers. |
| customerServiceRepId | integer(int32) | false | none | Gets or sets the plan's CSR. |
| customFields | [CustomFieldValue]|null | false | none | Gets or sets the Custom fields for the plan. |
| departmentId | integer(int32)|null | false | none | Gets or sets the department id. |
| firstWrittenDate | string(date-time) | false | none | Gets or sets the date the sale should be counted. |
| lastUpdatedDate | string(date-time)|null | false | none | Gets the date and time this plan was last updated. |
| lostEffectiveDate | string(date-time)|null | false | none | Gets the effective date this plan was lost. |
| notes | string|null | false | none | Gets or sets the plan notes. |
| planYearStartDate | string(date-time) | false | none | Gets or sets the plan start date. |
| planYearEndDate | string(date-time) | false | none | Gets or sets the plan end date. |
| payModeId | integer(int32) | false | none | Gets or sets the timeline on which commissions are recorded for the plan. |
| planName | string|null | false | none | Gets or sets the plan name. |
| beginningPolicyStatusId | integer(int32) | false | none | Gets or sets the status the plan is starting with. |
| endingPolicyStatusId | integer(int32)|null | false | none | Gets or sets the status the plan is ending with. |
| rateType | RateTypes | false | none | Gets or sets the type of rates the plan has. |
| renewedFromPlanId | integer(int32)|null | false | none | Gets or sets the Id of the plan that this plan was renewed from. |
| syncPlan | boolean | false | none | Gets or sets a value indicating whether this plan is synced with a third-party system. |
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
CommissionTypes
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | CommissionTypes |
| Property | Value |
|---|---|
| anonymous | Annual |
| anonymous | Schedule |
| anonymous | EqualPayments |
| anonymous | Rate |
| anonymous | NoCommission |
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
RateTypes
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | RateTypes |
| Property | Value |
|---|---|
| anonymous | NoRates |
| anonymous | Tiered |
| anonymous | Fixed |
| anonymous | Complex |
| anonymous | Volume |
| anonymous | SelfFunded |
{
"type": "object",
"additionalProperties": false,
"properties": {
"plan": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
}
]
},
"options": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| plan | PlanInfo|null | false | none | none |
| options | CrudOptions|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": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"description": "Gets or sets the account id.",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"description": "Gets or sets the billing carrier id.",
"format": "int32"
},
"isPlanAtRisk": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the plan is at risk."
},
"isDeleted": {
"type": "boolean",
"description": "Gets a value indicating whether the plan is deleted."
},
"issuingCarrierId": {
"type": "integer",
"description": "Gets or sets the issuing carrier id.",
"format": "int32"
},
"billingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the billing carrier code id.",
"format": "int32",
"nullable": true
},
"issuingCarrierCodeId": {
"type": "integer",
"description": "Gets or sets the issuing carrier code id.",
"format": "int32",
"nullable": true
},
"planCode": {
"type": "string",
"description": "Gets or sets the plan's code in a third-party system.",
"nullable": true
},
"planTypeId": {
"type": "integer",
"description": "Gets or sets the plan type id.",
"format": "int32"
},
"expectedCommission": {
"type": "number",
"description": "Gets or sets the total expected commission.",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"description": "Gets or sets the expected premium.",
"format": "decimal"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the base plan type id.",
"format": "int32"
},
"billingModeId": {
"type": "integer",
"description": "Gets or sets the billing mode id.",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"description": "Gets or sets the number that the carrier has assigned to the plan.",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the primary producer for the plan.",
"format": "int32"
},
"commissionRate": {
"type": "number",
"description": "Gets or sets the commission percentage rate.",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"description": "Gets or sets the commission schedule id.",
"format": "int32",
"nullable": true
},
"commissionType": {
"description": "Gets or sets the type of the plan commission.",
"oneOf": [
{
"type": "string",
"description": "CommissionTypes",
"x-enumNames": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"createdById": {
"type": "integer",
"description": "Gets the id of the user who created the plan.",
"format": "int32",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"description": "Gets or sets the current number of subscribers.",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"description": "Gets or sets the plan's CSR.",
"format": "int32"
},
"customFields": {
"type": "array",
"description": "Gets or sets the Custom fields for the plan.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"brokerId": {
"type": "integer",
"format": "int32"
},
"customFieldId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"itemId": {
"type": "integer",
"format": "int32"
},
"value": {
"type": "string",
"nullable": true
}
}
}
},
"departmentId": {
"type": "integer",
"description": "Gets or sets the department id.",
"format": "int32",
"nullable": true
},
"firstWrittenDate": {
"type": "string",
"description": "Gets or sets the date the sale should be counted.",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"description": "Gets the date and time this plan was last updated.",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"description": "Gets the effective date this plan was lost.",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "Gets or sets the plan notes.",
"nullable": true
},
"planYearStartDate": {
"type": "string",
"description": "Gets or sets the plan start date.",
"format": "date-time"
},
"planYearEndDate": {
"type": "string",
"description": "Gets or sets the plan end date.",
"format": "date-time"
},
"payModeId": {
"type": "integer",
"description": "Gets or sets the timeline on which commissions are recorded for the plan.",
"format": "int32"
},
"planName": {
"type": "string",
"description": "Gets or sets the plan name.",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is starting with.",
"format": "int32"
},
"endingPolicyStatusId": {
"type": "integer",
"description": "Gets or sets the status the plan is ending with.",
"format": "int32",
"nullable": true
},
"rateType": {
"description": "Gets or sets the type of rates the plan has.",
"oneOf": [
{
"type": "string",
"description": "RateTypes",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"renewedFromPlanId": {
"type": "integer",
"description": "Gets or sets the Id of the plan that this plan was renewed from.",
"format": "int32",
"nullable": true
},
"syncPlan": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this plan is synced with a third-party system."
}
}
},
{
"type": "object",
"description": "BrokerageBuilder Plan.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the plan's unique id.",
"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 | [Plan] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchCriteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Search criteria used to search for plans.",
"additionalProperties": false,
"properties": {
"accountId": {
"description": "Gets or sets the account id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planCode": {
"description": "Gets or sets the ams plan code.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"basePlanTypeId": {
"description": "Gets or sets the type of the base plan id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"beginningPolicyStatusId": {
"description": "Gets or sets the beginning policy status id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"billingCarrierId": {
"description": "Gets or sets the billing carrier id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"billingCarrierCodeId": {
"description": "Gets or sets the billing carrier code id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"billingModeId": {
"description": "Gets or sets the billing mode id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"carrierPolicyNumber": {
"description": "Gets or sets the carrier policy number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"commissionProducerId": {
"description": "Gets or sets the commission producer id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"commissionRate": {
"description": "Gets or sets the commission rate.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"commissionScheduleId": {
"description": "Gets or sets the commission schedule id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"commissionType": {
"description": "Gets or sets the type of the commission.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"currentSubscribers": {
"description": "Gets or sets the current subscribers.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customerServiceRepId": {
"description": "Gets or sets the customer service rep id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for plan by custom field.\nMaximum of 5 custom field searches allowed.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true
}
}
}
},
"departmentId": {
"description": "Gets or sets the department id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"endingPolicyStatusId": {
"description": "Gets or sets the ending policy status id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"expectedCommission": {
"description": "Gets or sets the expected commission.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"expectedPremium": {
"description": "Gets or sets the expected premium.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"id": {
"description": "Gets or sets the id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"issuingCarrierId": {
"description": "Gets or sets the issuing carrier id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"issuingCarrierCodeId": {
"description": "Gets or sets the issuing carrier code id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"payModeId": {
"description": "Gets or sets the pay mode id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planTypeId": {
"description": "Gets or sets the plan type id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planName": {
"description": "Gets or sets the name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"firstWrittenDate": {
"description": "Gets or sets the first written date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedDate": {
"description": "Gets or sets the last updated date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lostEffectiveDate": {
"description": "Gets or sets the lost effective date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"planYearStartDate": {
"description": "Gets or sets the start date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"planYearEndDate": {
"description": "Gets or sets the end date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"rateType": {
"description": "Gets or sets the type of the rate.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isPlanAtRisk": {
"description": "Gets or sets the is plan at risk.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"syncPlan": {
"description": "Gets or sets the is plan synced.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
}
}
}
]
},
"searchOptions": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| searchCriteria | PlanSearchCriteria|null | false | none | Search criteria used to search for plans. |
| searchOptions | SearchOptions2|null | false | none | none |
{
"type": "object",
"description": "Search criteria used to search for plans.",
"additionalProperties": false,
"properties": {
"accountId": {
"description": "Gets or sets the account id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planCode": {
"description": "Gets or sets the ams plan code.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"basePlanTypeId": {
"description": "Gets or sets the type of the base plan id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"beginningPolicyStatusId": {
"description": "Gets or sets the beginning policy status id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"billingCarrierId": {
"description": "Gets or sets the billing carrier id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"billingCarrierCodeId": {
"description": "Gets or sets the billing carrier code id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"billingModeId": {
"description": "Gets or sets the billing mode id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"carrierPolicyNumber": {
"description": "Gets or sets the carrier policy number.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"commissionProducerId": {
"description": "Gets or sets the commission producer id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"commissionRate": {
"description": "Gets or sets the commission rate.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"commissionScheduleId": {
"description": "Gets or sets the commission schedule id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"commissionType": {
"description": "Gets or sets the type of the commission.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"currentSubscribers": {
"description": "Gets or sets the current subscribers.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customerServiceRepId": {
"description": "Gets or sets the customer service rep id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"customFields": {
"type": "array",
"description": "Gets or sets the criteria used to search for plan by custom field.\nMaximum of 5 custom field searches allowed.",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true
}
}
}
},
"departmentId": {
"description": "Gets or sets the department id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"endingPolicyStatusId": {
"description": "Gets or sets the ending policy status id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"expectedCommission": {
"description": "Gets or sets the expected commission.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"expectedPremium": {
"description": "Gets or sets the expected premium.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"id": {
"description": "Gets or sets the id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"issuingCarrierId": {
"description": "Gets or sets the issuing carrier id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"issuingCarrierCodeId": {
"description": "Gets or sets the issuing carrier code id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"payModeId": {
"description": "Gets or sets the pay mode id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planTypeId": {
"description": "Gets or sets the plan type id.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "integer",
"format": "int32"
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"inclusiveNulls": {
"type": "boolean"
}
}
}
]
}
]
},
"planName": {
"description": "Gets or sets the name.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"StartsWith",
"EndsWith"
]
},
"value": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"firstWrittenDate": {
"description": "Gets or sets the first written date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lastUpdatedDate": {
"description": "Gets or sets the last updated date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"lostEffectiveDate": {
"description": "Gets or sets the lost effective date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"planYearStartDate": {
"description": "Gets or sets the start date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"planYearEndDate": {
"description": "Gets or sets the end date.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"rateType": {
"description": "Gets or sets the type of the rate.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
]
},
"isPlanAtRisk": {
"description": "Gets or sets the is plan at risk.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
},
"syncPlan": {
"description": "Gets or sets the is plan synced.",
"nullable": true,
"oneOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean"
}
}
}
]
}
]
}
}
}
Search criteria used to search for plans.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | IdListSearchCriteria|null | false | none | Gets or sets the account id. |
| planCode | StringSearchCriteria|null | false | none | Gets or sets the ams plan code. |
| basePlanTypeId | IdListSearchCriteria|null | false | none | Gets or sets the type of the base plan id. |
| beginningPolicyStatusId | IdListSearchCriteria|null | false | none | Gets or sets the beginning policy status id. |
| billingCarrierId | IntSearchCriteria|null | false | none | Gets or sets the billing carrier id. |
| billingCarrierCodeId | IntSearchCriteria|null | false | none | Gets or sets the billing carrier code id. |
| billingModeId | IdListSearchCriteria|null | false | none | Gets or sets the billing mode id. |
| carrierPolicyNumber | StringSearchCriteria|null | false | none | Gets or sets the carrier policy number. |
| commissionProducerId | IntSearchCriteria|null | false | none | Gets or sets the commission producer id. |
| commissionRate | DecimalSearchCriteria|null | false | none | Gets or sets the commission rate. |
| commissionScheduleId | IdListSearchCriteria|null | false | none | Gets or sets the commission schedule id. |
| commissionType | NullableEnumSearchCriteriaOfCommissionType|null | false | none | Gets or sets the type of the commission. |
| currentSubscribers | IntSearchCriteria|null | false | none | Gets or sets the current subscribers. |
| customerServiceRepId | IntSearchCriteria|null | false | none | Gets or sets the customer service rep id. |
| customFields | [CustomFieldSearchValue2]|null | false | none | Gets or sets the criteria used to search for plan by custom field. Maximum of 5 custom field searches allowed. |
| departmentId | IdListSearchCriteria|null | false | none | Gets or sets the department id. |
| endingPolicyStatusId | IdListSearchCriteria|null | false | none | Gets or sets the ending policy status id. |
| expectedCommission | DecimalSearchCriteria|null | false | none | Gets or sets the expected commission. |
| expectedPremium | DecimalSearchCriteria|null | false | none | Gets or sets the expected premium. |
| id | IdListSearchCriteria|null | false | none | Gets or sets the id. |
| issuingCarrierId | IntSearchCriteria|null | false | none | Gets or sets the issuing carrier id. |
| issuingCarrierCodeId | IntSearchCriteria|null | false | none | Gets or sets the issuing carrier code id. |
| payModeId | IdListSearchCriteria|null | false | none | Gets or sets the pay mode id. |
| planTypeId | IdListSearchCriteria|null | false | none | Gets or sets the plan type id. |
| planName | StringSearchCriteria|null | false | none | Gets or sets the name. |
| firstWrittenDate | DateTimeSearchCriteria|null | false | none | Gets or sets the first written date. |
| lastUpdatedDate | DateTimeSearchCriteria|null | false | none | Gets or sets the last updated date. |
| lostEffectiveDate | DateTimeSearchCriteria|null | false | none | Gets or sets the lost effective date. |
| planYearStartDate | DateTimeSearchCriteria|null | false | none | Gets or sets the start date. |
| planYearEndDate | DateTimeSearchCriteria|null | false | none | Gets or sets the end date. |
| rateType | NullableEnumSearchCriteriaOfRateType|null | false | none | Gets or sets the type of the rate. |
| isPlanAtRisk | BooleanSearchCriteria|null | false | none | Gets or sets the is plan at risk. |
| syncPlan | BooleanSearchCriteria|null | false | none | Gets or sets the is plan synced. |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | EnumSearchCriteriaOfCommissionType | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | CommissionType | false | none | none |
| » valueList | [CommissionType]|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Annual |
| anonymous | Schedule |
| anonymous | EqualPayments |
| anonymous | Rate |
| anonymous | NoCommission |
{
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| customFieldId | integer(int32) | false | none | none |
| searchCriteria | any | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | New |
| anonymous | Retain |
| anonymous | QuotedOnly |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | RetainedSameCarrier |
| anonymous | Lost |
| anonymous | RetainedDifferentCarrier |
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | EmployeeBenefits |
| anonymous | PropertyCasualty |
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | NoRates |
| anonymous | Tiered |
| anonymous | Fixed |
| anonymous | Complex |
| anonymous | Volume |
| anonymous | SelfFunded |
{
"type": "string",
"description": "",
"x-enumNames": [
"BeginningPolicyStatus",
"Department",
"EndingPolicyStatus",
"BillingMode",
"PayMode"
],
"enum": [
"BeginningPolicyStatus",
"Department",
"EndingPolicyStatus",
"BillingMode",
"PayMode"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | BeginningPolicyStatus |
| anonymous | Department |
| anonymous | EndingPolicyStatus |
| anonymous | BillingMode |
| anonymous | PayMode |
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"beginningSalesTrackingStatus": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
}
}
}
]
},
"description": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"endingSalesTrackingStatus": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
}
}
}
]
},
"id": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amsCode | StringCriterion|null | false | none | none |
| beginningSalesTrackingStatus | ValueCriterionOfBeginningSalesTrackingStatus|null | false | none | none |
| description | StringCriterion|null | false | none | none |
| endingSalesTrackingStatus | ValueCriterionOfEndingSalesTrackingStatuses|null | false | none | none |
| id | ValueCriterionOfInteger|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | StringOperation | false | none | none |
| value | string|null | false | none | none |
| values | [string]|null | false | none | none |
| nullReplacementValue | string|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | Contains |
| anonymous | IsNullOrEmpty |
| anonymous | IsNullOrWhitespace |
| anonymous | StartsWith |
| anonymous | EndsWith |
| anonymous | In |
| anonymous | NotIn |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | BeginningSalesTrackingStatus|null | false | none | none |
| values | [oneOf]|null | false | none | none |
| rangeEndValue | BeginningSalesTrackingStatus|null | false | none | none |
| rangeStartValue | BeginningSalesTrackingStatus|null | false | none | none |
| nullReplacementValue | BeginningSalesTrackingStatus|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | GreaterThan |
| anonymous | GreaterThanEquals |
| anonymous | LessThan |
| anonymous | LessThanEquals |
| anonymous | Between |
| anonymous | NotBetween |
| anonymous | In |
| anonymous | NotIn |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | EndingSalesTrackingStatuses|null | false | none | none |
| values | [oneOf]|null | false | none | none |
| rangeEndValue | EndingSalesTrackingStatuses|null | false | none | none |
| rangeStartValue | EndingSalesTrackingStatuses|null | false | none | none |
| nullReplacementValue | EndingSalesTrackingStatuses|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer(int32)|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer(int32)|null | false | none | none |
| rangeStartValue | integer(int32)|null | false | none | none |
| nullReplacementValue | integer(int32)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"beginningSalesTrackingStatus": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"description": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"endingSalesTrackingStatus": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"id": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amsCode | Sort|null | false | none | none |
| beginningSalesTrackingStatus | Sort|null | false | none | none |
| description | Sort|null | false | none | none |
| endingSalesTrackingStatus | Sort|null | false | none | none |
| id | Sort|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| direction | SortDirection | false | none | none |
| priority | integer(int32) | false | none | none |
| nullLast | boolean|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Ascending |
| anonymous | Descending |
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"type": "string",
"nullable": true
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| amsCode | string|null | false | none | none |
| brokerId | integer(int32) | false | none | none |
| description | string|null | false | none | none |
| id | integer(int32) | false | none | none |
| isDeleted | boolean | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"type": "string",
"nullable": true
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup2 | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"type": "string",
"nullable": true
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"salesTrackingStatus": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup2 | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » salesTrackingStatus | EndingSalesTrackingStatuses | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"type": "string",
"nullable": true
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"salesTrackingStatus": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup2 | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » salesTrackingStatus | BeginningSalesTrackingStatus | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"type": "string",
"nullable": true
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup2 | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"amsCode": {
"type": "string",
"nullable": true
},
"brokerId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"isDeleted": {
"type": "boolean"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"paymentsPerYear": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup2 | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » paymentsPerYear | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"intervalType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Months",
"Days"
],
"enum": [
"None",
"Months",
"Days"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string|null | false | none | none |
| id | integer(int32) | false | none | none |
| intervalType | NewHireWaitingPeriodIntervalType | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Months",
"Days"
],
"enum": [
"None",
"Months",
"Days"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Months |
| anonymous | Days |
{
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"newHireWaitingPeriodId": {
"type": "integer",
"format": "int32"
},
"planId": {
"type": "integer",
"format": "int32"
},
"waitingPeriodInterval": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string|null | false | none | none |
| id | integer(int32) | false | none | none |
| newHireWaitingPeriodId | integer(int32) | false | none | none |
| planId | integer(int32) | false | none | none |
| waitingPeriodInterval | integer(int32)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"accountLocationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"amsPlanCode": {
"type": "string",
"nullable": true
},
"beginningPolicyStatusId": {
"type": "integer",
"format": "int32"
},
"billingCarrierId": {
"type": "integer",
"format": "int32"
},
"billingCarrierLinkId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"billingModeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"carrierPolicyNumber": {
"type": "string",
"nullable": true
},
"commissionProducerId": {
"type": "integer",
"format": "int32"
},
"commissionRate": {
"type": "number",
"format": "decimal",
"nullable": true
},
"commissionScheduleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"commissionType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
},
"createdById": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdByType": {
"type": "string",
"nullable": true
},
"currentSubscribers": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customerServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"departmentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time"
},
"endingPolicyStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"expectedCommission": {
"type": "number",
"format": "decimal"
},
"expectedPremium": {
"type": "number",
"format": "decimal"
},
"firstWrittenDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "integer",
"format": "int32"
},
"isComplete": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"isPlanAtRisk": {
"type": "boolean"
},
"isPlanInPortal": {
"type": "boolean"
},
"isPlanSynced": {
"type": "boolean"
},
"issuingCarrierId": {
"type": "integer",
"format": "int32"
},
"issuingCarrierLinkId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lostEffectiveDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"payModeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"planTypeId": {
"type": "integer",
"format": "int32"
},
"proposalId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rateType": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
},
"releaseToMyWave": {
"type": "boolean"
},
"renewedFromPlanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | none |
| accountLocationId | integer(int32)|null | false | none | none |
| amsPlanCode | string|null | false | none | none |
| beginningPolicyStatusId | integer(int32) | false | none | none |
| billingCarrierId | integer(int32) | false | none | none |
| billingCarrierLinkId | integer(int32)|null | false | none | none |
| billingModeId | integer(int32)|null | false | none | none |
| carrierPolicyNumber | string|null | false | none | none |
| commissionProducerId | integer(int32) | false | none | none |
| commissionRate | number(decimal)|null | false | none | none |
| commissionScheduleId | integer(int32)|null | false | none | none |
| commissionType | CommissionType | false | none | none |
| createdById | integer(int32)|null | false | none | none |
| createdByType | string|null | false | none | none |
| currentSubscribers | integer(int32)|null | false | none | none |
| customerServiceRepId | integer(int32)|null | false | none | none |
| departmentId | integer(int32)|null | false | none | none |
| endDate | string(date-time) | false | none | none |
| endingPolicyStatusId | integer(int32)|null | false | none | none |
| expectedCommission | number(decimal) | false | none | none |
| expectedPremium | number(decimal) | false | none | none |
| firstWrittenDate | string(date-time) | false | none | none |
| id | integer(int32) | false | none | none |
| isComplete | boolean | false | none | none |
| isDeleted | boolean | false | none | none |
| isPlanAtRisk | boolean | false | none | none |
| isPlanInPortal | boolean | false | none | none |
| isPlanSynced | boolean | false | none | none |
| issuingCarrierId | integer(int32) | false | none | none |
| issuingCarrierLinkId | integer(int32)|null | false | none | none |
| lastUpdatedDate | string(date-time)|null | false | none | none |
| lostEffectiveDate | string(date-time)|null | false | none | none |
| name | string|null | false | none | none |
| payModeId | integer(int32)|null | false | none | none |
| planTypeId | integer(int32) | false | none | none |
| proposalId | integer(int32)|null | false | none | none |
| rateType | RateType | false | none | none |
| releaseToMyWave | boolean | false | none | none |
| renewedFromPlanId | integer(int32)|null | false | none | none |
| startDate | string(date-time) | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"RecordedCommissions",
"OnOpenRFP",
"OnClosedRFP"
],
"enum": [
"RecordedCommissions",
"OnOpenRFP",
"OnClosedRFP"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | RecordedCommissions |
| anonymous | OnOpenRFP |
| anonymous | OnClosedRFP |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"amsPlanCode": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"basePlanTypeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"beginningPolicyStatusId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"billingCarrierId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"billingCarrierLinkId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"billingModeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"carrierPolicyNumber": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"commissionProducerId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"commissionRate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "number",
"format": "decimal",
"nullable": true
}
},
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"nullReplacementValue": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
"commissionScheduleId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"commissionType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
}
}
}
]
},
"currentSubscribers": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"customFields": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"customFieldId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true
}
}
}
},
"customerServiceRepId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"departmentId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"endDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"endingPolicyStatusId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"expectedCommission": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "number",
"format": "decimal",
"nullable": true
}
},
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"nullReplacementValue": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
"expectedPremium": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "number",
"format": "decimal",
"nullable": true
}
},
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"nullReplacementValue": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
]
},
"firstWrittenDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"id": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"isPlanAtRisk": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean",
"nullable": true
},
"nullReplacementValue": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"isPlanInPortal": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean",
"nullable": true
},
"nullReplacementValue": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"isPlanSynced": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean",
"nullable": true
},
"nullReplacementValue": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"issuingCarrierId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"issuingCarrierLinkId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"lastUpdatedDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"lostEffectiveDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"name": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"payModeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"planTypeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"productType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
}
}
}
]
},
"rateType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
}
}
}
]
},
"startDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | ValueCriterionOfInteger|null | false | none | none |
| amsPlanCode | StringCriterion|null | false | none | none |
| basePlanTypeId | ValueCriterionOfInteger|null | false | none | none |
| beginningPolicyStatusId | ValueCriterionOfInteger|null | false | none | none |
| billingCarrierId | ValueCriterionOfInteger|null | false | none | none |
| billingCarrierLinkId | ValueCriterionOfInteger|null | false | none | none |
| billingModeId | ValueCriterionOfInteger|null | false | none | none |
| carrierPolicyNumber | StringCriterion|null | false | none | none |
| commissionProducerId | ValueCriterionOfInteger|null | false | none | none |
| commissionRate | ValueCriterionOfDecimal|null | false | none | none |
| commissionScheduleId | ValueCriterionOfInteger|null | false | none | none |
| commissionType | ValueCriterionOfCommissionType|null | false | none | none |
| currentSubscribers | ValueCriterionOfInteger|null | false | none | none |
| customFields | [CustomFieldSearchValue2]|null | false | none | none |
| customerServiceRepId | ValueCriterionOfInteger|null | false | none | none |
| departmentId | ValueCriterionOfInteger|null | false | none | none |
| endDate | ValueCriterionOfDateTime|null | false | none | none |
| endingPolicyStatusId | ValueCriterionOfInteger|null | false | none | none |
| expectedCommission | ValueCriterionOfDecimal|null | false | none | none |
| expectedPremium | ValueCriterionOfDecimal|null | false | none | none |
| firstWrittenDate | ValueCriterionOfDateTime|null | false | none | none |
| id | ValueCriterionOfInteger|null | false | none | none |
| isPlanAtRisk | BooleanCriterion|null | false | none | none |
| isPlanInPortal | BooleanCriterion|null | false | none | none |
| isPlanSynced | BooleanCriterion|null | false | none | none |
| issuingCarrierId | ValueCriterionOfInteger|null | false | none | none |
| issuingCarrierLinkId | ValueCriterionOfInteger|null | false | none | none |
| lastUpdatedDate | ValueCriterionOfDateTime|null | false | none | none |
| lostEffectiveDate | ValueCriterionOfDateTime|null | false | none | none |
| name | StringCriterion|null | false | none | none |
| payModeId | ValueCriterionOfInteger|null | false | none | none |
| planTypeId | ValueCriterionOfInteger|null | false | none | none |
| productType | ValueCriterionOfProductTypes|null | false | none | none |
| rateType | ValueCriterionOfRateType|null | false | none | none |
| startDate | ValueCriterionOfDateTime|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "number",
"format": "decimal",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "number",
"format": "decimal",
"nullable": true
}
},
"rangeEndValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "decimal",
"nullable": true
},
"nullReplacementValue": {
"type": "number",
"format": "decimal",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | number(decimal)|null | false | none | none |
| values | [number]|null | false | none | none |
| rangeEndValue | number(decimal)|null | false | none | none |
| rangeStartValue | number(decimal)|null | false | none | none |
| nullReplacementValue | number(decimal)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
],
"enum": [
"None",
"Annual",
"Schedule",
"EqualPayments",
"Rate",
"NoCommission"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | CommissionType|null | false | none | none |
| values | [oneOf]|null | false | none | none |
| rangeEndValue | CommissionType|null | false | none | none |
| rangeStartValue | CommissionType|null | false | none | none |
| nullReplacementValue | CommissionType|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | string(date-time)|null | false | none | none |
| values | [string]|null | false | none | none |
| rangeEndValue | string(date-time)|null | false | none | none |
| rangeStartValue | string(date-time)|null | false | none | none |
| nullReplacementValue | string(date-time)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
},
"value": {
"type": "boolean",
"nullable": true
},
"nullReplacementValue": {
"type": "boolean",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | BooleanOperation | false | none | none |
| value | boolean|null | false | none | none |
| nullReplacementValue | boolean|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"EmployeeBenefits",
"PropertyCasualty"
],
"enum": [
"EmployeeBenefits",
"PropertyCasualty"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | ProductTypes|null | false | none | none |
| values | [oneOf]|null | false | none | none |
| rangeEndValue | ProductTypes|null | false | none | none |
| rangeStartValue | ProductTypes|null | false | none | none |
| nullReplacementValue | ProductTypes|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
}
},
"rangeEndValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"rangeStartValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
},
"nullReplacementValue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | RateType|null | false | none | none |
| values | [oneOf]|null | false | none | none |
| rangeEndValue | RateType|null | false | none | none |
| rangeStartValue | RateType|null | false | none | none |
| nullReplacementValue | RateType|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"amsPlanCode": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"basePlanTypeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"beginningPolicyStatusId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"billingCarrierId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"billingCarrierLinkId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"billingModeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"carrierPolicyNumber": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"commissionProducerId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"commissionRate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"commissionScheduleId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"commissionType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"currentSubscribers": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"customFields": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"customerServiceRepId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"departmentId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"endDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"endingPolicyStatusId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"expectedCommission": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"expectedPremium": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"firstWrittenDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"id": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"isPlanAtRisk": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"isPlanInPortal": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"isPlanSynced": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"issuingCarrierId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"issuingCarrierLinkId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"lastUpdatedDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"lostEffectiveDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"name": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"payModeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"planTypeId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"productType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"rateType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"startDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | Sort|null | false | none | none |
| amsPlanCode | Sort|null | false | none | none |
| basePlanTypeId | Sort|null | false | none | none |
| beginningPolicyStatusId | Sort|null | false | none | none |
| billingCarrierId | Sort|null | false | none | none |
| billingCarrierLinkId | Sort|null | false | none | none |
| billingModeId | Sort|null | false | none | none |
| carrierPolicyNumber | Sort|null | false | none | none |
| commissionProducerId | Sort|null | false | none | none |
| commissionRate | Sort|null | false | none | none |
| commissionScheduleId | Sort|null | false | none | none |
| commissionType | Sort|null | false | none | none |
| currentSubscribers | Sort|null | false | none | none |
| customFields | Sort|null | false | none | none |
| customerServiceRepId | Sort|null | false | none | none |
| departmentId | Sort|null | false | none | none |
| endDate | Sort|null | false | none | none |
| endingPolicyStatusId | Sort|null | false | none | none |
| expectedCommission | Sort|null | false | none | none |
| expectedPremium | Sort|null | false | none | none |
| firstWrittenDate | Sort|null | false | none | none |
| id | Sort|null | false | none | none |
| isPlanAtRisk | Sort|null | false | none | none |
| isPlanInPortal | Sort|null | false | none | none |
| isPlanSynced | Sort|null | false | none | none |
| issuingCarrierId | Sort|null | false | none | none |
| issuingCarrierLinkId | Sort|null | false | none | none |
| lastUpdatedDate | Sort|null | false | none | none |
| lostEffectiveDate | Sort|null | false | none | none |
| name | Sort|null | false | none | none |
| payModeId | Sort|null | false | none | none |
| planTypeId | Sort|null | false | none | none |
| productType | Sort|null | false | none | none |
| rateType | Sort|null | false | none | none |
| startDate | Sort|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"includeCustomFields": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| includeCustomFields | boolean | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"carrierName": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"clientName": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"planName": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"planType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"rateType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"startDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| carrierName | StringCriterion|null | false | none | none |
| clientName | StringCriterion|null | false | none | none |
| planName | StringCriterion|null | false | none | none |
| planType | StringCriterion|null | false | none | none |
| rateType | StringCriterion|null | false | none | none |
| startDate | ValueCriterionOfDateTime|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"carrierName": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"clientName": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"planName": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"planType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"rateType": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"startDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| carrierName | Sort|null | false | none | none |
| clientName | Sort|null | false | none | none |
| planName | Sort|null | false | none | none |
| planType | Sort|null | false | none | none |
| rateType | Sort|null | false | none | none |
| startDate | Sort|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"carrierName": {
"type": "string",
"nullable": true
},
"clientName": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
},
"id": {
"type": "integer",
"format": "int32"
},
"planName": {
"type": "string",
"nullable": true
},
"planType": {
"type": "string",
"nullable": true
},
"rateType": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| carrierName | string|null | false | none | none |
| clientName | string|null | false | none | none |
| contactName | string|null | false | none | none |
| id | integer(int32) | false | none | none |
| planName | string|null | false | none | none |
| planType | string|null | false | none | none |
| rateType | string|null | false | none | none |
| startDate | string(date-time) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
},
"amsPlanCode": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"IsNullOrEmpty",
"IsNullOrWhitespace",
"StartsWith",
"EndsWith",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
}
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
]
},
"deletedDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "string",
"format": "date-time",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"id": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"GreaterThan",
"GreaterThanEquals",
"LessThan",
"LessThanEquals",
"Between",
"NotBetween",
"In",
"NotIn"
]
},
"value": {
"type": "integer",
"format": "int32",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | ValueCriterionOfInteger|null | false | none | none |
| amsPlanCode | StringCriterion|null | false | none | none |
| deletedDate | ValueCriterionOfDateTime|null | false | none | none |
| id | ValueCriterionOfInteger|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"amsPlanCode": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"deletedDate": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
},
"id": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"direction": {
"type": "string",
"description": "",
"x-enumNames": [
"Ascending",
"Descending"
],
"enum": [
"Ascending",
"Descending"
]
},
"priority": {
"type": "integer",
"format": "int32"
},
"nullLast": {
"type": "boolean",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | Sort|null | false | none | none |
| amsPlanCode | Sort|null | false | none | none |
| deletedDate | Sort|null | false | none | none |
| id | Sort|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountBrokerIsSyncing": {
"type": "boolean"
},
"beginningPolicyStatusId": {
"type": "integer",
"format": "int32"
},
"copyCommissions": {
"type": "boolean"
},
"endingPolicyStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"format": "int32"
},
"releasePlanToPortal": {
"type": "boolean"
},
"renewPlanId": {
"type": "integer",
"format": "int32",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountBrokerIsSyncing | boolean | false | none | none |
| beginningPolicyStatusId | integer(int32) | false | none | none |
| copyCommissions | boolean | false | none | none |
| endingPolicyStatusId | integer(int32)|null | false | none | none |
| planId | integer(int32) | false | none | none |
| releasePlanToPortal | boolean | false | none | none |
| renewPlanId | integer(int32)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"carrierName": {
"type": "string",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"planTypeId": {
"type": "integer",
"format": "int32"
},
"planTypeName": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | none |
| carrierName | string|null | false | none | none |
| endDate | string(date-time) | false | none | none |
| id | integer(int32) | false | none | none |
| name | string|null | false | none | none |
| planTypeId | integer(int32) | false | none | none |
| planTypeName | string|null | false | none | none |
| startDate | string(date-time) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"deleteRestrictionType": {
"type": "string",
"description": "",
"x-enumNames": [
"HasPostedCommissionStatement",
"AttachedToRFP"
],
"enum": [
"HasPostedCommissionStatement",
"AttachedToRFP"
]
},
"message": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deleteRestrictionType | DeleteRestrictionType | false | none | none |
| message | string|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"HasPostedCommissionStatement",
"AttachedToRFP"
],
"enum": [
"HasPostedCommissionStatement",
"AttachedToRFP"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | HasPostedCommissionStatement |
| anonymous | AttachedToRFP |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorTokens": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"argumentName": {
"type": "string",
"nullable": true
},
"details": {
"type": "string",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FaultCodeBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » argumentName | string|null | false | none | none |
| » details | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorTokens": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| errorCode | integer(int32) | false | none | none |
| errorTokens | [ErrorToken]|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string|null | false | none | none |
| value | string|null | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorTokens": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"errors": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorTokens": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorType": {
"type": "string",
"description": "",
"x-enumNames": [
"Error",
"Warning"
],
"enum": [
"Error",
"Warning"
]
},
"field": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"objectName": {
"type": "string",
"nullable": true
}
}
}
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FaultCodeBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » errors | [ValidationError]|null | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorTokens": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"errorType": {
"type": "string",
"description": "",
"x-enumNames": [
"Error",
"Warning"
],
"enum": [
"Error",
"Warning"
]
},
"field": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"objectName": {
"type": "string",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | FaultCodeBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » errorType | ValidationErrorType | false | none | none |
| » field | string|null | false | none | none |
| » message | string|null | false | none | none |
| » objectName | string|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Error",
"Warning"
],
"enum": [
"Error",
"Warning"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Error |
| anonymous | Warning |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | EnumSearchCriteriaOfRateType | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"type": "object",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"sort": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Ascending",
"Descending"
],
"enum": [
"None",
"Ascending",
"Descending"
]
},
"sortOrder": {
"type": "integer",
"format": "int32"
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"searchType": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains"
]
},
"value": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
},
"valueList": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
],
"enum": [
"NoRates",
"Tiered",
"Fixed",
"Complex",
"Volume",
"SelfFunded"
]
}
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchCriteriaBase | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » searchType | EnumSearchType | false | none | none |
| » value | RateType | false | none | none |
| » valueList | [RateType]|null | false | none | none |
{
"type": "object",
"description": "Base plan type.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the name."
}
}
}
Base plan type.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets the unique id. |
| name | string | false | none | Gets the name. |
{
"type": "object",
"description": "BrokerageBuilder Plan Type.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets the unique id.",
"format": "int32"
},
"basePlanTypeId": {
"type": "integer",
"description": "Gets the type of the base plan id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the name."
},
"amsCode": {
"type": "string",
"description": "Gets the plan type's code in a third-party system."
},
"showOutOfNetwork": {
"type": "boolean",
"description": "Gets a value indicating whether Out of Network benefit items are displayed."
},
"hrConnectionPlanTypeId": {
"type": "integer",
"description": "Gets the mapped HrConnection plan type id.",
"format": "int32"
},
"portalBenefitsTitle": {
"type": "string",
"description": "Gets the plantype's title that displays in Portal Benefits."
}
}
}
BrokerageBuilder Plan Type.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets the unique id. |
| basePlanTypeId | integer(int32) | false | none | Gets the type of the base plan id. |
| name | string | false | none | Gets the name. |
| amsCode | string | false | none | Gets the plan type's code in a third-party system. |
| showOutOfNetwork | boolean | false | none | Gets a value indicating whether Out of Network benefit items are displayed. |
| hrConnectionPlanTypeId | integer(int32) | false | none | Gets the mapped HrConnection plan type id. |
| portalBenefitsTitle | string | false | none | Gets the plantype's title that displays in Portal Benefits. |
{
"type": "object",
"description": "Plan Commission Split",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this commission split.",
"format": "int32"
},
"effectiveDate": {
"type": "string",
"description": "Gets or sets the effective date for this commission split.",
"format": "date-time"
},
"percentage": {
"type": "number",
"description": "Gets or sets the commission percentage for the producer.",
"format": "decimal"
},
"commissionProducerId": {
"type": "integer",
"description": "Gets or sets the commission producer.",
"format": "int32"
},
"compensationTypeId": {
"type": "integer",
"description": "Gets or sets the producer compensation type.",
"format": "int32",
"nullable": true
},
"planId": {
"type": "integer",
"description": "Gets or sets the plan the commission split is for.",
"format": "int32"
}
}
}
Plan Commission Split
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique ID for this commission split. |
| effectiveDate | string(date-time) | false | none | Gets or sets the effective date for this commission split. |
| percentage | number(decimal) | false | none | Gets or sets the commission percentage for the producer. |
| commissionProducerId | integer(int32) | false | none | Gets or sets the commission producer. |
| compensationTypeId | integer(int32)|null | false | none | Gets or sets the producer compensation type. |
| planId | integer(int32) | false | none | Gets or sets the plan the commission split is for. |
{
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Departments within the broker agency.",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup3 | false | none | Agency-defined Plan Lookup |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Departments within the broker agency. |
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
}
Agency-defined Plan Lookup
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the lookup's unique id. |
| description | string | false | none | Gets or sets the description. |
| amsCode | string | false | none | Gets the lookup code - the lookup id in a third-party system. |
| isDeleted | boolean | false | none | Gets or sets a value indicating whether this lookup is deleted. |
{
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Policy status the plan ends with.",
"additionalProperties": false,
"properties": {
"salesTrackingStatus": {
"description": "Gets or sets the sales tracking status.",
"oneOf": [
{
"type": "string",
"description": "EndingSalesTrackingStatuses",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup3 | false | none | Agency-defined Plan Lookup |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Policy status the plan ends with. |
| » salesTrackingStatus | EndingSalesTrackingStatuses2 | false | none | Gets or sets the sales tracking status. |
{
"type": "string",
"description": "EndingSalesTrackingStatuses",
"x-enumNames": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
],
"enum": [
"None",
"RetainedSameCarrier",
"Lost",
"RetainedDifferentCarrier"
]
}
EndingSalesTrackingStatuses
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | EndingSalesTrackingStatuses |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | RetainedSameCarrier |
| anonymous | Lost |
| anonymous | RetainedDifferentCarrier |
{
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Policy status the BrokerageBuilder plan starts with.",
"additionalProperties": false,
"properties": {
"salesTrackingStatus": {
"description": "Gets the sales tracking status.",
"oneOf": [
{
"type": "string",
"description": "Plan BeginningSalesTrackingStatuses",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup3 | false | none | Agency-defined Plan Lookup |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Policy status the BrokerageBuilder plan starts with. |
| » salesTrackingStatus | BeginningSalesTrackingStatuses | false | none | Gets the sales tracking status. |
{
"type": "string",
"description": "Plan BeginningSalesTrackingStatuses",
"x-enumNames": [
"None",
"New",
"Retain",
"QuotedOnly"
],
"enum": [
"None",
"New",
"Retain",
"QuotedOnly"
]
}
Plan BeginningSalesTrackingStatuses
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Plan BeginningSalesTrackingStatuses |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | New |
| anonymous | Retain |
| anonymous | QuotedOnly |
{
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "Billing mode that determines how premiums are paid.",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup3 | false | none | Agency-defined Plan Lookup |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Billing mode that determines how premiums are paid. |
{
"allOf": [
{
"type": "object",
"description": "Agency-defined Plan Lookup",
"x-abstract": true,
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the lookup's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the description."
},
"amsCode": {
"type": "string",
"description": "Gets the lookup code - the lookup id in a third-party system."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this lookup is deleted."
}
}
},
{
"type": "object",
"description": "The timeline on which commissions are recorded for a plan.",
"additionalProperties": false,
"properties": {
"paymentsPerYear": {
"type": "integer",
"description": "Gets or sets the number of payments per year.",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Lookup3 | false | none | Agency-defined Plan Lookup |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | The timeline on which commissions are recorded for a plan. |
| » paymentsPerYear | integer(int32) | false | none | Gets or sets the number of payments per year. |
{
"type": "object",
"description": "Plan New Hire Waiting Period",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the waiting period's unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the waiting period description."
},
"planId": {
"type": "integer",
"description": "Gets or sets the plan id.",
"format": "int32"
},
"waitingPeriodInterval": {
"type": "integer",
"description": "Gets or sets the waiting period interval.",
"format": "int32",
"nullable": true
},
"waitingPeriodRule": {
"description": "Gets or sets the waiting period rule.",
"oneOf": [
{
"type": "string",
"description": "Available rules for Plan Hew Hire Waiting Periods.",
"x-enumNames": [
"None",
"SameAsHireDate",
"FirstOfMonthByMonthAfterHire",
"FirstOfMonthByDaysAfterHire",
"NumberDaysAfterHire",
"Other",
"FifteenthOfMonthByDays",
"NumberMonthsAfterHire",
"FirstOfMonthAfterHire"
],
"enum": [
"None",
"SameAsHireDate",
"FirstOfMonthByMonthAfterHire",
"FirstOfMonthByDaysAfterHire",
"NumberDaysAfterHire",
"Other",
"FifteenthOfMonthByDays",
"NumberMonthsAfterHire",
"FirstOfMonthAfterHire"
]
}
]
}
}
}
Plan New Hire Waiting Period
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the waiting period's unique id. |
| description | string | false | none | Gets or sets the waiting period description. |
| planId | integer(int32) | false | none | Gets or sets the plan id. |
| waitingPeriodInterval | integer(int32)|null | false | none | Gets or sets the waiting period interval. |
| waitingPeriodRule | NewHireWaitingPeriodRules | false | none | Gets or sets the waiting period rule. |
{
"type": "string",
"description": "Available rules for Plan Hew Hire Waiting Periods.",
"x-enumNames": [
"None",
"SameAsHireDate",
"FirstOfMonthByMonthAfterHire",
"FirstOfMonthByDaysAfterHire",
"NumberDaysAfterHire",
"Other",
"FifteenthOfMonthByDays",
"NumberMonthsAfterHire",
"FirstOfMonthAfterHire"
],
"enum": [
"None",
"SameAsHireDate",
"FirstOfMonthByMonthAfterHire",
"FirstOfMonthByDaysAfterHire",
"NumberDaysAfterHire",
"Other",
"FifteenthOfMonthByDays",
"NumberMonthsAfterHire",
"FirstOfMonthAfterHire"
]
}
Available rules for Plan Hew Hire Waiting Periods.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Available rules for Plan Hew Hire Waiting Periods. |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | SameAsHireDate |
| anonymous | FirstOfMonthByMonthAfterHire |
| anonymous | FirstOfMonthByDaysAfterHire |
| anonymous | NumberDaysAfterHire |
| anonymous | Other |
| anonymous | FifteenthOfMonthByDays |
| anonymous | NumberMonthsAfterHire |
| anonymous | FirstOfMonthAfterHire |
{
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
}
Plan Rate
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| discriminator | string | true | none | none |
{
"allOf": [
{
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
},
{
"type": "object",
"description": "Fixed Rate",
"additionalProperties": false,
"properties": {
"rate": {
"type": "string",
"description": "Gets or sets the fixed rate."
}
}
}
]
}
allOf - discriminator: Rate.discriminator
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Rate | false | none | Plan Rate |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Fixed Rate |
| » rate | string | false | none | Gets or sets the fixed rate. |
{
"allOf": [
{
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
},
{
"type": "object",
"description": "Tiered Rate",
"additionalProperties": false,
"properties": {
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Gets or sets the member count.",
"format": "int32"
},
"monthlyFee": {
"type": "number",
"description": "Gets or sets the monthly fee.",
"format": "decimal"
}
}
}
]
}
allOf - discriminator: Rate.discriminator
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Rate | false | none | Plan Rate |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Tiered Rate |
| » tierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| » count | integer(int32) | false | none | Gets or sets the member count. |
| » monthlyFee | number(decimal) | false | none | Gets or sets the monthly fee. |
{
"allOf": [
{
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
},
{
"type": "object",
"description": "Volume Rate",
"additionalProperties": false,
"properties": {
"ratePer": {
"type": "integer",
"description": "Gets or sets the rate per dollar amount.",
"format": "int32"
},
"volume": {
"type": "integer",
"description": "Gets or sets the total volume amount.",
"format": "int32"
},
"rate": {
"type": "number",
"description": "Gets or sets the rate value.",
"format": "decimal"
}
}
}
]
}
allOf - discriminator: Rate.discriminator
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Rate | false | none | Plan Rate |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Volume Rate |
| » ratePer | integer(int32) | false | none | Gets or sets the rate per dollar amount. |
| » volume | integer(int32) | false | none | Gets or sets the total volume amount. |
| » rate | number(decimal) | false | none | Gets or sets the rate value. |
{
"allOf": [
{
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
},
{
"type": "object",
"description": "Complex Rate",
"additionalProperties": false,
"properties": {
"column": {
"description": "Gets the column.",
"oneOf": [
{
"type": "object",
"description": "Complex Rate Column",
"additionalProperties": false,
"properties": {
"columnId": {
"type": "integer",
"description": "Gets the column id.",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"description": "Gets the sort order.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the column name."
}
}
}
]
},
"row": {
"description": "Gets the row.",
"oneOf": [
{
"type": "object",
"description": "Complex Rate Row",
"additionalProperties": false,
"properties": {
"rowId": {
"type": "integer",
"description": "Gets the row id.",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"description": "Gets the sort order.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the row name."
}
}
}
]
},
"rate": {
"type": "string",
"description": "Gets or sets the rate value."
}
}
}
]
}
allOf - discriminator: Rate.discriminator
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Rate | false | none | Plan Rate |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Complex Rate |
| » column | ComplexColumn | false | none | Gets the column. |
| » row | ComplexRow | false | none | Gets the row. |
| » rate | string | false | none | Gets or sets the rate value. |
{
"type": "object",
"description": "Complex Rate Column",
"additionalProperties": false,
"properties": {
"columnId": {
"type": "integer",
"description": "Gets the column id.",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"description": "Gets the sort order.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the column name."
}
}
}
Complex Rate Column
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| columnId | integer(int32) | false | none | Gets the column id. |
| sortOrder | integer(int32) | false | none | Gets the sort order. |
| name | string | false | none | Gets the column name. |
{
"type": "object",
"description": "Complex Rate Row",
"additionalProperties": false,
"properties": {
"rowId": {
"type": "integer",
"description": "Gets the row id.",
"format": "int32"
},
"sortOrder": {
"type": "integer",
"description": "Gets the sort order.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets the row name."
}
}
}
Complex Rate Row
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rowId | integer(int32) | false | none | Gets the row id. |
| sortOrder | integer(int32) | false | none | Gets the sort order. |
| name | string | false | none | Gets the row name. |
{
"allOf": [
{
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
},
{
"type": "object",
"description": "Self-Funded Rate",
"additionalProperties": false,
"properties": {
"feeTypeId": {
"type": "integer",
"description": "Gets or sets the fee type id.",
"format": "int32"
},
"selfFundedTierTypeId": {
"type": "integer",
"description": "Gets or sets the self funded tier type id.",
"format": "int32",
"nullable": true
},
"carrierId": {
"type": "integer",
"description": "Gets or sets the carrier id.",
"format": "int32",
"nullable": true
},
"memberCount": {
"type": "integer",
"description": "Gets or sets the member count.",
"format": "int32",
"nullable": true
},
"monthlyFee": {
"type": "number",
"description": "Gets or sets the monthly fee or estimated aggregate corridor.",
"format": "decimal",
"nullable": true
},
"stopLossValue": {
"type": "string",
"description": "Gets or sets the stop loss value."
},
"includes": {
"description": "Gets or sets a value indicating if the rates include Medical Only or Medical and Rx.",
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "IncludedItems",
"x-enumNames": [
"Medical",
"MedicalRx"
],
"enum": [
"Medical",
"MedicalRx"
]
}
]
}
}
}
]
}
allOf - discriminator: Rate.discriminator
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Rate | false | none | Plan Rate |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Self-Funded Rate |
| » feeTypeId | integer(int32) | false | none | Gets or sets the fee type id. |
| » selfFundedTierTypeId | integer(int32)|null | false | none | Gets or sets the self funded tier type id. |
| » carrierId | integer(int32)|null | false | none | Gets or sets the carrier id. |
| » memberCount | integer(int32)|null | false | none | Gets or sets the member count. |
| » monthlyFee | number(decimal)|null | false | none | Gets or sets the monthly fee or estimated aggregate corridor. |
| » stopLossValue | string | false | none | Gets or sets the stop loss value. |
| » includes | IncludedItems|null | false | none | Gets or sets a value indicating if the rates include Medical Only or Medical and Rx. |
{
"type": "string",
"description": "IncludedItems",
"x-enumNames": [
"Medical",
"MedicalRx"
],
"enum": [
"Medical",
"MedicalRx"
]
}
IncludedItems
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | IncludedItems |
| Property | Value |
|---|---|
| anonymous | Medical |
| anonymous | MedicalRx |
{
"type": "object",
"additionalProperties": false,
"required": [
"rates"
],
"properties": {
"rates": {
"type": "array",
"description": "The list of rates",
"items": {
"type": "object",
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"FixedRate": "#/components/schemas/FixedRate",
"TieredRate": "#/components/schemas/TieredRate",
"VolumeRate": "#/components/schemas/VolumeRate",
"ComplexRate": "#/components/schemas/ComplexRate",
"SelfFundedRate": "#/components/schemas/SelfFundedRate"
}
},
"description": "Plan Rate",
"x-abstract": true,
"additionalProperties": false,
"required": [
"discriminator"
],
"properties": {
"discriminator": {
"type": "string"
}
}
}
},
"options": {
"description": "The request options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
},
"planRateMetadata": {
"description": "The plan rate metadata. Used for modifying Self-Funded rates.",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"urBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Utilization Review administrator.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"slBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Stop Loss carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"pbmBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the PBM carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"adminHasNetwork": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Network fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasPbm": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include PBM fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasStopLoss": {
"type": "boolean",
"description": "Gets or sets a value indicating whether Administrative fees include Stop Loss fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"networkHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Network fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"stopLossHasAggregate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Stop Loss rates include Aggregate fees.\nApplies to Self-Funded rates.",
"nullable": true
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rates | [Rate] | true | none | The list of rates |
| options | CrudOptions|null | false | none | The request options |
| planRateMetadata | PlanRateMetadata|null | false | none | The plan rate metadata. Used for modifying Self-Funded rates. |
{
"type": "object",
"additionalProperties": false,
"properties": {
"urBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Utilization Review administrator.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"slBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the Stop Loss carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"pbmBusinessEntityId": {
"type": "integer",
"description": "Gets or sets the PBM carrier.\nApplies to Self-Funded rates.",
"format": "int32",
"nullable": true
},
"adminHasNetwork": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Network fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasPbm": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Administrative fees include PBM fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"adminHasStopLoss": {
"type": "boolean",
"description": "Gets or sets a value indicating whether Administrative fees include Stop Loss fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"networkHasUr": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Network fees include Utilization Review fees.\nApplies to Self-Funded rates.",
"nullable": true
},
"stopLossHasAggregate": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the Stop Loss rates include Aggregate fees.\nApplies to Self-Funded rates.",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| urBusinessEntityId | integer(int32)|null | false | none | Gets or sets the Utilization Review administrator. Applies to Self-Funded rates. |
| slBusinessEntityId | integer(int32)|null | false | none | Gets or sets the Stop Loss carrier. Applies to Self-Funded rates. |
| pbmBusinessEntityId | integer(int32)|null | false | none | Gets or sets the PBM carrier. Applies to Self-Funded rates. |
| adminHasNetwork | boolean|null | false | none | Gets or sets a value indicating whether the Administrative fees include Network fees. Applies to Self-Funded rates. |
| adminHasUr | boolean|null | false | none | Gets or sets a value indicating whether the Administrative fees include Utilization Review fees. Applies to Self-Funded rates. |
| adminHasPbm | boolean|null | false | none | Gets or sets a value indicating whether the Administrative fees include PBM fees. Applies to Self-Funded rates. |
| adminHasStopLoss | boolean|null | false | none | Gets or sets a value indicating whether Administrative fees include Stop Loss fees. Applies to Self-Funded rates. |
| networkHasUr | boolean|null | false | none | Gets or sets a value indicating whether the Network fees include Utilization Review fees. Applies to Self-Funded rates. |
| stopLossHasAggregate | boolean|null | false | none | Gets or sets a value indicating whether the Stop Loss rates include Aggregate fees. Applies to Self-Funded rates. |
{
"type": "object",
"description": "Self-Funded Fee Type",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique fee type id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee type description."
},
"section": {
"description": "Gets or sets the self-funded rate section the fee type applies to.",
"oneOf": [
{
"type": "string",
"description": "SelfFundedSections",
"x-enumNames": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
],
"enum": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
]
}
]
}
}
}
Self-Funded Fee Type
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique fee type id. |
| description | string | false | none | Gets or sets the fee type description. |
| section | SelfFundedSections | false | none | Gets or sets the self-funded rate section the fee type applies to. |
{
"type": "string",
"description": "SelfFundedSections",
"x-enumNames": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
],
"enum": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
]
}
SelfFundedSections
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | SelfFundedSections |
| Property | Value |
|---|---|
| anonymous | Administative |
| anonymous | StopLoss |
| anonymous | UtilizationReview |
| anonymous | Network |
| anonymous | PrescriptionBenefitManagement |
{
"type": "object",
"description": "Other Plan Fee",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee description."
},
"fee": {
"type": "number",
"description": "Gets or sets the monthly fee.",
"format": "decimal"
}
}
}
Other Plan Fee
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique id. |
| description | string | false | none | Gets or sets the fee description. |
| fee | number(decimal) | false | none | Gets or sets the monthly fee. |
{
"allOf": [
{
"type": "object",
"description": "Other Plan Fee",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee description."
},
"fee": {
"type": "number",
"description": "Gets or sets the monthly fee.",
"format": "decimal"
}
}
},
{
"type": "object",
"description": "Self-Funded Other Plan Fee",
"additionalProperties": false,
"properties": {
"feeType": {
"description": "Gets or sets a value indicating if the fee type is a monthly or annual fee.",
"oneOf": [
{
"type": "string",
"description": "FeeTypes",
"x-enumNames": [
"Annual",
"Monthly"
],
"enum": [
"Annual",
"Monthly"
]
}
]
},
"monthlyCount": {
"type": "integer",
"description": "Gets or sets the monthly count.",
"format": "int32",
"nullable": true
},
"section": {
"description": "Gets or sets the section.",
"oneOf": [
{
"type": "string",
"description": "SelfFundedSections",
"x-enumNames": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
],
"enum": [
"Administative",
"StopLoss",
"UtilizationReview",
"Network",
"PrescriptionBenefitManagement"
]
}
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | OtherFee | false | none | Other Plan Fee |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | Self-Funded Other Plan Fee |
| » feeType | FeeTypes | false | none | Gets or sets a value indicating if the fee type is a monthly or annual fee. |
| » monthlyCount | integer(int32)|null | false | none | Gets or sets the monthly count. |
| » section | SelfFundedSections | false | none | Gets or sets the section. |
{
"type": "string",
"description": "FeeTypes",
"x-enumNames": [
"Annual",
"Monthly"
],
"enum": [
"Annual",
"Monthly"
]
}
FeeTypes
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | FeeTypes |
| Property | Value |
|---|---|
| anonymous | Annual |
| anonymous | Monthly |
{
"type": "object",
"additionalProperties": false,
"required": [
"otherFees"
],
"properties": {
"otherFees": {
"type": "array",
"description": "The list of other fees",
"items": {
"type": "object",
"description": "Other Plan Fee",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique id.",
"format": "int32"
},
"description": {
"type": "string",
"description": "Gets or sets the fee description."
},
"fee": {
"type": "number",
"description": "Gets or sets the monthly fee.",
"format": "decimal"
}
}
}
},
"options": {
"description": "The request options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| otherFees | [OtherFee] | true | none | The list of other fees |
| options | CrudOptions|null | false | none | The request options |
{
"type": "object",
"description": "Plan Contribution Rates",
"additionalProperties": false,
"properties": {
"contributionType": {
"description": "Gets or sets the type of the contribution.",
"oneOf": [
{
"type": "string",
"description": "Type of contribtution rate.",
"x-enumNames": [
"Percent",
"Dollar"
],
"enum": [
"Percent",
"Dollar"
]
}
]
},
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"employerRate": {
"type": "number",
"description": "Gets or sets the employer rate.",
"format": "decimal",
"nullable": true
},
"employeeRate": {
"type": "number",
"description": "Gets or sets the employee rate.",
"format": "decimal",
"nullable": true
}
}
}
Plan Contribution Rates
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contributionType | ContributionTypes | false | none | Gets or sets the type of the contribution. |
| tierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| employerRate | number(decimal)|null | false | none | Gets or sets the employer rate. |
| employeeRate | number(decimal)|null | false | none | Gets or sets the employee rate. |
{
"type": "string",
"description": "Type of contribtution rate.",
"x-enumNames": [
"Percent",
"Dollar"
],
"enum": [
"Percent",
"Dollar"
]
}
Type of contribtution rate.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | Type of contribtution rate. |
| Property | Value |
|---|---|
| anonymous | Percent |
| anonymous | Dollar |
{
"type": "object",
"additionalProperties": false,
"required": [
"contributionRates"
],
"properties": {
"contributionRates": {
"type": "array",
"description": "The list of contribution rates",
"items": {
"type": "object",
"description": "Plan Contribution Rates",
"additionalProperties": false,
"properties": {
"contributionType": {
"description": "Gets or sets the type of the contribution.",
"oneOf": [
{
"type": "string",
"description": "Type of contribtution rate.",
"x-enumNames": [
"Percent",
"Dollar"
],
"enum": [
"Percent",
"Dollar"
]
}
]
},
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"employerRate": {
"type": "number",
"description": "Gets or sets the employer rate.",
"format": "decimal",
"nullable": true
},
"employeeRate": {
"type": "number",
"description": "Gets or sets the employee rate.",
"format": "decimal",
"nullable": true
}
}
}
},
"options": {
"description": "The request options",
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"force": {
"type": "boolean"
},
"validateOnly": {
"type": "boolean"
}
}
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contributionRates | [ContributionRate] | true | none | The list of contribution rates |
| options | CrudOptions|null | false | none | The request options |
{
"type": "object",
"description": "TierType",
"additionalProperties": false,
"properties": {
"tierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is deleted."
}
}
}
TierType
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| tierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| name | string | false | none | Gets or sets the name. |
| isDeleted | boolean | false | none | Gets or sets a value indicating whether this instance is deleted. |
{
"type": "object",
"description": "SelfFundedTierType",
"additionalProperties": false,
"properties": {
"selfFundedTierTypeId": {
"type": "integer",
"description": "Gets or sets the tier type id.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the name."
},
"isDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether this instance is deleted."
}
}
}
SelfFundedTierType
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| selfFundedTierTypeId | integer(int32) | false | none | Gets or sets the tier type id. |
| name | string | false | none | Gets or sets the name. |
| isDeleted | boolean | false | none | Gets or sets a value indicating whether this instance is deleted. |
{
"type": "object",
"description": "Represents a role a user may have on an account.",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Gets or sets the unique ID for this role.",
"format": "int32"
},
"brokerId": {
"type": "integer",
"description": "Gets or sets the unique broker ID for this role.",
"format": "int32"
},
"name": {
"type": "string",
"description": "Gets or sets the role name."
}
}
}
Represents a role a user may have on an account.
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | Gets or sets the unique ID for this role. |
| brokerId | integer(int32) | false | none | Gets or sets the unique broker ID for this role. |
| name | string | false | none | Gets or sets the role name. |