The Accounts and Contacts API V3 is our latest and most improved version of the accounts API, and it’s the one we recommend using going forward. V3 is designed to be easier to work with, more secure, and better aligned with how permissions are managed in Zywave today. V3 also supports newer features that aren’t available in previous versions, and it will continue to grow as we roll out future enhancements.
title: Accounts API - 3.0 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 /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{id}
Gets a specific account contact by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account contact id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AccountContact |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{id}
Updates an account contact.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account contact id. |
| body | body | AccountContactInfo | true | An object representing the account contact information. All fields will be updated. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
| 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 |
PATCH /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{id}
Partially updates an account contact.
Body parameter
{
"type": "object"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account contact id. |
| body | body | object | true | A JSON Patch document (RFC 6902) describing the fields to update. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
| 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 /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{id}
Delete an account contact.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account contact id. |
Example responses
400 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 400 | Bad Request | none | ProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
| 409 | Conflict | none | ProblemDetails |
GET /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact
Search for account contacts.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties that can be used when filtering and ordering the response.
The following OData filter operations are supported by the Zywave API; each is accompanied by an example request.
| Operation | Example Request | Returns |
|---|---|---|
| endswith | endswith(lastName,'tact') | Returns all account contacts where the last name ends with 'tact' |
| startswith | startswith(lastName,'Cont') | Returns all account contacts where the last name starts with 'Cont' |
| contains | contains(lastName,'tact') | Returns all account contacts where the name contains 'tact' |
| Equals | accountId eq 2726742 | Returns all account contacts for the Zywave account with this unique id |
| Not Equals | isActive ne false | Returns all account contacts that are active |
| In | lastName in ('Cont', 'act') | Returns all account contacts where the last name is 'Cont' or 'act' |
| Not | not startswith(lastName, 'Cont') | Returns all account contacts where the last name does not start with 'Cont' |
The Zywave API also supports the And operation which will allow for multiple search criteria to be applied to a single request. For example, the following filter will return all active account contacts for the given account;
accountId eq 726742 and isActive ne false
The orderby operation also supports multiple levels of ordering. For example, to order the results by accountId then lastName the following can be used;
accountId asc, lastName asc
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountContact |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact
Creates an account contact.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| body | body | AccountContactInfo | true | An object representing the account contact information. |
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 /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{accountContactId}/driverinfo
Gets driver information for a specific account contact.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| accountContactId | path | integer(int32) | true | none |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"createdDateTimeOffset": {
"type": "string",
"format": "date-time"
},
"updatedDateTimeOffset": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AccountContactDriver |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{accountContactId}/driverinfo
Creates driver information for a specific account contact. Driver info has a 1:1 relationship with an account contact, so only one record can exist per contact.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| accountContactId | path | integer(int32) | true | none |
| body | body | AccountContactDriverInfo | true | none |
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 |
| 409 | Conflict | none | ProblemDetails |
PUT /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{accountContactId}/driverinfo
Updates driver information for a specific account contact.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| accountContactId | path | integer(int32) | true | none |
| body | body | AccountContactDriverInfo | true | none |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
| 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 /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{accountContactId}/driverinfo
Deletes driver information for a specific account contact.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| accountContactId | path | integer(int32) | true | none |
Example responses
401 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountcontact/{accountContactId}/driverinfo/search
Search for driver information records.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| accountContactId | path | integer(int32) | true | none |
| $filter | query | string | false | none |
| $orderBy | query | string | false | none |
| $skip | query | integer(int32) | false | none |
| $top | query | integer(int32) | false | none |
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": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"createdDateTimeOffset": {
"type": "string",
"format": "date-time"
},
"updatedDateTimeOffset": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountContactDriver |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
GET /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/account/{id}
Gets a specific business or personal account by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account id. |
Example responses
200 Response
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"msid": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | Account |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
PUT /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/account/{id}
Updates a business or personal account.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account id. |
| body | body | AccountInfo | true | An object representing the account information. All fields will be updated. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
| 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 |
PATCH /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/account/{id}
Partially updates a business or personal account.
Body parameter
{
"type": "object"
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account id. |
| body | body | object | true | A JSON Patch document (RFC 6902) describing the fields to update. |
Example responses
400 Response
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
| 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 /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/account/{id}
Delete a business or personal account.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account id. |
Example responses
401 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/account
Search for business and personal accounts.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is divisible by the $top. |
| $search | query | string | false | none |
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": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"msid": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccount |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
POST /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/account
Creates a business or personal account.
Body parameter
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
}
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| batchId | query | string | false | none |
| body | body | AccountInfo | true | An object representing the account information. |
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 /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/accountexternalreference
Search for external account reference.
An external reference is a relationship that links a Zywave account to an external account stored outside of Zywave. External references are often used to link a Zywave account to another system's account for integration purposes.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is dividable by the $top. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"accountId",
"externalId"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceName": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"sourceId": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"sourceType": {
"type": "string",
"maxLength": 255,
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountExternalReference |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/industry/sic
Search for business and personal industry (SIC classification) information.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
The following OData filter operations are supported by the Zywave API; each is accompanied by an example request.
| Operation | Example Request | Returns |
|---|---|---|
| startswith | startswith(Name,'Zyw') | Returns all industries where the name starts with 'Zyw' |
| endswith | endswith(Name,'wave') | Returns all industries where the name ends with 'wave' |
| contains | contains(Name,'wave') | Returns all industries where the name contains 'wave' |
| Equals | Name eq 'Zywave' | Returns all industries named Zywave |
| Not Equals | Name ne 'Zywave' | Returns all industries not named Zywave |
| Greater Than | year gt 2012 | Returns all industries with a sicCode year greater than 2012 |
| Greater Than or equal | length ge 2 | Returns all industries with a sicCode length greater than or equal to 2 |
| Less Than | year lt 2012 | Returns all industries with a sicCode year less than or equal to 2012 |
| Less Than or equal | length le 22 | Returns all industries with a sicCode length less than or equal to 22 |
| In | Name in ('Zyw', 'ave') | Returns all industries with the names 'Zyw' or 'ave'. |
| Not | not startswith(Name,'Zyw') | Returns all industries with a name that doesn't start with ‘Zyw’ |
| The Zywave API also supports the And operation which will allow for multiple search criteria to be applied to a single request. For example, the following filter will return all industries with a name that includes ‘I’ and a sicCode greater than 22 |
Contains(Name, 'I') and naicsCode gt 22
The orderby operation also supports multiple levels of ordering. For example, to order the results by name and then by sicCode, the following can be used;
Name asc, sicCode desc
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | none |
| $orderBy | query | string | false | none |
| $skip | query | integer(int32) | false | none |
| $top | query | integer(int32) | false | none |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
},
"year": {
"type": "string"
},
"replacementIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfIndustry |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/industry/naics
Search for business and personal industry (NAICS classification) information.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
The following OData filter operations are supported by the Zywave API; each is accompanied by an example request.
| Operation | Example Request | Returns |
|---|---|---|
| startswith | startswith(Name,'Zyw') | Returns all NAICS codes where the name starts with 'Zyw' |
| endswith | endswith(Name,'wave') | Returns all NAICS codes where the name ends with 'wave' |
| contains | contains(Name,'wave') | Returns all NAICS codes where the name contains 'wave' |
| Equals | Name eq 'Zywave' | Returns all NAICS codes named Zywave |
| Not Equals | Name ne 'Zywave' | Returns all NAICS codes not named Zywave |
| Greater Than | year gt 2017 | Returns all NAICS codes with a NAICS code year greater than 2017 |
| Greater Than or equal | length ge 2 | Returns all NAICS codes with a naicsCode length greater than or equal to 2 |
| Less Than | year lt 22 | Returns all NAICS codes with a naicsCode less than or equal to 22 |
| Less Than or equal | length le 2 | Returns all NAICS codes with a naicsCode length less than or equal to 2 |
| In | Name in ('Zyw', 'ave') | Returns all NAICS codes with the names 'Zyw' or 'ave'. |
| Not | not startswith(Name,'Zyw') | Returns all NAICS codes with a name that doesn't start with ‘Zyw’ |
| The Zywave API also supports the And operation which will allow for multiple search criteria to be applied to a single request. For example, the following filter will return all industries with a name that includes ‘I’ and a naicsCode greater than 22 |
Contains(Name, 'I') and naicsCode gt 22
The orderby operation also supports multiple levels of ordering. For example, to order the results by name and then by naicsCode, the following can be used;
Name asc, naicsCode desc
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| $filter | query | string | false | none |
| $orderBy | query | string | false | none |
| $skip | query | integer(int32) | false | none |
| $top | query | integer(int32) | false | none |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
},
"year": {
"type": "string"
},
"replacementIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfIndustry |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/label/{id}
Gets a specific account label by id.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| id | path | integer(int32) | true | The account label id. |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AccountLabel |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/org/{orgId}/agency/{agencyId}/label
Search for account labels.
The Zywave API search is implemented using OData Version 4.0.1. Not all OData operations are available for the Zywave API platform at this time. Not all properties are filterable or sortable. The following properties can be used when filtering and ordering the response.
See the Zywave API search documentation for more details about using OData search.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string(guid) | true | none |
| agencyId | path | integer(int32) | true | none |
| $filter | query | string | false | The search criteria for the request. To view a list of supported search operations and the properties which can be searched see the documentation above. |
| $orderBy | query | string | false | Defines the order in which the results are returned. To view a list of properties that can be used in ordering see the documentation above. |
| $skip | query | integer(int32) | false | The number of total records to skip before displaying the first result. For example, if there are 10 total records and $skip is set to 5 the first record shown in the response will be the 6th record returned. In order to avoid an error please ensure that the $skip is dividable by the $top. |
| $top | query | integer(int32) | false | The total number of records returned in the response. In order to avoid an error please ensure that the $skip is divisible by the $top. |
| $search | query | string | false | none |
Example responses
200 Response
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
}
}
}
}
}
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PagedResultOfAccountLabel |
| 400 | Bad Request | none | ValidationProblemDetails |
| 401 | Unauthorized | none | ProblemDetails |
| 403 | Forbidden | none | ProblemDetails |
| 404 | Not Found | none | ProblemDetails |
GET /v3/accounts/v3.0/relationshiptype/account
Get the list of available relationships for accounts
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"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 | [RelationshipType] | false | none | none |
| » id | integer(int32) | false | none | none |
| » relationship | string | true | none | none |
GET /v3/accounts/v3.0/relationshiptype/contact
Get the list of available relationships for contacts
Example responses
200 Response
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"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 | [RelationshipType] | false | none | none |
| » id | integer(int32) | false | none | none |
| » relationship | string | true | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"rootCorrelationId": {
"type": "string",
"format": "guid"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rootCorrelationId | string(guid) | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
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 |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
},
{
"type": "object",
"additionalProperties": {
"nullable": true
},
"properties": {
"errors": {
"type": "object",
"additionalProperties": false
}
}
}
]
}
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 |
{
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string|null | false | none | none |
| title | string|null | false | none | none |
| status | integer(int32)|null | false | none | none |
| detail | string|null | false | none | none |
| instance | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"entities": {
"type": "array",
"items": {}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| entities | [any] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
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 | none |
| » createdDateTime | string(date-time) | false | none | none |
| » updatedDateTime | string(date-time)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| accountId | integer(int32) | false | none | none |
| birthDate | string(date-time)|null | false | none | none |
| gender | Gender|null | false | none | none |
| maritalStatus | MaritalStatus|null | false | none | none |
| contactConsentExpirationDateTime | string(date-time)|null | false | none | none |
| contactConsentStartDateTime | string(date-time)|null | false | none | none |
| contactConsentOrigin | string|null | false | none | none |
| contactConsentSource | string|null | false | none | none |
| emailAddress | string|null | false | none | none |
| firstName | string|null | false | none | none |
| isActive | boolean | false | none | none |
| isArchived | boolean | false | none | none |
| isEmailAllowed | boolean | false | none | none |
| isPrimaryContact | boolean | false | none | none |
| lastName | string|null | false | none | none |
| salutation | string|null | false | none | none |
| title | string|null | false | none | none |
| linesOfBusiness | [LineOfBusiness]|null | false | none | none |
| addresses | [AccountContactAddress]|null | false | none | none |
| phones | [AccountContactPhone]|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Male |
| anonymous | Female |
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Single |
| anonymous | Married |
| anonymous | Separated |
| anonymous | Divorced |
| anonymous | Widowed |
| anonymous | DomesticPartner |
| anonymous | CivilUnion |
| anonymous | Fiancee |
| anonymous | Other |
{
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Benefits |
| anonymous | PC |
| anonymous | PersonalLines |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AddressInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
| » accountContactId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addressLine1 | string|null | false | none | none |
| addressLine2 | string|null | false | none | none |
| addressLine3 | string|null | false | none | none |
| city | string|null | false | none | none |
| country | string|null | false | none | none |
| county | string|null | false | none | none |
| isPrimary | boolean | false | none | none |
| postalCode | string|null | false | none | none |
| state | string|null | false | none | none |
| type | AddressType | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Home |
| anonymous | Mailing |
| anonymous | Office |
| anonymous | Billing |
| anonymous | Business |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PhoneInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
| » accountContactId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| extension | string|null | false | none | none |
| isPrimary | boolean | false | none | none |
| number | string|null | false | none | none |
| type | PhoneType | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Mobile |
| anonymous | Work |
| anonymous | Home |
| anonymous | Fax |
{
"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",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"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 | [AccountContact] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operations": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"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
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operations | [OperationOfAccountContact]|null | false | none | none |
{
"allOf": [
{
"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
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Operation | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"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": [
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"options": {
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"skip": {
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
},
"take": {
"type": "integer",
"format": "int32",
"default": 100,
"maximum": 2147483647,
"minimum": 0
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"criteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
]
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"order": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"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
}
}
}
]
},
"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
}
}
}
]
},
"firstName": {
"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
}
}
}
]
},
"lastName": {
"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
}
}
}
]
},
"emailAddress": {
"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
}
}
}
]
},
"isEmailAllowed": {
"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
}
}
}
]
},
"isPrimaryContact": {
"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
}
}
}
]
},
"isActive": {
"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
}
}
}
]
},
"isArchived": {
"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
}
}
}
]
}
}
}
]
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchRequestOfInternalAccountContactSearchCriteriaAndAccountContactSearchOrder | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"allOf": [
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"options": {
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"skip": {
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
},
"take": {
"type": "integer",
"format": "int32",
"default": 100,
"maximum": 2147483647,
"minimum": 0
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"criteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
]
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"order": {
"nullable": true,
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"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
}
}
}
]
},
"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
}
}
}
]
},
"firstName": {
"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
}
}
}
]
},
"lastName": {
"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
}
}
}
]
},
"emailAddress": {
"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
}
}
}
]
},
"isEmailAllowed": {
"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
}
}
}
]
},
"isPrimaryContact": {
"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
}
}
}
]
},
"isActive": {
"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
}
}
}
]
},
"isArchived": {
"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
}
}
}
]
}
}
}
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchRequestOfInternalAccountContactSearchCriteria | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » order | AccountContactSearchOrder|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"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
}
}
}
]
},
"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
}
}
}
]
},
"firstName": {
"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
}
}
}
]
},
"lastName": {
"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
}
}
}
]
},
"emailAddress": {
"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
}
}
}
]
},
"isEmailAllowed": {
"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
}
}
}
]
},
"isPrimaryContact": {
"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
}
}
}
]
},
"isActive": {
"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
}
}
}
]
},
"isArchived": {
"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 |
|---|---|---|---|---|
| id | Sort|null | false | none | none |
| accountId | Sort|null | false | none | none |
| firstName | Sort|null | false | none | none |
| lastName | Sort|null | false | none | none |
| emailAddress | Sort|null | false | none | none |
| isEmailAllowed | Sort|null | false | none | none |
| isPrimaryContact | Sort|null | false | none | none |
| isActive | Sort|null | false | none | none |
| isArchived | 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 |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"options": {
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"skip": {
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
},
"take": {
"type": "integer",
"format": "int32",
"default": 100,
"maximum": 2147483647,
"minimum": 0
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"criteria": {
"nullable": true,
"oneOf": [
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | SearchRequest | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » criteria | InternalAccountContactSearchCriteria|null | false | none | Internal model excluded from public docs |
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"additionalProperties": false
}
None
{
"type": "string",
"description": "",
"x-enumNames": [
"And",
"Or"
],
"enum": [
"And",
"Or"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | And |
| anonymous | Or |
{
"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": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Any |
| anonymous | All |
| anonymous | Count |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"In",
"NotIn"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | In |
| anonymous | NotIn |
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Any |
| anonymous | All |
| anonymous | Count |
{
"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": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count",
"Sum",
"Average",
"Min",
"Max"
],
"enum": [
"Any",
"All",
"Count",
"Sum",
"Average",
"Min",
"Max"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Any |
| anonymous | All |
| anonymous | Count |
| anonymous | Sum |
| anonymous | Average |
| anonymous | Min |
| anonymous | Max |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"NotContains",
"IsNullOrEmpty",
"IsNotNullOrEmpty",
"IsNullOrWhitespace",
"IsNotNullOrWhitespace",
"StartsWith",
"NotStartsWith",
"EndsWith",
"NotEndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"NotContains",
"IsNullOrEmpty",
"IsNotNullOrEmpty",
"IsNullOrWhitespace",
"IsNotNullOrWhitespace",
"StartsWith",
"NotStartsWith",
"EndsWith",
"NotEndsWith",
"In",
"NotIn"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | Equals |
| anonymous | NotEquals |
| anonymous | Contains |
| anonymous | NotContains |
| anonymous | IsNullOrEmpty |
| anonymous | IsNotNullOrEmpty |
| anonymous | IsNullOrWhitespace |
| anonymous | IsNotNullOrWhitespace |
| anonymous | StartsWith |
| anonymous | NotStartsWith |
| anonymous | EndsWith |
| anonymous | NotEndsWith |
| anonymous | In |
| anonymous | NotIn |
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Any |
| anonymous | All |
| anonymous | Count |
{
"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": {
"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",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "string",
"nullable": true
}
},
"rangeEndValue": {
"type": "string",
"nullable": true
},
"rangeStartValue": {
"type": "string",
"nullable": true
},
"nullReplacementValue": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | string|null | false | none | none |
| values | [string]|null | false | none | none |
| rangeEndValue | string|null | false | none | none |
| rangeStartValue | string|null | false | none | none |
| nullReplacementValue | string|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": "byte",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "byte",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "byte",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "byte",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "byte",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer(byte)|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer(byte)|null | false | none | none |
| rangeStartValue | integer(byte)|null | false | none | none |
| nullReplacementValue | integer(byte)|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",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer|null | false | none | none |
| rangeStartValue | integer|null | false | none | none |
| nullReplacementValue | integer|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": "uint64",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "uint64",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "uint64",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "uint64",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "uint64",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer(uint64)|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer(uint64)|null | false | none | none |
| rangeStartValue | integer(uint64)|null | false | none | none |
| nullReplacementValue | integer(uint64)|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",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer|null | false | none | none |
| rangeStartValue | integer|null | false | none | none |
| nullReplacementValue | integer|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",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer|null | false | none | none |
| rangeStartValue | integer|null | false | none | none |
| nullReplacementValue | integer|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": "int64",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"rangeEndValue": {
"type": "integer",
"format": "int64",
"nullable": true
},
"rangeStartValue": {
"type": "integer",
"format": "int64",
"nullable": true
},
"nullReplacementValue": {
"type": "integer",
"format": "int64",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | integer(int64)|null | false | none | none |
| values | [integer]|null | false | none | none |
| rangeEndValue | integer(int64)|null | false | none | none |
| rangeStartValue | integer(int64)|null | false | none | none |
| nullReplacementValue | integer(int64)|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": {
"type": "number",
"format": "float",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "number",
"format": "float",
"nullable": true
}
},
"rangeEndValue": {
"type": "number",
"format": "float",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "float",
"nullable": true
},
"nullReplacementValue": {
"type": "number",
"format": "float",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | number(float)|null | false | none | none |
| values | [number]|null | false | none | none |
| rangeEndValue | number(float)|null | false | none | none |
| rangeStartValue | number(float)|null | false | none | none |
| nullReplacementValue | number(float)|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": "double",
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"type": "number",
"format": "double",
"nullable": true
}
},
"rangeEndValue": {
"type": "number",
"format": "double",
"nullable": true
},
"rangeStartValue": {
"type": "number",
"format": "double",
"nullable": true
},
"nullReplacementValue": {
"type": "number",
"format": "double",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operation | ValueOperation | false | none | none |
| value | number(double)|null | false | none | none |
| values | [number]|null | false | none | none |
| rangeEndValue | number(double)|null | false | none | none |
| rangeStartValue | number(double)|null | false | none | none |
| nullReplacementValue | number(double)|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",
"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 |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"nullable": true,
"items": "[Circular]"
},
"operator": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"And",
"Or"
],
"enum": [
"And",
"Or"
]
}
]
},
"name": {
"type": "string",
"nullable": true
},
"booleanOperation": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
}
]
},
"booleanAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
]
},
"idOperation": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"In",
"NotIn"
]
}
]
},
"idAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
]
},
"valueOperation": {
"nullable": true,
"oneOf": [
{
"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"
]
}
]
},
"valueAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count",
"Sum",
"Average",
"Min",
"Max"
],
"enum": [
"Any",
"All",
"Count",
"Sum",
"Average",
"Min",
"Max"
]
}
]
},
"stringOperation": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"NotContains",
"IsNullOrEmpty",
"IsNotNullOrEmpty",
"IsNullOrWhitespace",
"IsNotNullOrWhitespace",
"StartsWith",
"NotStartsWith",
"EndsWith",
"NotEndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"NotContains",
"IsNullOrEmpty",
"IsNotNullOrEmpty",
"IsNullOrWhitespace",
"IsNotNullOrWhitespace",
"StartsWith",
"NotStartsWith",
"EndsWith",
"NotEndsWith",
"In",
"NotIn"
]
}
]
},
"stringAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
]
},
"value": {
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true
}
},
"rangeEndValue": {
"nullable": true
},
"rangeStartValue": {
"nullable": true
},
"nullReplacementValue": {
"nullable": true
},
"count": {
"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
}
}
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"groupAggregateFunction": {
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | CriterionGroup | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » groupAggregateFunction | AggregateFunction | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Any |
| anonymous | All |
| anonymous | Count |
{
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"nullable": true,
"items": "[Circular]"
},
"operator": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"And",
"Or"
],
"enum": [
"And",
"Or"
]
}
]
},
"name": {
"type": "string",
"nullable": true
},
"booleanOperation": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals"
],
"enum": [
"None",
"Equals",
"NotEquals"
]
}
]
},
"booleanAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
]
},
"idOperation": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"In",
"NotIn"
]
}
]
},
"idAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
]
},
"valueOperation": {
"nullable": true,
"oneOf": [
{
"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"
]
}
]
},
"valueAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count",
"Sum",
"Average",
"Min",
"Max"
],
"enum": [
"Any",
"All",
"Count",
"Sum",
"Average",
"Min",
"Max"
]
}
]
},
"stringOperation": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Equals",
"NotEquals",
"Contains",
"NotContains",
"IsNullOrEmpty",
"IsNotNullOrEmpty",
"IsNullOrWhitespace",
"IsNotNullOrWhitespace",
"StartsWith",
"NotStartsWith",
"EndsWith",
"NotEndsWith",
"In",
"NotIn"
],
"enum": [
"None",
"Equals",
"NotEquals",
"Contains",
"NotContains",
"IsNullOrEmpty",
"IsNotNullOrEmpty",
"IsNullOrWhitespace",
"IsNotNullOrWhitespace",
"StartsWith",
"NotStartsWith",
"EndsWith",
"NotEndsWith",
"In",
"NotIn"
]
}
]
},
"stringAggregateFunction": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Any",
"All",
"Count"
],
"enum": [
"Any",
"All",
"Count"
]
}
]
},
"value": {
"nullable": true
},
"values": {
"type": "array",
"nullable": true,
"items": {
"nullable": true
}
},
"rangeEndValue": {
"nullable": true
},
"rangeStartValue": {
"nullable": true
},
"nullReplacementValue": {
"nullable": true
},
"count": {
"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 |
|---|---|---|---|---|
| items | [CriterionGroup]|null | false | none | none |
| operator | LogicalOperator|null | false | none | none |
| name | string|null | false | none | none |
| booleanOperation | BooleanOperation|null | false | none | none |
| booleanAggregateFunction | BooleanAggregateFunction|null | false | none | none |
| idOperation | IdOperation|null | false | none | none |
| idAggregateFunction | IdAggregateFunction|null | false | none | none |
| valueOperation | ValueOperation|null | false | none | none |
| valueAggregateFunction | ValueAggregateFunction|null | false | none | none |
| stringOperation | StringOperation|null | false | none | none |
| stringAggregateFunction | StringAggregateFunction|null | false | none | none |
| value | any | false | none | none |
| values | [any]|null | false | none | none |
| rangeEndValue | any | false | none | none |
| rangeStartValue | any | false | none | none |
| nullReplacementValue | any | false | none | none |
| count | ValueCriterionOfInteger|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": "object",
"additionalProperties": false,
"properties": {
"options": {
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"skip": {
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
},
"take": {
"type": "integer",
"format": "int32",
"default": 100,
"maximum": 2147483647,
"minimum": 0
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| options | SearchOptions | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"pageIndex": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"pageSize": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 0,
"nullable": true
},
"skip": {
"type": "integer",
"format": "int32",
"default": 0,
"maximum": 2147483647,
"minimum": 0
},
"take": {
"type": "integer",
"format": "int32",
"default": 100,
"maximum": 2147483647,
"minimum": 0
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pageIndex | integer(int32)|null | false | none | none |
| pageSize | integer(int32)|null | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"sourceContact": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
},
"matchedContacts": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
},
"decision": {
"type": "string",
"description": "",
"x-enumNames": [
"NoConfidenceMatch",
"LowConfidenceMatch",
"MediumConfidenceMatch",
"HighConfidenceMatch"
],
"enum": [
"NoConfidenceMatch",
"LowConfidenceMatch",
"MediumConfidenceMatch",
"HighConfidenceMatch"
]
},
"evidence": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sourceContact | AccountContact | false | none | none |
| matchedContacts | [AccountContact] | false | none | none |
| decision | Decision | false | none | none |
| evidence | string|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"NoConfidenceMatch",
"LowConfidenceMatch",
"MediumConfidenceMatch",
"HighConfidenceMatch"
],
"enum": [
"NoConfidenceMatch",
"LowConfidenceMatch",
"MediumConfidenceMatch",
"HighConfidenceMatch"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | NoConfidenceMatch |
| anonymous | LowConfidenceMatch |
| anonymous | MediumConfidenceMatch |
| anonymous | HighConfidenceMatch |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"createdDateTimeOffset": {
"type": "string",
"format": "date-time"
},
"updatedDateTimeOffset": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountContactDriverInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » accountContactId | integer(int32) | false | none | none |
| » createdDateTimeOffset | string(date-time) | false | none | none |
| » updatedDateTimeOffset | string(date-time)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| driverLicenseNumber | string|null | false | none | none |
| driverLicenseState | string|null | false | none | none |
| dateLicensed | string(date-time)|null | false | none | none |
| licenseExpirationDate | string(date-time)|null | false | none | none |
| licenseStatus | LicenseStatus|null | false | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Valid |
| anonymous | Unlicensed |
| anonymous | Permit |
| anonymous | Suspended |
{
"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": {
"driverLicenseNumber": {
"type": "string",
"maxLength": 25,
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"dateLicensed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
],
"enum": [
"Valid",
"Unlicensed",
"Permit",
"Suspended"
]
}
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountContactId": {
"type": "integer",
"format": "int32"
},
"createdDateTimeOffset": {
"type": "string",
"format": "date-time"
},
"updatedDateTimeOffset": {
"type": "string",
"format": "date-time",
"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 | [AccountContactDriver] | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"msid": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
| » msid | string|null | false | none | none |
| » createdDateTime | string(date-time) | false | none | none |
| » updatedDateTime | string(date-time)|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isArchived | boolean | false | none | none |
| name | string|null | false | none | none |
| url | string|null | false | none | none |
| numberOfEmployees | integer(int32)|null | false | none | none |
| numberOfRetirees | integer(int32)|null | false | none | none |
| yearFounded | integer(int32)|null | false | none | none |
| industryData | [IndustryData]|null | false | none | none |
| classification | AccountClassification|null | false | none | none |
| relationships | [AccountRelationship]|null | false | none | none |
| clientSize | ClientSize|null | false | none | none |
| isActive | boolean | false | none | none |
| addresses | [AccountAddress]|null | false | none | none |
| phones | [AccountPhone]|null | false | none | none |
| groups | [integer]|null | false | none | none |
| labels | [integer]|null | false | none | none |
| linesOfBusiness | [RelationshipType]|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| classification | IndustryClassification | false | none | none |
| code | string | true | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | NAICS |
| anonymous | SIC |
| anonymous | UKSIC |
| anonymous | ISO |
| anonymous | WCCode |
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Personal |
| anonymous | Commercial |
{
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | BenefitProspect |
| anonymous | BenefitClient |
| anonymous | PcProspect |
| anonymous | PcClient |
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | From0To25 |
| anonymous | From26To50 |
| anonymous | From51To99 |
| anonymous | From100To499 |
| anonymous | From500To999 |
| anonymous | From1000To2499 |
| anonymous | From2500To4999 |
| anonymous | MoreThan4999 |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AddressInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
| » accountId | integer(int32) | false | none | none |
{
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | PhoneInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
| » accountId | integer(int32) | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| relationship | string | true | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"msid": {
"type": "string",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"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 | [Account] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"operations": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"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
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operations | [OperationOfAccount]|null | false | none | none |
{
"allOf": [
{
"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
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Operation | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"msid": {
"type": "string",
"nullable": true
},
"owners": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"ownerType"
],
"properties": {
"ownerId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"ownerType": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"revenue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
],
"enum": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
]
}
]
},
"status": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"ein": {
"type": "string",
"nullable": true
},
"contacts": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"agencyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"batchId": {
"type": "string",
"nullable": true
}
}
}
]
}
Internal model excluded from public docs
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | InternalAccountInfo | false | none | Internal model excluded from public docs |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » id | integer(int32) | false | none | none |
| » agencyId | integer(int32)|null | false | none | none |
| » createdDateTime | string(date-time) | false | none | none |
| » updatedDateTime | string(date-time)|null | false | none | none |
| » batchId | string|null | false | none | none |
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"msid": {
"type": "string",
"nullable": true
},
"owners": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"ownerType"
],
"properties": {
"ownerId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"ownerType": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"revenue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
],
"enum": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
]
}
]
},
"status": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"ein": {
"type": "string",
"nullable": true
},
"contacts": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
]
}
Internal model excluded from public docs
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | AccountInfo | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
| » msid | string|null | false | none | none |
| » owners | [AccountOwner]|null | false | none | none |
| » description | string|null | false | none | none |
| » revenue | RevenueRange|null | false | none | none |
| » status | AccountStatus|null | false | none | none |
| » ein | string|null | false | none | none |
| » contacts | [AccountContact]|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"ownerType"
],
"properties": {
"ownerId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"ownerType": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ownerId | integer(int32) | false | none | none |
| ownerType | string | true | none | none |
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
],
"enum": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | From0To1M |
| anonymous | From1MTo10M |
| anonymous | From10MTo50M |
| anonymous | From50MTo100M |
| anonymous | From100MTo200M |
| anonymous | From200MTo1B |
| anonymous | MoreThan1B |
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
| Property | Value |
|---|---|
| anonymous | Unknown |
| anonymous | Active |
| anonymous | Inactive |
| anonymous | Dead |
| anonymous | Test |
{
"type": "object",
"additionalProperties": false,
"properties": {
"sourceAccount": {
"nullable": true,
"oneOf": [
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"msid": {
"type": "string",
"nullable": true
},
"owners": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"ownerType"
],
"properties": {
"ownerId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"ownerType": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"revenue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
],
"enum": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
]
}
]
},
"status": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"ein": {
"type": "string",
"nullable": true
},
"contacts": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"agencyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"batchId": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"targetAccount": {
"nullable": true,
"oneOf": [
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"msid": {
"type": "string",
"nullable": true
},
"owners": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"ownerType"
],
"properties": {
"ownerId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"ownerType": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"revenue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
],
"enum": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
]
}
]
},
"status": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"ein": {
"type": "string",
"nullable": true
},
"contacts": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"agencyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"batchId": {
"type": "string",
"nullable": true
}
}
}
]
}
]
},
"evidence": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"rule": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"decision": {
"type": "string",
"description": "",
"x-enumNames": [
"NoConfidenceMatch",
"LowConfidenceMatch",
"MediumConfidenceMatch",
"HighConfidenceMatch"
],
"enum": [
"NoConfidenceMatch",
"LowConfidenceMatch",
"MediumConfidenceMatch",
"HighConfidenceMatch"
]
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sourceAccount | InternalAccount|null | false | none | Internal model excluded from public docs |
| targetAccount | InternalAccount|null | false | none | Internal model excluded from public docs |
| evidence | [DeduplicationReason]|null | false | none | none |
| decision | Decision | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"rule": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| rule | string | false | none | none |
| description | string | 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": {
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"description": "Internal model excluded from public docs",
"nullable": true,
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"isArchived": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"url": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"numberOfEmployees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"numberOfRetirees": {
"type": "integer",
"format": "int32",
"nullable": true
},
"yearFounded": {
"type": "integer",
"format": "int32",
"nullable": true
},
"industryData": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"classification": {
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
],
"enum": [
"Unknown",
"NAICS",
"SIC",
"UKSIC",
"ISO",
"WCCode"
]
},
"code": {
"type": "string",
"minLength": 1
}
}
}
},
"classification": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Personal",
"Commercial"
],
"enum": [
"Personal",
"Commercial"
]
}
]
},
"relationships": {
"type": "array",
"deprecated": true,
"x-deprecatedMessage": "Use LinesOfBusiness instead",
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
],
"enum": [
"BenefitProspect",
"BenefitClient",
"PcProspect",
"PcClient"
]
}
},
"clientSize": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
],
"enum": [
"From0To25",
"From26To50",
"From51To99",
"From100To499",
"From500To999",
"From1000To2499",
"From2500To4999",
"MoreThan4999"
]
}
]
},
"isActive": {
"type": "boolean",
"default": true
},
"addresses": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"groups": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"labels": {
"type": "array",
"nullable": true,
"items": {
"type": "integer",
"format": "int32"
}
},
"linesOfBusiness": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"relationship"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"relationship": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"msid": {
"type": "string",
"nullable": true
},
"owners": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"ownerType"
],
"properties": {
"ownerId": {
"type": "integer",
"format": "int32",
"maximum": 2147483647,
"minimum": 1
},
"ownerType": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
}
},
"description": {
"type": "string",
"nullable": true
},
"revenue": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
],
"enum": [
"None",
"From0To1M",
"From1MTo10M",
"From10MTo50M",
"From50MTo100M",
"From100MTo200M",
"From200MTo1B",
"MoreThan1B"
]
}
]
},
"status": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
],
"enum": [
"Unknown",
"Active",
"Inactive",
"Dead",
"Test"
]
}
]
},
"ein": {
"type": "string",
"nullable": true
},
"contacts": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"birthDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Male",
"Female"
],
"enum": [
"Male",
"Female"
]
}
]
},
"maritalStatus": {
"nullable": true,
"oneOf": [
{
"type": "string",
"description": "",
"x-enumNames": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
],
"enum": [
"Single",
"Married",
"Separated",
"Divorced",
"Widowed",
"DomesticPartner",
"CivilUnion",
"Fiancee",
"Other"
]
}
]
},
"contactConsentExpirationDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentStartDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactConsentOrigin": {
"type": "string",
"nullable": true
},
"contactConsentSource": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"emailAddress": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"firstName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"isEmailAllowed": {
"type": "boolean"
},
"isPrimaryContact": {
"type": "boolean"
},
"lastName": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"salutation": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"title": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"linesOfBusiness": {
"type": "array",
"maxItems": 50,
"nullable": true,
"items": {
"type": "string",
"description": "",
"x-enumNames": [
"Benefits",
"PC",
"PersonalLines"
],
"enum": [
"Benefits",
"PC",
"PersonalLines"
]
}
},
"addresses": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"addressLine1": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine2": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"addressLine3": {
"type": "string",
"maxLength": 100,
"nullable": true
},
"city": {
"type": "string",
"maxLength": 75,
"nullable": true
},
"country": {
"type": "string",
"maxLength": 2,
"nullable": true
},
"county": {
"type": "string",
"maxLength": 150,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"postalCode": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"state": {
"type": "string",
"maxLength": 4,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
],
"enum": [
"None",
"Home",
"Mailing",
"Office",
"Billing",
"Business"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
},
"phones": {
"type": "array",
"maxItems": 10,
"nullable": true,
"items": {
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extension": {
"type": "string",
"maxLength": 10,
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"number": {
"type": "string",
"maxLength": 50,
"nullable": true
},
"type": {
"type": "string",
"description": "",
"x-enumNames": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
],
"enum": [
"None",
"Mobile",
"Work",
"Home",
"Fax"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountContactId": {
"type": "integer",
"format": "int32"
}
}
}
]
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
}
}
]
}
}
}
}
]
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"agencyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdDateTime": {
"type": "string",
"format": "date-time"
},
"updatedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"batchId": {
"type": "string",
"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 | [InternalAccount] | false | none | [Internal model excluded from public docs] |
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"description": "Internal model excluded from public docs",
"nullable": true,
"additionalProperties": false
}
Internal model excluded from public docs
None
{
"type": "object",
"additionalProperties": false,
"properties": {
"operations": {
"type": "array",
"nullable": true,
"items": {
"allOf": [
{
"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
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| operations | [OperationOfInternalAccount]|null | false | none | none |
{
"allOf": [
{
"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
}
}
}
]
},
{
"type": "object",
"additionalProperties": false
}
]
}
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Operation | false | none | none |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | object | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"canView": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"canDelete": {
"type": "boolean"
},
"canCreate": {
"type": "boolean"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| canView | boolean | false | none | none |
| canEdit | boolean | false | none | none |
| canDelete | boolean | false | none | none |
| canCreate | boolean | 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,
"required": [
"accountId",
"externalId"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceName": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"sourceId": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"sourceType": {
"type": "string",
"maxLength": 255,
"nullable": true
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [AccountExternalReference] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"accountId",
"externalId"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32"
},
"externalId": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceName": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"sourceId": {
"type": "string",
"maxLength": 255,
"nullable": true
},
"sourceType": {
"type": "string",
"maxLength": 255,
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| accountId | integer(int32) | true | none | none |
| externalId | string | true | none | none |
| sourceName | string|null | false | none | none |
| sourceId | string|null | false | none | none |
| sourceType | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
},
"year": {
"type": "string"
},
"replacementIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| hasMoreResults | boolean | false | none | none |
| pageIndex | integer(int32) | false | none | none |
| pageSize | integer(int32) | false | none | none |
| skip | integer(int32) | false | none | none |
| take | integer(int32) | false | none | none |
| totalCount | integer(int32) | false | none | none |
| items | [Industry] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"code": {
"type": "string",
"nullable": true
},
"year": {
"type": "string"
},
"replacementIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string | false | none | none |
| code | string|null | false | none | none |
| year | string | false | none | none |
| replacementIds | [integer] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"nullable": true
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | integer(int32) | false | none | none |
| name | string | true | none | none |
| description | string|null | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"hasMoreResults": {
"type": "boolean"
},
"pageIndex": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"skip": {
"type": "integer",
"format": "int32"
},
"take": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"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 | [AccountLabel] | false | none | none |
{
"type": "object",
"additionalProperties": false,
"properties": {
"token": {
"type": "string"
}
}
}
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| token | string | false | none | none |