{ "openapi": "3.0.4", "info": { "title": "MyCRM API", "version": "v1" }, "paths": { "/jsonapi/advisers": { "get": { "tags": [ "Adviser" ], "summary": "Gets a collection of advisers", "operationId": "Advisers_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdvisersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Advisers_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}": { "get": { "tags": [ "Adviser" ], "summary": "Gets a single adviser by id", "description": "Where `id` is the identifier of the adviser", "operationId": "Adviser_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Adviser_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/relationships/contactGroups": { "get": { "tags": [ "Adviser" ], "summary": "Gets a contactGroups related to a single adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelationship_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/adviser-details/{id}/adviser": { "get": { "tags": [ "AdviserDetails" ], "summary": "Gets adviser via a single related adviser detail", "description": "Where `id` is the identifier of the adviser detail", "operationId": "AdviserDetailRelated_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetailRelated_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/adviser-details": { "get": { "tags": [ "AdviserDetails" ], "summary": "Gets a collection of adviser details", "operationId": "AdviserDetails_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDetailsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetails_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/adviser-details/{id}": { "get": { "tags": [ "AdviserDetails" ], "summary": "Gets a single adviser detail by id", "description": "Where `id` is the identifier of the adviser detail", "operationId": "AdviserDetail_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDetailDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetail_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/adviser-details/{id}/relationships/adviser": { "get": { "tags": [ "AdviserDetails" ], "summary": "Gets a adviser related to a single adviser detail", "description": "Where `id` is the identifier of the adviser detail", "operationId": "AdviserDetailRelationship_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AdviserDetails" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserDetailRelationship_Get_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/assets/{id}/relationships/addresses": { "get": { "tags": [ "Assets" ], "summary": "Gets a addresses related to a single asset", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelationship_Get_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Assets" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetRelationship_Get_Head_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/asset-categories": { "get": { "tags": [ "AssetCategories" ], "summary": "Gets a collection of asset categories", "operationId": "AssetCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategories_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/asset-categories/{id}": { "get": { "tags": [ "AssetCategories" ], "summary": "Gets a single asset category by id", "description": "Where `id` is the identifier of the asset category", "operationId": "AssetCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/assets/{id}/addresses": { "get": { "tags": [ "Assets" ], "summary": "Gets addresses via a single related asset", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelated_Get_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/FinancialAddressesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Assets" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetRelated_Head_FinancialAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/assets/{id}/ownership": { "get": { "tags": [ "Assets" ], "summary": "Gets ownerships via a single related asset", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelated_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OwnersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Assets" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetRelated_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/assets": { "get": { "tags": [ "Assets" ], "summary": "Gets a collection of assets", "operationId": "Assets_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Assets" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Assets_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/assets/{id}": { "get": { "tags": [ "Assets" ], "summary": "Gets a single asset by id", "description": "Where `id` is the identifier of the asset", "operationId": "Asset_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Assets" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Asset_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/assets/{id}/relationships/ownership": { "get": { "tags": [ "Assets" ], "summary": "Gets a ownerships related to a single asset", "description": "Where `id` is the identifier of the asset", "operationId": "AssetRelationship_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Assets" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetRelationship_Get_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/referrer": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets referrer via a single related contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelated_Get_ReferrerMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ReferrerMemberDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelated_Head_ReferrerMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/asset-sub-types": { "get": { "tags": [ "AssetSubTypes" ], "summary": "Gets a collection of asset sub-types", "operationId": "AssetSubTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetSubTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubTypes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/asset-sub-types/{id}": { "get": { "tags": [ "AssetSubTypes" ], "summary": "Gets a single asset sub-type by id", "description": "Where `id` is the identifier of the asset sub-type", "operationId": "AssetSubType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetSubTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetSubTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetSubType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/referrerOrganisation": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets referrerOrganisation via a single related contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelated_Get_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ReferrerOrganisationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelated_Head_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/adviser": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets adviser via a single related contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelated_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelated_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/asset-types": { "get": { "tags": [ "AssetTypes" ], "summary": "Gets a collection of asset types", "operationId": "AssetTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetTypes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/asset-types/{id}": { "get": { "tags": [ "AssetTypes" ], "summary": "Gets a single asset type by id", "description": "Where `id` is the identifier of the asset type", "operationId": "AssetType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "AssetTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AssetType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/contacts": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets contacts via a single related contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelated_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelated_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-external-references/{id}/relationships/integration": { "get": { "tags": [ "ContactExternalReferences" ], "summary": "Gets a integration related to a single contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelationship_Get_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactExternalReferenceRelationship_Get_Head_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-categories": { "get": { "tags": [ "ContactCategories" ], "summary": "Gets a collection of contact categories", "operationId": "ContactCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactCategories_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "ContactCategories" ], "summary": "Creates a new contact category with attributes, relationships or both", "operationId": "ContactCategory_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-categories/{id}": { "get": { "tags": [ "ContactCategories" ], "summary": "Gets a single contact category by id", "description": "Where `id` is the identifier of the contact category", "operationId": "ContactCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "ContactCategories" ], "summary": "Updates the attributes and/or relationships of an existing contact category. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact category", "operationId": "ContactCategory_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCategoryDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "ContactCategories" ], "summary": "Deletes an existing contact category", "description": "Where `id` is the identifier of the contact category", "operationId": "ContactCategory_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-external-references/{id}/integration": { "get": { "tags": [ "ContactExternalReferences" ], "summary": "Gets integration via a single related contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelated_Get_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactExternalReferenceRelated_Head_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-external-references/{id}/contact": { "get": { "tags": [ "ContactExternalReferences" ], "summary": "Gets contact via a single related contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelated_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactExternalReferenceRelated_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-external-references": { "get": { "tags": [ "ContactExternalReferences" ], "summary": "Gets a collection of external references of contacts", "operationId": "ContactExternalReferences_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferencesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactExternalReferences_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "ContactExternalReferences" ], "summary": "Creates a new contact external reference with attributes, relationships or both", "operationId": "ContactExternalReference_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-external-references/{id}": { "get": { "tags": [ "ContactExternalReferences" ], "summary": "Gets a single contact external reference by id", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactExternalReference_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "ContactExternalReferences" ], "summary": "Updates the attributes and/or relationships of an existing contact external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferencePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferenceDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "ContactExternalReferences" ], "summary": "Deletes an existing contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReference_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-external-references/{id}/relationships/contact": { "get": { "tags": [ "ContactExternalReferences" ], "summary": "Gets a contact related to a single contact external reference", "description": "Where `id` is the identifier of the contact external reference", "operationId": "ContactExternalReferenceRelationship_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactExternalReferenceRelationship_Get_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/businesses": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets businesses via a single related contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelated_Get_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/BusinessesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelated_Head_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}": { "patch": { "tags": [ "ContactGroups" ], "summary": "Updates the attributes and/or relationships of an existing contact group. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "ContactGroups" ], "summary": "Gets a single contact group by id", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroup_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "ContactGroups" ], "summary": "Deletes an existing contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroup_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets a collection of contact groups", "operationId": "ContactGroups_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroups_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/relationships/businesses": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets a businesses related to a single contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Get_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelationship_Get_Head_Businesses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/contactGroup": { "get": { "tags": [ "Contacts" ], "summary": "Gets contactGroup via a single related contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelated_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelated_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-marketing/{id}": { "patch": { "tags": [ "ContactMarketingConsent" ], "summary": "Updates the marketing consent declaration of an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactMarketing_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactMarketingDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactMarketingDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "ContactMarketingConsent" ], "summary": "Gets the marketing consent declaration of a single contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactMarketing_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactMarketingDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts": { "post": { "tags": [ "Contacts" ], "summary": "Creates a new contact with attributes, relationships or both", "operationId": "Contact_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCreateDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactCreateDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "Contacts" ], "summary": "Gets a collection of contacts", "operationId": "Contacts_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Contacts_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}": { "patch": { "tags": [ "Contacts" ], "summary": "Updates the attributes and/or relationships of an existing contact. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "Contacts" ], "summary": "Gets a single contact by id", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Contact_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Deletes an existing contact", "description": "Where `id` is the identifier of the contact", "operationId": "Contact_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/relationships/contactGroup": { "get": { "tags": [ "Contacts" ], "summary": "Gets a contactGroup related to a single contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelationship_Get_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-external-references/{id}/relationships/integration": { "get": { "tags": [ "DealExternalReferences" ], "summary": "Gets a integration related to a single deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelationship_Get_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealExternalReferenceRelationship_Get_Head_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/custom-statuses": { "get": { "tags": [ "CustomStatuses" ], "summary": "Gets a collection of custom statuses", "operationId": "CustomStatuses_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "CustomStatuses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "CustomStatuses_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/custom-statuses/{id}": { "get": { "tags": [ "CustomStatuses" ], "summary": "Gets a single custom status by id", "description": "Where `id` is the identifier of the custom status", "operationId": "CustomStatus_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "CustomStatuses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "CustomStatus_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-external-references/{id}/integration": { "get": { "tags": [ "DealExternalReferences" ], "summary": "Gets integration via a single related deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelated_Get_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealExternalReferenceRelated_Head_Integrations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-external-references/{id}/deal": { "get": { "tags": [ "DealExternalReferences" ], "summary": "Gets deal via a single related deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealExternalReferenceRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-external-references": { "get": { "tags": [ "DealExternalReferences" ], "summary": "Gets a collection of external references of deals", "operationId": "DealExternalReferences_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferencesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealExternalReferences_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "DealExternalReferences" ], "summary": "Creates a new deal external reference with attributes, relationships or both", "operationId": "DealExternalReference_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-external-references/{id}": { "get": { "tags": [ "DealExternalReferences" ], "summary": "Gets a single deal external reference by id", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealExternalReference_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "DealExternalReferences" ], "summary": "Updates the attributes and/or relationships of an existing deal external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferencePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferenceDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "DealExternalReferences" ], "summary": "Deletes an existing deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReference_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-external-references/{id}/relationships/deal": { "get": { "tags": [ "DealExternalReferences" ], "summary": "Gets a deal related to a single deal external reference", "description": "Where `id` is the identifier of the deal external reference", "operationId": "DealExternalReferenceRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealExternalReferences" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealExternalReferenceRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-notes/{id}/deal": { "get": { "tags": [ "DealNotes" ], "summary": "Gets deal via a single related deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealNotes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealNoteRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-notes": { "post": { "tags": [ "DealNotes" ], "summary": "Creates a new deal note with attributes, relationships or both", "operationId": "DealNote_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-notes/{id}": { "patch": { "tags": [ "DealNotes" ], "summary": "Updates the attributes and/or relationships of an existing deal note. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNotePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "DealNotes" ], "summary": "Gets a single deal note by id", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNoteDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealNotes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealNote_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "DealNotes" ], "summary": "Deletes an existing deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNote_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-notes/{id}/relationships/deal": { "get": { "tags": [ "DealNotes" ], "summary": "Gets a deal related to a single deal note", "description": "Where `id` is the identifier of the deal note", "operationId": "DealNoteRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealNotes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealNoteRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-participants/{id}/contact": { "get": { "tags": [ "DealParticipants" ], "summary": "Gets contact via a single related participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelated_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealParticipants" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealParticipantRelated_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-participants": { "get": { "tags": [ "DealParticipants" ], "summary": "Gets a collection of participants in deals", "operationId": "DealParticipants_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealParticipants" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealParticipants_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-participants/{id}": { "get": { "tags": [ "DealParticipants" ], "summary": "Gets a single participants in a deal by id", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipant_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealParticipants" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealParticipant_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-participants/{id}/relationships/contact": { "get": { "tags": [ "DealParticipants" ], "summary": "Gets a contact related to a single participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelationship_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealParticipants" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealParticipantRelationship_Get_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/customStatus": { "get": { "tags": [ "Deals" ], "summary": "Gets customStatus via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}": { "patch": { "tags": [ "Deals" ], "summary": "Updates the attributes and/or relationships of an existing deal. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal", "operationId": "Deal_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "Deals" ], "summary": "Gets a single deal by id", "description": "Where `id` is the identifier of the deal", "operationId": "Deal_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Deal_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals": { "get": { "tags": [ "Deals" ], "summary": "Gets a collection of deals", "operationId": "Deals_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Deals_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/customStatus": { "get": { "tags": [ "Deals" ], "summary": "Gets a customStatus related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}/asset": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets asset via a single related securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelated_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelated_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a collection of securities for deals", "operationId": "DealSecurities_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecuritiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurities_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a single securities for a deal by id", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurity_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecurityDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurity_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}/relationships/asset": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a asset related to a single securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelationship_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelationship_Get_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-structures/{id}/deal": { "get": { "tags": [ "DealStructures" ], "summary": "Gets deal via a single related deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/status": { "put": { "tags": [ "Deals" ], "summary": "Changes the custom status of a deal", "description": "Where `id` is the identifier of the deal. The target `CustomStatusId` must belong to the same org as the deal.", "operationId": "DealStatus_ChangeStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealStatusChangeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealStatusChangeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-structures": { "post": { "tags": [ "DealStructures" ], "summary": "Creates a new deal structure with attributes, relationships or both", "operationId": "DealStructure_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureCreateDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureCreateDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-structures/{id}": { "patch": { "tags": [ "DealStructures" ], "summary": "Updates the attributes and/or relationships of an existing deal structure. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructure_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructurePatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "get": { "tags": [ "DealStructures" ], "summary": "Gets a single deal structure by id", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructure_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructure_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-structures/{id}/relationships/deal": { "get": { "tags": [ "DealStructures" ], "summary": "Gets a deal related to a single deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/incomes/{id}/relationships/ownership": { "get": { "tags": [ "Incomes" ], "summary": "Gets a ownerships related to a single income", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelationship_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Incomes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeRelationship_Get_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/enquiry-sources": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets a collection of enquiry sources", "operationId": "EnquirySources_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EnquirySourcesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySources_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/enquiry-sources/{id}": { "get": { "tags": [ "EnquirySources" ], "summary": "Gets a single enquiry source by id", "description": "Where `id` is the identifier of the enquiry source", "operationId": "EnquirySource_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EnquirySourceDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "EnquirySources" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "EnquirySource_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/incomes/{id}/ownership": { "get": { "tags": [ "Incomes" ], "summary": "Gets ownerships via a single related income", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelated_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OwnersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Incomes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeRelated_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-categories/{id}/expenseTypes": { "get": { "tags": [ "ExpenseCategories" ], "summary": "Gets expenseTypes via a single related expense category", "description": "Where `id` is the identifier of the expense category", "operationId": "ExpenseCategoryRelated_Get_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseCategoryRelated_Head_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-categories": { "get": { "tags": [ "ExpenseCategories" ], "summary": "Gets a collection of expense categories", "operationId": "ExpenseCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseCategories_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-categories/{id}": { "get": { "tags": [ "ExpenseCategories" ], "summary": "Gets a single expense category by id", "description": "Where `id` is the identifier of the expense category", "operationId": "ExpenseCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-categories/{id}/relationships/expenseTypes": { "get": { "tags": [ "ExpenseCategories" ], "summary": "Gets a expenseTypes related to a single expense category", "description": "Where `id` is the identifier of the expense category", "operationId": "ExpenseCategoryRelationship_Get_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseCategoryRelationship_Get_Head_ExpenseTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expenses/{id}/ownership": { "get": { "tags": [ "Expenses" ], "summary": "Gets ownerships via a single related expense", "description": "Where `id` is the identifier of the expense", "operationId": "ExpenseRelated_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OwnersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Expenses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseRelated_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expenses": { "get": { "tags": [ "Expenses" ], "summary": "Gets a collection of expenses", "operationId": "Expenses_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpensesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Expenses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Expenses_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expenses/{id}": { "get": { "tags": [ "Expenses" ], "summary": "Gets a single expense by id", "description": "Where `id` is the identifier of the expense", "operationId": "Expense_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Expenses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Expense_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expenses/{id}/relationships/ownership": { "get": { "tags": [ "Expenses" ], "summary": "Gets a ownerships related to a single expense", "description": "Where `id` is the identifier of the expense", "operationId": "ExpenseRelationship_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Expenses" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseRelationship_Get_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-types/{id}/expenseCategory": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Gets expenseCategory via a single related expense type", "description": "Where `id` is the identifier of the expense type", "operationId": "ExpenseTypeRelated_Get_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseTypeRelated_Head_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-types": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Gets a collection of expense types", "operationId": "ExpenseTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseTypes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-types/{id}": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Gets a single expense type by id", "description": "Where `id` is the identifier of the expense type", "operationId": "ExpenseType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ExpenseTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/expense-types/{id}/relationships/expenseCategory": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Gets a expenseCategory related to a single expense type", "description": "Where `id` is the identifier of the expense type", "operationId": "ExpenseTypeRelationship_Get_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ExpenseTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ExpenseTypeRelationship_Get_Head_ExpenseCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-categories/{id}/incomeTypes": { "get": { "tags": [ "IncomeCategories" ], "summary": "Gets incomeTypes via a single related income category", "description": "Where `id` is the identifier of the income category", "operationId": "IncomeCategoryRelated_Get_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeCategoryRelated_Head_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-categories": { "get": { "tags": [ "IncomeCategories" ], "summary": "Gets a collection of income categories", "operationId": "IncomeCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeCategories_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-categories/{id}": { "get": { "tags": [ "IncomeCategories" ], "summary": "Gets a single income category by id", "description": "Where `id` is the identifier of the income category", "operationId": "IncomeCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-categories/{id}/relationships/incomeTypes": { "get": { "tags": [ "IncomeCategories" ], "summary": "Gets a incomeTypes related to a single income category", "description": "Where `id` is the identifier of the income category", "operationId": "IncomeCategoryRelationship_Get_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeCategoryRelationship_Get_Head_IncomeTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/incomes/{id}/linkedAsset": { "get": { "tags": [ "Incomes" ], "summary": "Gets linkedAsset via a single related income", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelated_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Incomes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeRelated_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/incomes": { "get": { "tags": [ "Incomes" ], "summary": "Gets a collection of incomes", "operationId": "Incomes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Incomes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Incomes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/incomes/{id}": { "get": { "tags": [ "Incomes" ], "summary": "Gets a single income by id", "description": "Where `id` is the identifier of the income", "operationId": "Income_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Incomes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Income_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/incomes/{id}/relationships/linkedAsset": { "get": { "tags": [ "Incomes" ], "summary": "Gets a linkedAsset related to a single income", "description": "Where `id` is the identifier of the income", "operationId": "IncomeRelationship_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Incomes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeRelationship_Get_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-types/{id}/incomeCategory": { "get": { "tags": [ "IncomeTypes" ], "summary": "Gets incomeCategory via a single related income type", "description": "Where `id` is the identifier of the income type", "operationId": "IncomeTypeRelated_Get_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeTypeRelated_Head_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-types": { "get": { "tags": [ "IncomeTypes" ], "summary": "Gets a collection of income types", "operationId": "IncomeTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeTypes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-types/{id}": { "get": { "tags": [ "IncomeTypes" ], "summary": "Gets a single income type by id", "description": "Where `id` is the identifier of the income type", "operationId": "IncomeType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IncomeTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/income-types/{id}/relationships/incomeCategory": { "get": { "tags": [ "IncomeTypes" ], "summary": "Gets a incomeCategory related to a single income type", "description": "Where `id` is the identifier of the income type", "operationId": "IncomeTypeRelationship_Get_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "IncomeTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IncomeTypeRelationship_Get_Head_IncomeCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/integrations/{id}/contactExternalReferences": { "get": { "tags": [ "Integrations" ], "summary": "Gets contactExternalReferences via a single related integration", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelated_Get_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferencesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Integrations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IntegrationRelated_Head_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/integrations": { "get": { "tags": [ "Integrations" ], "summary": "Gets a collection of integrations", "operationId": "Integrations_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Integrations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Integrations_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "post": { "tags": [ "Integrations" ], "summary": "Creates a new integration with attributes, relationships or both", "operationId": "Integration_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/integrations/{id}": { "get": { "tags": [ "Integrations" ], "summary": "Gets a single integration by id", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Integrations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Integration_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "Integrations" ], "summary": "Updates the attributes and/or relationships of an existing integration. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationPatchDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/IntegrationDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "delete": { "tags": [ "Integrations" ], "summary": "Deletes an existing integration", "description": "Where `id` is the identifier of the integration", "operationId": "Integration_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/integrations/{id}/relationships/contactExternalReferences": { "get": { "tags": [ "Integrations" ], "summary": "Gets a contactExternalReferences related to a single integration", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelationship_Get_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Integrations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IntegrationRelationship_Get_Head_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liabilities/{id}/linkedAsset": { "get": { "tags": [ "Liabilities" ], "summary": "Gets linkedAsset via a single related liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelated_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Liabilities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityRelated_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/leads": { "post": { "tags": [ "Leads" ], "summary": "Creates a lead, including contact and deal attributes", "operationId": "Lead_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LeadDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LeadDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/leads/{id}": { "get": { "tags": [ "Leads" ], "summary": "Gets select details if an existing lead", "description": "Where `id` is the identifier of the lead", "operationId": "Lead_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LeadDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liabilities": { "get": { "tags": [ "Liabilities" ], "summary": "Gets a collection of liabilities", "operationId": "Liabilities_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilitiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Liabilities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Liabilities_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liabilities/{id}": { "get": { "tags": [ "Liabilities" ], "summary": "Gets a single liabilities by id", "description": "Where `id` is the identifier of the liabilities", "operationId": "Liability_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Liabilities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Liability_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liabilities/{id}/relationships/linkedAsset": { "get": { "tags": [ "Liabilities" ], "summary": "Gets a linkedAsset related to a single liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelationship_Get_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Liabilities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityRelationship_Get_Head_Assets", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-categories/{id}/liabilityTypes": { "get": { "tags": [ "LiabilityCategories" ], "summary": "Gets liabilityTypes via a single related liability category", "description": "Where `id` is the identifier of the liability category", "operationId": "LiabilityCategoryRelated_Get_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityCategoryRelated_Head_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-categories": { "get": { "tags": [ "LiabilityCategories" ], "summary": "Gets a collection of liability categories", "operationId": "LiabilityCategories_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityCategoriesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityCategories_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-categories/{id}": { "get": { "tags": [ "LiabilityCategories" ], "summary": "Gets a single liability category by id", "description": "Where `id` is the identifier of the liability category", "operationId": "LiabilityCategory_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityCategory_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-categories/{id}/relationships/liabilityTypes": { "get": { "tags": [ "LiabilityCategories" ], "summary": "Gets a liabilityTypes related to a single liability category", "description": "Where `id` is the identifier of the liability category", "operationId": "LiabilityCategoryRelationship_Get_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityCategories" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityCategoryRelationship_Get_Head_LiabilityTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-types/{id}/liabilityCategory": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets liabilityCategory via a single related liability type", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityTypeRelated_Get_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityCategoryDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelated_Head_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-types": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets a collection of liability types", "operationId": "LiabilityTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-types/{id}": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets a single liability type by id", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilityTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-types/{id}/relationships/liabilityCategory": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets a liabilityCategory related to a single liability type", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityTypeRelationship_Get_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelationship_Get_Head_LiabilityCategories", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/organisations/{id}/customStatuses": { "get": { "tags": [ "Organisations" ], "summary": "Gets customStatuses via a single related organisation", "description": "Where `id` is the identifier of the organisation", "operationId": "OrganisationRelated_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CustomStatusesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelated_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/organisations": { "get": { "tags": [ "Organisations" ], "summary": "Gets a collection of organisations", "operationId": "Organisations_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OrganisationsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Organisations_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/organisations/{id}": { "get": { "tags": [ "Organisations" ], "summary": "Gets a single organisation by id", "description": "Where `id` is the identifier of the organisation", "operationId": "Organisation_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OrganisationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Organisation_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/organisations/{id}/relationships/customStatuses": { "get": { "tags": [ "Organisations" ], "summary": "Gets a customStatuses related to a single organisation", "description": "Where `id` is the identifier of the organisation", "operationId": "OrganisationRelationship_Get_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelationship_Get_Head_CustomStatuses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/commercialFinanceDiversifiedDeal": { "get": { "tags": [ "Tasks" ], "summary": "Gets commercialFinanceDiversifiedDeal via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/CommercialDealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/property-types": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets a collection of property types", "operationId": "PropertyTypes_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PropertyTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyTypes_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/property-types/{id}": { "get": { "tags": [ "PropertyTypes" ], "summary": "Gets a single property type by id", "description": "Where `id` is the identifier of the property type", "operationId": "PropertyType_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PropertyTypeDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "PropertyTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "PropertyType_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/assetFinanceDiversifiedDeal": { "get": { "tags": [ "Tasks" ], "summary": "Gets assetFinanceDiversifiedDeal via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AssetDealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/contactGroups": { "get": { "tags": [ "Tasks" ], "summary": "Gets contactGroups via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/referrers": { "get": { "tags": [ "Referrers" ], "summary": "Gets a collection of referrers", "operationId": "Referrers_Get", "parameters": [ { "name": "filter", "in": "query", "style": "form", "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sort", "in": "query", "style": "form", "explode": false, "allowReserved": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "page", "in": "query", "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/Pagination" } }, { "name": "include", "in": "query", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ReferrersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Referrers_Head", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/referrers/{id}": { "get": { "tags": [ "Referrers" ], "summary": "Gets a single referrer by id", "description": "Where `id` is the identifier of the referrer", "operationId": "Referrer_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ReferrerDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Referrers" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "Referrer_Head", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/residentialDeal": { "get": { "tags": [ "Tasks" ], "summary": "Gets residentialDeal via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/assignee": { "get": { "tags": [ "Tasks" ], "summary": "Gets assignee via a single related task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelated_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelated_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/structured-leads": { "post": { "tags": [ "StructuredLeads" ], "summary": "Creates a structured lead, including contact and deal attributes", "operationId": "StructuredLead_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/StructuredLeadDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/StructuredLeadDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/structured-leads/{id}": { "get": { "tags": [ "StructuredLeads" ], "summary": "Gets select details of an existing lead", "description": "Where `id` is the identifier of the lead", "operationId": "StructuredLead_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/StructuredLeadDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}": { "get": { "tags": [ "Tasks" ], "summary": "Gets a single task by id", "description": "Where `id` is the identifier of the task", "operationId": "Task_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "patch": { "tags": [ "Tasks" ], "summary": "Updates the attributes and/or relationships of an existing task", "description": "Where `id` is the identifier of the task. Only the values of sent attributes/relationships are replaced.", "operationId": "Task_Patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "204": { "description": "" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks": { "post": { "tags": [ "Tasks" ], "summary": "Creates a new task", "operationId": "Task_Post", "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "responses": { "201": { "description": "", "headers": { "Location": { "description": "Location of newly created resource", "schema": { "type": "string" } } }, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/relationships/assignee": { "get": { "tags": [ "Tasks" ], "summary": "Gets a assignee related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/contactGroups": { "get": { "tags": [ "Adviser" ], "summary": "Gets contactGroups via a single related adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelated_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactGroupsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/adviserDetails": { "get": { "tags": [ "Adviser" ], "summary": "Gets adviserDetail via a single related adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelated_Get_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDetailDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/organisation": { "get": { "tags": [ "Adviser" ], "summary": "Gets organisation via a single related adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelated_Get_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OrganisationDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/agreementHolders": { "get": { "tags": [ "Adviser" ], "summary": "Gets agreementHolders via a single related adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelated_Get_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AgreementHoldersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/addresses": { "get": { "tags": [ "Adviser" ], "summary": "Gets addresses via a single related adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelated_Get_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserAddressesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelated_Head_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/relationships/adviserDetails": { "get": { "tags": [ "Adviser" ], "summary": "Gets a adviserDetail related to a single adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelationship_Get_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_AdviserDetails", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/relationships/organisation": { "get": { "tags": [ "Adviser" ], "summary": "Gets a organisation related to a single adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelationship_Get_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_Organisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/relationships/agreementHolders": { "get": { "tags": [ "Adviser" ], "summary": "Gets a agreementHolders related to a single adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelationship_Get_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_AgreementHolders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/advisers/{id}/relationships/addresses": { "get": { "tags": [ "Adviser" ], "summary": "Gets a addresses related to a single adviser", "description": "Where `id` is the identifier of the adviser", "operationId": "AdviserRelationship_Get_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Adviser" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "AdviserRelationship_Get_Head_AdviserAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/relationships/contacts": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets a contacts related to a single contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelationship_Get_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/relationships/adviser": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets a adviser related to a single contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelationship_Get_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/relationships/referrerOrganisation": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets a referrerOrganisation related to a single contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Get_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelationship_Get_Head_ReferrerOrganisations", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contact-groups/{id}/relationships/referrer": { "get": { "tags": [ "ContactGroups" ], "summary": "Gets a referrer related to a single contact group", "description": "Where `id` is the identifier of the contact group", "operationId": "ContactGroupRelationship_Get_ReferrerMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "ContactGroups" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactGroupRelationship_Get_Head_ReferrerMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/ownership": { "get": { "tags": [ "Contacts" ], "summary": "Gets ownerships via a single related contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelated_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OwnersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelated_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/externalReferences": { "get": { "tags": [ "Contacts" ], "summary": "Gets externalReferences via a single related contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelated_Get_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactExternalReferencesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelated_Head_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/deals": { "get": { "tags": [ "Contacts" ], "summary": "Gets deals via a single related contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelated_Get_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelated_Head_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/contactAddress": { "get": { "tags": [ "Contacts" ], "summary": "Gets contactAddresses via a single related contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelated_Get_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactAddressesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelated_Head_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/relationships/ownership": { "get": { "tags": [ "Contacts" ], "summary": "Gets a ownerships related to a single contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelationship_Get_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/relationships/externalReferences": { "get": { "tags": [ "Contacts" ], "summary": "Gets a externalReferences related to a single contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Get_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelationship_Get_Head_ContactExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/relationships/deals": { "get": { "tags": [ "Contacts" ], "summary": "Gets a deals related to a single contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Get_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelationship_Get_Head_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/contacts/{id}/relationships/contactAddress": { "get": { "tags": [ "Contacts" ], "summary": "Gets a contactAddresses related to a single contact", "description": "Where `id` is the identifier of the contact", "operationId": "ContactRelationship_Get_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Contacts" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "ContactRelationship_Get_Head_ContactAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-participants/{id}/deal": { "get": { "tags": [ "DealParticipants" ], "summary": "Gets deal via a single related participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelated_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealParticipants" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealParticipantRelated_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-participants/{id}/relationships/deal": { "get": { "tags": [ "DealParticipants" ], "summary": "Gets a deal related to a single participants in a deal", "description": "Where `id` is the identifier of the participants in a deal", "operationId": "DealParticipantRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealParticipants" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealParticipantRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/dealScenario": { "get": { "tags": [ "Deals" ], "summary": "Gets dealScenario via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealScenarioDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/importantDates": { "get": { "tags": [ "Deals" ], "summary": "Gets importantDates via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealImportantDatesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/participants": { "get": { "tags": [ "Deals" ], "summary": "Gets participants via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealParticipantsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/externalReferences": { "get": { "tags": [ "Deals" ], "summary": "Gets externalReferences via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferencesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/contacts": { "get": { "tags": [ "Deals" ], "summary": "Gets contacts via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ContactsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/dealStructures": { "get": { "tags": [ "Deals" ], "summary": "Gets dealStructures via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructuresDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/adviser": { "get": { "tags": [ "Deals" ], "summary": "Gets adviser via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/AdviserDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/dealNotes": { "get": { "tags": [ "Deals" ], "summary": "Gets dealNotes via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealNotesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/loanSecurities": { "get": { "tags": [ "Deals" ], "summary": "Gets loanSecurities via a single related deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelated_Get_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecuritiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelated_Head_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/dealScenario": { "get": { "tags": [ "Deals" ], "summary": "Gets a dealScenario related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealScenarios", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/importantDates": { "get": { "tags": [ "Deals" ], "summary": "Gets a importantDates related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/participants": { "get": { "tags": [ "Deals" ], "summary": "Gets a participants related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealParticipants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/externalReferences": { "get": { "tags": [ "Deals" ], "summary": "Gets a externalReferences related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/contacts": { "get": { "tags": [ "Deals" ], "summary": "Gets a contacts related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_Contacts", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/dealStructures": { "get": { "tags": [ "Deals" ], "summary": "Gets a dealStructures related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealStructures", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/adviser": { "get": { "tags": [ "Deals" ], "summary": "Gets a adviser related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_Advisers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/dealNotes": { "get": { "tags": [ "Deals" ], "summary": "Gets a dealNotes related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealNotes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deals/{id}/relationships/loanSecurities": { "get": { "tags": [ "Deals" ], "summary": "Gets a loanSecurities related to a single deal", "description": "Where `id` is the identifier of the deal", "operationId": "DealRelationship_Get_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Deals" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealRelationship_Get_Head_DealSecurities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}/titleIdentifications": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets titleIdentifications via a single related securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelated_Get_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecurityTitleIdentitiesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelated_Head_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}/ownership": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets ownerships via a single related securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelated_Get_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealSecurityOwnershipsDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelated_Head_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}/relationships/titleIdentifications": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a titleIdentifications related to a single securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelationship_Get_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelationship_Get_Head_DealSecurityTitleIdentities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-securities/{id}/relationships/ownership": { "get": { "tags": [ "DealSecurities" ], "summary": "Gets a ownerships related to a single securities for a deal", "description": "Where `id` is the identifier of the securities for a deal", "operationId": "DealSecurityRelationship_Get_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealSecurities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealSecurityRelationship_Get_Head_DealSecurityOwnerships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-structures/{id}/dealImportantDates": { "get": { "tags": [ "DealStructures" ], "summary": "Gets dealImportantDates via a single related deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelated_Get_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealStructureImportantDatesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelated_Head_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/deal-structures/{id}/relationships/dealImportantDates": { "get": { "tags": [ "DealStructures" ], "summary": "Gets a dealImportantDates related to a single deal structure", "description": "Where `id` is the identifier of the deal structure", "operationId": "DealStructureRelationship_Get_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "DealStructures" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "DealStructureRelationship_Get_Head_DealStructureImportantDates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/integrations/{id}/dealExternalReferences": { "get": { "tags": [ "Integrations" ], "summary": "Gets dealExternalReferences via a single related integration", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelated_Get_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DealExternalReferencesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Integrations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IntegrationRelated_Head_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/integrations/{id}/relationships/dealExternalReferences": { "get": { "tags": [ "Integrations" ], "summary": "Gets a dealExternalReferences related to a single integration", "description": "Where `id` is the identifier of the integration", "operationId": "IntegrationRelationship_Get_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Integrations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "IntegrationRelationship_Get_Head_DealExternalReferences", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liabilities/{id}/ownership": { "get": { "tags": [ "Liabilities" ], "summary": "Gets ownerships via a single related liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelated_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OwnersDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Liabilities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityRelated_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liabilities/{id}/relationships/ownership": { "get": { "tags": [ "Liabilities" ], "summary": "Gets a ownerships related to a single liabilities", "description": "Where `id` is the identifier of the liabilities", "operationId": "LiabilityRelationship_Get_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Liabilities" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityRelationship_Get_Head_Owners", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-types/{id}/liabilitySubTypes": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets liabilitySubTypes via a single related liability type", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityTypeRelated_Get_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/LiabilitySubTypesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelated_Head_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/liability-types/{id}/relationships/liabilitySubTypes": { "get": { "tags": [ "LiabilityTypes" ], "summary": "Gets a liabilitySubTypes related to a single liability type", "description": "Where `id` is the identifier of the liability type", "operationId": "LiabilityTypeRelationship_Get_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "LiabilityTypes" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "LiabilityTypeRelationship_Get_Head_LiabilitySubTypes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/organisations/{id}/addresses": { "get": { "tags": [ "Organisations" ], "summary": "Gets addresses via a single related organisation", "description": "Where `id` is the identifier of the organisation", "operationId": "OrganisationRelated_Get_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/OrganisationAddressesDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelated_Head_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/organisations/{id}/relationships/addresses": { "get": { "tags": [ "Organisations" ], "summary": "Gets a addresses related to a single organisation", "description": "Where `id` is the identifier of the organisation", "operationId": "OrganisationRelationship_Get_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Organisations" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "OrganisationRelationship_Get_Head_OrganisationAddresses", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/relationships/residentialDeal": { "get": { "tags": [ "Tasks" ], "summary": "Gets a residentialDeal related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_Deals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/relationships/contactGroups": { "get": { "tags": [ "Tasks" ], "summary": "Gets a contactGroups related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_ContactGroups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/relationships/assetFinanceDiversifiedDeal": { "get": { "tags": [ "Tasks" ], "summary": "Gets a assetFinanceDiversifiedDeal related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_AssetDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } }, "/jsonapi/tasks/{id}/relationships/commercialFinanceDiversifiedDeal": { "get": { "tags": [ "Tasks" ], "summary": "Gets a commercialFinanceDiversifiedDeal related to a single task", "description": "Where `id` is the identifier of the task", "operationId": "TaskRelationship_Get_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } } }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } }, "head": { "tags": [ "Tasks" ], "summary": "Retrieve headers related to the associated GET request", "description": "", "operationId": "TaskRelationship_Get_Head_CommercialDeals", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "default": { "description": "Errors - common HTTP status codes will include 400, 403, 404 etc.", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ErrorDocument" } } } } } } } }, "components": { "schemas": { "Address": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "postCode": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "suburb": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "streetAddress": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "country": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "formattedAddress": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "addressDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddress" }, "nullable": true }, "state": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AddressType": { "enum": [ "CurrentAddress", "PostalAddress", "PostSettlementAddress", "PreviousAddress", "Other" ], "type": "string", "x-ms-enum": { "name": "AddressType", "modelAsString": true } }, "Adviser": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdvisersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserAddress": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdviserAddressEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserAddressAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserAddressRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserAddressAttributes": { "type": "object", "properties": { "isMailing": { "type": "boolean", "nullable": true, "readOnly": true }, "isBusiness": { "type": "boolean", "nullable": true, "readOnly": true }, "formattedAddress": { "type": "string", "nullable": true, "readOnly": true }, "streetAddress": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "suburb": { "type": "string", "nullable": true, "readOnly": true }, "postCode": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true } } }, "AdviserAddressDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserAddress" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserAddressEntityType": { "enum": [ "adviser-address" ], "type": "string" }, "AdviserAddressRelationships": { "type": "object", "properties": { "adviser": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "AdviserAddressesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdviserAddress" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserAttributes": { "type": "object", "properties": { "googlePlaces": { "type": "string", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "isBrokerWebPublic": { "type": "boolean", "readOnly": true }, "myLeadGenActivationDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "isMyLeadGenActive": { "type": "boolean", "nullable": true, "readOnly": true }, "bio": { "type": "string", "nullable": true, "readOnly": true }, "jobTitle": { "type": "string", "nullable": true, "readOnly": true }, "website": { "type": "string", "nullable": true, "readOnly": true }, "status": { "type": "string", "nullable": true, "readOnly": true }, "email": { "type": "string", "nullable": true, "readOnly": true }, "skype": { "type": "string", "nullable": true, "readOnly": true }, "facebook": { "type": "string", "nullable": true, "readOnly": true }, "linkedIn": { "type": "string", "nullable": true, "readOnly": true }, "twitter": { "type": "string", "nullable": true, "readOnly": true }, "youtubeFeatured": { "type": "string", "nullable": true, "readOnly": true }, "instagram": { "type": "string", "nullable": true, "readOnly": true }, "calendly": { "type": "string", "nullable": true, "readOnly": true }, "myLeadGenerator": { "type": "string", "nullable": true, "readOnly": true }, "profilePhotoHeadShot": { "type": "string", "format": "uri", "nullable": true, "readOnly": true }, "profilePhotoHalfBody": { "type": "string", "format": "uri", "nullable": true, "readOnly": true }, "profilePhotoFullBody": { "type": "string", "format": "uri", "nullable": true, "readOnly": true }, "countryCode": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ], "readOnly": true }, "youtubeChannel": { "type": "string", "nullable": true, "readOnly": true } } }, "AdviserCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdvisersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserCreateRelationships": { "type": "object" }, "AdviserDetail": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdviserDetailsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserDetailAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserDetailRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserDetailAttributes": { "type": "object", "properties": { "gender": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/GenderCode" } ] }, "placeOfBirth": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "middleName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "preferredName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "homePhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "mobilePhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "birthCountry": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "fax": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "workEmail": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "description": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true } } }, "AdviserDetailCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdviserDetailsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserDetailAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserDetailCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserDetailCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserDetailCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserDetailCreateRelationships": { "type": "object" }, "AdviserDetailDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserDetail" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserDetailPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdviserDetailsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserDetailAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserDetailPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserDetailPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserDetailPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserDetailPatchRelationships": { "type": "object" }, "AdviserDetailRelationships": { "type": "object", "properties": { "adviser": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "AdviserDetailsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdviserDetail" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserDetailsEntityType": { "enum": [ "adviser-details" ], "type": "string" }, "AdviserDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Adviser" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AdvisersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AdviserAttributes" }, "relationships": { "$ref": "#/components/schemas/AdviserPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AdviserPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AdviserPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdviserPatchRelationships": { "type": "object" }, "AdviserRelationships": { "type": "object", "properties": { "adviserDetails": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "organisation": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "agreementHolders": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "familyFranchisees": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "addresses": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true }, "contactGroups": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "AdvisersDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Adviser" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AdvisersEntityType": { "enum": [ "advisers" ], "type": "string" }, "AgreementHolder": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AgreementHoldersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AgreementHolderAttributes" }, "relationships": { "$ref": "#/components/schemas/AgreementHolderRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AgreementHolderAttributes": { "type": "object", "properties": { "appointmentEntity": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "employmentType": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "entityType": { "type": "string", "nullable": true, "readOnly": true } } }, "AgreementHolderDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AgreementHolder" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AgreementHolderRelationships": { "type": "object", "properties": { "apiFamilyFranchisees": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "organisation": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } } }, "AgreementHoldersDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementHolder" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AgreementHoldersEntityType": { "enum": [ "agreement-holders" ], "type": "string" }, "ApiAdviserProfile": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "jobTitle": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "bio": { "type": "string", "nullable": true, "readOnly": true }, "adviser": { "$ref": "#/components/schemas/Adviser" } }, "additionalProperties": false }, "ApiClientEntityEmployment": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "business": { "$ref": "#/components/schemas/Business" }, "address": { "$ref": "#/components/schemas/Address" }, "contact": { "$ref": "#/components/schemas/Contact" } }, "additionalProperties": false }, "ApiFamilyFranchisee": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "franchiseeDetails": { "$ref": "#/components/schemas/AgreementHolder" }, "family": { "$ref": "#/components/schemas/Adviser" } }, "additionalProperties": false }, "ApiFamilySocialMedia": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "linkedInUrl": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "facebookUrl": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "googleMyBusinessUrl": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "youtubeUrl": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "twitterUrl": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ApiLoanSecurity": { "required": [ "type", "id" ], "type": "object", "properties": { "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "loanSecurityInfo": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurity" }, "nullable": true } }, "additionalProperties": false }, "Asset": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AssetAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "description": { "type": "string", "nullable": true, "readOnly": true }, "value": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "accountNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "bsb": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "vehicleMake": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "vehicleYear": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "propertyType": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "isRentalIncome": { "type": "boolean", "nullable": true, "readOnly": true }, "isExistingMortgages": { "type": "boolean", "nullable": true, "readOnly": true }, "assetTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "isAccountDetailsKnown": { "type": "boolean", "nullable": true, "readOnly": true }, "institution": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "assetSubType": { "type": "string", "nullable": true, "readOnly": true }, "assetSubTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "assetType": { "type": "string", "nullable": true, "readOnly": true }, "assetCategory": { "type": "string", "nullable": true, "readOnly": true }, "currencyCode": { "type": "string", "nullable": true, "readOnly": true }, "valuationBasis": { "type": "string", "nullable": true, "readOnly": true }, "propertyZoningType": { "type": "string", "nullable": true, "readOnly": true }, "addressPropertyType": { "type": "string", "nullable": true, "readOnly": true }, "assetCategoryId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } }, "AssetCategoriesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetCategoriesEntityType": { "enum": [ "asset-categories" ], "type": "string" }, "AssetCategory": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AssetCategoryAttributes": { "type": "object", "properties": { "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "AssetCategoryDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetCategoryRelationships": { "type": "object" }, "AssetCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AssetCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetCreateRelationships": { "type": "object" }, "AssetDealEntityType": { "enum": [ "asset-deal" ], "type": "string" }, "AssetDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Asset" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AssetPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetPatchRelationships": { "type": "object" }, "AssetRelationships": { "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "addresses": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "AssetSubType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetSubTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetSubTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetSubTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AssetSubTypeAttributes": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "AssetSubTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetSubType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetSubTypeRelationships": { "type": "object" }, "AssetSubTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetSubType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetSubTypesEntityType": { "enum": [ "asset-sub-types" ], "type": "string" }, "AssetType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/AssetTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AssetTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/AssetTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "AssetTypeAttributes": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "AssetTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/AssetType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetTypeRelationships": { "type": "object" }, "AssetTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AssetType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetTypesEntityType": { "enum": [ "asset-types" ], "type": "string" }, "AssetsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "AssetsEntityType": { "enum": [ "assets" ], "type": "string" }, "AuDealRationale": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Business": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/BusinessEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/BusinessAttributes" }, "relationships": { "$ref": "#/components/schemas/BusinessRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "BusinessAttributes": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "name": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "phone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "companyNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "abn": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "acn": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "businessType": { "type": "string", "nullable": true, "readOnly": true }, "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } } }, "BusinessDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Business" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "BusinessEntityType": { "enum": [ "business" ], "type": "string" }, "BusinessRelationships": { "type": "object", "properties": { "contactGroup": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "deals": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "employments": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "BusinessesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Business" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ClientAddressType": { "enum": [ "Current", "Postal", "PostSettlement", "Previous", "Other" ], "type": "string", "x-ms-enum": { "name": "ClientAddressType", "modelAsString": true } }, "CommercialDealEntityType": { "enum": [ "commercial-deal" ], "type": "string" }, "Contact": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactAccessType": { "enum": [ "Other", "LoanParty" ], "type": "string", "x-ms-enum": { "name": "ContactAccessType", "modelAsString": true } }, "ContactAddress": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactAddressEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactAddressAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactAddressRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactAddressAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "addressType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/AddressType" } ] }, "formattedAddress": { "type": "string", "nullable": true, "readOnly": true }, "streetAddress": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "suburb": { "type": "string", "nullable": true, "readOnly": true }, "postCode": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true } } }, "ContactAddressDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactAddress" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactAddressEntityType": { "enum": [ "contact-address" ], "type": "string" }, "ContactAddressRelationships": { "type": "object", "properties": { "contacts": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "ContactAddressesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAddress" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactAttributes": { "type": "object", "properties": { "mobile": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "title": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "middleName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "preferredName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "homePhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "secondaryEmail": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "maritalStatus": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/MaritalStatus" } ] }, "gender": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/GenderCode" } ] }, "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "hasMarketingConsent": { "type": "boolean", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date", "nullable": true }, "isPrimary": { "type": "boolean", "nullable": true }, "role": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ContactRole" } ] }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } } }, "ContactCategoriesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactCategoriesEntityType": { "enum": [ "contact-categories" ], "type": "string" }, "ContactCategory": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactCategoryAttributes": { "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "orderBy": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } }, "ContactCategoryDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactCategoryRelationships": { "type": "object" }, "ContactCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactCreateRelationships": { "type": "object", "properties": { "contactGroup": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "ContactDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Contact" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactExternalReference": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactExternalReferencesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactExternalReferenceAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactExternalReferenceRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactExternalReferenceAttributes": { "type": "object", "properties": { "externalReference": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "ContactExternalReferenceDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactExternalReference" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactExternalReferencePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactExternalReferencesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactExternalReferenceAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactExternalReferencePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactExternalReferencePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactExternalReferencePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactExternalReferencePatchRelationships": { "type": "object" }, "ContactExternalReferenceRelationships": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "contact": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "ContactExternalReferencesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactExternalReference" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactExternalReferencesEntityType": { "enum": [ "contact-external-references" ], "type": "string" }, "ContactGroup": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactGroupsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactGroupAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactGroupRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactGroupAttributes": { "type": "object", "properties": { "enquirySourceCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "reviewMonth": { "type": "integer", "format": "int32", "nullable": true }, "utmSource": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "utmMedium": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "utmTerm": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "utmContent": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "utmCampaign": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "categoriesAllowCreate": { "type": "boolean", "writeOnly": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "sourceAdditionalDetails": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "enquirySourceSystemUrl": { "maxLength": 400, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "enquirySourceReferrerName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "enquirySourceReferrerOrganisationName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "contactType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ContactType" } ] }, "notes": { "type": "string", "nullable": true }, "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "enquirySourceId": { "type": "integer", "format": "int32", "nullable": true }, "enquirySourceCategory": { "type": "string", "nullable": true, "readOnly": true }, "enquirySource": { "type": "string", "nullable": true, "readOnly": true }, "enquirySourceReferrerId": { "type": "string", "nullable": true } } }, "ContactGroupCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactGroupsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactGroupAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactGroupCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactGroupCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactGroupCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactGroupCreateRelationships": { "type": "object" }, "ContactGroupDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactGroup" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactGroupPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactGroupsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactGroupAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactGroupPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactGroupPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactGroupPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactGroupPatchRelationships": { "type": "object" }, "ContactGroupRelationships": { "type": "object", "properties": { "businesses": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "contacts": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "adviser": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "referrerOrganisation": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "referrer": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "ContactGroupsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactGroupsEntityType": { "enum": [ "contact-groups" ], "type": "string" }, "ContactMarketing": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactMarketingEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactMarketingAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactMarketingRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactMarketingAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "hasMarketingConsent": { "type": "boolean", "nullable": true } } }, "ContactMarketingDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactMarketing" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactMarketingEntityType": { "enum": [ "contact-marketing" ], "type": "string" }, "ContactMarketingRelationships": { "type": "object" }, "ContactMarketingsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMarketing" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ContactsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ContactAttributes" }, "relationships": { "$ref": "#/components/schemas/ContactPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ContactPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ContactPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactPatchRelationships": { "type": "object" }, "ContactRelationships": { "type": "object", "properties": { "contactGroup": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "externalReferences": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "deals": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "employments": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true }, "contactAddress": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "ContactRole": { "enum": [ "Adult", "Child", "Other" ], "type": "string", "x-ms-enum": { "name": "ContactRole", "modelAsString": true } }, "ContactType": { "enum": [ "Lead", "Application", "ExistingClient", "ProfessionalPartner", "PreviousClient", "Opportunity", "NewClient" ], "type": "string", "x-ms-enum": { "name": "ContactType", "modelAsString": true } }, "ContactsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ContactsEntityType": { "enum": [ "contacts" ], "type": "string" }, "Coordinate": { "type": "object", "properties": { "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "z": { "type": "number", "format": "double" }, "m": { "type": "number", "format": "double" }, "coordinateValue": { "$ref": "#/components/schemas/Coordinate" }, "isValid": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "CoordinateEqualityComparer": { "type": "object", "additionalProperties": false }, "CoordinateSequence": { "type": "object", "properties": { "dimension": { "type": "integer", "format": "int32", "readOnly": true }, "measures": { "type": "integer", "format": "int32", "readOnly": true }, "spatial": { "type": "integer", "format": "int32", "readOnly": true }, "ordinates": { "$ref": "#/components/schemas/Ordinates" }, "hasZ": { "type": "boolean", "readOnly": true }, "hasM": { "type": "boolean", "readOnly": true }, "zOrdinateIndex": { "type": "integer", "format": "int32", "readOnly": true }, "mOrdinateIndex": { "type": "integer", "format": "int32", "readOnly": true }, "first": { "$ref": "#/components/schemas/Coordinate" }, "last": { "$ref": "#/components/schemas/Coordinate" }, "count": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "CoordinateSequenceFactory": { "type": "object", "properties": { "ordinates": { "$ref": "#/components/schemas/Ordinates" } }, "additionalProperties": false }, "CountryCode": { "enum": [ "NZ", "AU", "ID" ], "type": "string", "x-ms-enum": { "name": "CountryCode", "modelAsString": true } }, "CustomStatus": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/CustomStatusesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/CustomStatusAttributes" }, "relationships": { "$ref": "#/components/schemas/CustomStatusRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "CustomStatusAttributes": { "type": "object", "properties": { "name": { "maxLength": 64, "minLength": 0, "type": "string", "readOnly": true }, "sortOrder": { "type": "integer", "format": "int32", "readOnly": true } } }, "CustomStatusDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/CustomStatus" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "CustomStatusRelationships": { "type": "object" }, "CustomStatusesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomStatus" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "CustomStatusesEntityType": { "enum": [ "custom-statuses" ], "type": "string" }, "Deal": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealAttributes" }, "relationships": { "$ref": "#/components/schemas/DealRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "dates": { "$ref": "#/components/schemas/ImportantDatesSet" }, "totalLoanAmount": { "type": "number", "format": "double", "nullable": true, "readOnly": true }, "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "dealStatus": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SystemStatus" } ], "readOnly": true }, "opportunity": { "$ref": "#/components/schemas/Opportunity" }, "splits": { "type": "array", "items": { "$ref": "#/components/schemas/Split" }, "nullable": true, "readOnly": true }, "lenderName": { "type": "string", "nullable": true, "readOnly": true }, "customStatusName": { "type": "string", "nullable": true, "readOnly": true }, "dealType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/DealType" } ] }, "auRationale": { "$ref": "#/components/schemas/AuDealRationale" }, "nzRationale": { "$ref": "#/components/schemas/NzDealRationale" } } }, "DealCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealAttributes" }, "relationships": { "$ref": "#/components/schemas/DealCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealCreateRelationships": { "type": "object" }, "DealDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Deal" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealExternalReference": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealExternalReferencesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealExternalReferenceAttributes" }, "relationships": { "$ref": "#/components/schemas/DealExternalReferenceRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealExternalReferenceAttributes": { "type": "object", "properties": { "externalReference": { "maxLength": 255, "minLength": 0, "type": "string" } } }, "DealExternalReferenceDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealExternalReference" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealExternalReferencePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealExternalReferencesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealExternalReferenceAttributes" }, "relationships": { "$ref": "#/components/schemas/DealExternalReferencePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealExternalReferencePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealExternalReferencePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealExternalReferencePatchRelationships": { "type": "object" }, "DealExternalReferenceRelationships": { "type": "object", "properties": { "integration": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealExternalReferencesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealExternalReference" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealExternalReferencesEntityType": { "enum": [ "deal-external-references" ], "type": "string" }, "DealImportantDate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealImportantDatesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealImportantDateAttributes" }, "relationships": { "$ref": "#/components/schemas/DealImportantDateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealImportantDateAttributes": { "type": "object", "properties": { "date": { "type": "string", "format": "date", "nullable": true, "readOnly": true }, "dateType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ImportantDate" } ], "readOnly": true } } }, "DealImportantDateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealImportantDate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealImportantDateRelationships": { "type": "object", "properties": { "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealImportantDatesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealImportantDate" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealImportantDatesEntityType": { "enum": [ "deal-important-dates" ], "type": "string" }, "DealNote": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealNotesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealNoteAttributes" }, "relationships": { "$ref": "#/components/schemas/DealNoteRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealNoteAttributes": { "type": "object", "properties": { "writtenBy": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "title": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true } } }, "DealNoteDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealNote" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealNotePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealNotesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealNoteAttributes" }, "relationships": { "$ref": "#/components/schemas/DealNotePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealNotePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealNotePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealNotePatchRelationships": { "type": "object" }, "DealNoteRelationships": { "type": "object", "properties": { "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealNotesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealNote" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealNotesEntityType": { "enum": [ "deal-notes" ], "type": "string" }, "DealParticipant": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealParticipantsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealParticipantAttributes" }, "relationships": { "$ref": "#/components/schemas/DealParticipantRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealParticipantAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "isApplicant": { "type": "boolean", "nullable": true, "readOnly": true }, "isDependent": { "type": "boolean", "nullable": true, "readOnly": true }, "isGuarantor": { "type": "boolean", "nullable": true, "readOnly": true } } }, "DealParticipantCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealParticipantsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealParticipantAttributes" }, "relationships": { "$ref": "#/components/schemas/DealParticipantCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealParticipantCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealParticipantCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealParticipantCreateRelationships": { "type": "object" }, "DealParticipantDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealParticipant" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealParticipantPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealParticipantsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealParticipantAttributes" }, "relationships": { "$ref": "#/components/schemas/DealParticipantPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealParticipantPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealParticipantPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealParticipantPatchRelationships": { "type": "object" }, "DealParticipantRelationships": { "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealParticipantsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealParticipant" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealParticipantsEntityType": { "enum": [ "deal-participants" ], "type": "string" }, "DealPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealAttributes" }, "relationships": { "$ref": "#/components/schemas/DealPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealPatchRelationships": { "type": "object" }, "DealRelationships": { "type": "object", "properties": { "customStatus": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "dealScenario": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "importantDates": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "participants": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "externalReferences": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "dealStructures": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "contacts": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true }, "adviser": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "dealNotes": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "loanSecurities": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "DealScenario": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealScenarioEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealScenarioAttributes" }, "relationships": { "$ref": "#/components/schemas/DealScenarioRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealScenarioAttributes": { "type": "object" }, "DealScenarioDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealScenario" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealScenarioEntityType": { "enum": [ "deal-scenario" ], "type": "string" }, "DealScenarioRelationships": { "type": "object", "properties": { "highLevelSummary": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealScenariosDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealScenario" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecuritiesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurity" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecuritiesEntityType": { "enum": [ "deal-securities" ], "type": "string" }, "DealSecurity": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecuritiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealSecurityAttributes": { "type": "object", "properties": { "contactForAccess": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ContactAccessType" } ], "readOnly": true }, "isPreApproval": { "type": "boolean", "nullable": true }, "contractPrice": { "type": "number", "format": "double", "nullable": true }, "landValue": { "type": "number", "format": "double", "nullable": true }, "currentValue": { "type": "number", "format": "double", "nullable": true }, "contractDate": { "type": "string", "format": "date", "nullable": true }, "licensedRealEstateAgentContract": { "type": "boolean", "nullable": true }, "propertyState": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "isElectronicTransfer": { "type": "boolean", "nullable": true, "readOnly": true }, "titleType": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true, "readOnly": true }, "valuationBasis": { "type": "string", "nullable": true, "readOnly": true }, "propertyType": { "type": "string", "nullable": true, "readOnly": true }, "propertyZoning": { "type": "string", "nullable": true, "readOnly": true }, "propertyHolding": { "type": "string", "nullable": true, "readOnly": true }, "propertyPrimaryPurpose": { "type": "string", "nullable": true, "readOnly": true }, "futureValue": { "type": "number", "format": "double", "nullable": true }, "buildAmount": { "type": "number", "format": "double", "nullable": true }, "propertyStatus": { "type": "string", "nullable": true, "readOnly": true }, "constructionType": { "type": "string", "nullable": true, "readOnly": true }, "constructionCategory": { "type": "string", "nullable": true, "readOnly": true }, "propertyTransaction": { "type": "string", "nullable": true, "readOnly": true }, "securityType": { "type": "string", "nullable": true, "readOnly": true }, "propertySuburb": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "accessFaxNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessFaxAreaCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accessMobileNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessMobileAreaCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accessPhoneNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessPhoneAreaCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accessContactLastName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "isAnnualPropertyTax": { "type": "boolean", "nullable": true, "readOnly": true }, "accessContactFirstName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accessContactTitle": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } } }, "DealSecurityCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecuritiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealSecurityCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityCreateRelationships": { "type": "object" }, "DealSecurityDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurity" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityOwnership": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecurityOwnershipEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityOwnershipAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityOwnershipRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealSecurityOwnershipAttributes": { "type": "object", "properties": { "ownershipPercentage": { "type": "number", "format": "double", "nullable": true, "readOnly": true } } }, "DealSecurityOwnershipDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityOwnership" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityOwnershipEntityType": { "enum": [ "deal-security-ownership" ], "type": "string" }, "DealSecurityOwnershipRelationships": { "type": "object", "properties": { "business": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "contact": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealSecurityOwnershipsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurityOwnership" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecuritiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealSecurityPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityPatchRelationships": { "type": "object" }, "DealSecurityRelationships": { "type": "object", "properties": { "titleIdentifications": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "address": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "asset": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "DealSecurityTitleIdentitiesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealSecurityTitleIdentity" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityTitleIdentity": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealSecurityTitleIdentityEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealSecurityTitleIdentityAttributes" }, "relationships": { "$ref": "#/components/schemas/DealSecurityTitleIdentityRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealSecurityTitleIdentityAttributes": { "type": "object", "properties": { "titleIdentificationType": { "type": "string", "nullable": true, "readOnly": true }, "value": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true } } }, "DealSecurityTitleIdentityDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealSecurityTitleIdentity" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealSecurityTitleIdentityEntityType": { "enum": [ "deal-security-title-identity" ], "type": "string" }, "DealSecurityTitleIdentityRelationships": { "type": "object" }, "DealStatusChangeRequest": { "required": [ "customStatusId" ], "type": "object", "properties": { "customStatusId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DealStatusChangeResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customStatusId": { "type": "integer", "format": "int32" }, "statusName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DealStructure": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealStructuresEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealStructureAttributes" }, "relationships": { "$ref": "#/components/schemas/DealStructureRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealStructureAttributes": { "type": "object", "properties": { "rateTermYears": { "type": "integer", "format": "int32", "nullable": true }, "rateTypePeriodMonths": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "loanStructureType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/LoanStructureType" } ] }, "interestRate": { "type": "number", "format": "double", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "rateType": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "paymentAmount": { "type": "number", "format": "double", "nullable": true }, "accountNumber": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "capitaliseLmi": { "type": "boolean", "nullable": true }, "isLinkRateExpiry": { "type": "boolean", "nullable": true }, "repaymentFrequency": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/FrequencyType" } ] }, "interestOnlyExpiryDate": { "type": "string", "format": "date", "nullable": true, "readOnly": true }, "lmiPremium": { "type": "number", "format": "double", "nullable": true }, "fixedRateExpiryDate": { "type": "string", "format": "date", "nullable": true }, "fixedRateBeginDate": { "type": "string", "format": "date", "nullable": true }, "loanTermYears": { "type": "number", "format": "double", "nullable": true }, "interestOnlyTermYears": { "type": "number", "format": "double", "nullable": true } } }, "DealStructureCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealStructuresEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealStructureAttributes" }, "relationships": { "$ref": "#/components/schemas/DealStructureCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealStructureCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealStructureCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealStructureCreateRelationships": { "type": "object", "properties": { "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealStructureDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealStructure" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealStructureImportantDate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealStructureImportantDatesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealStructureImportantDateAttributes" }, "relationships": { "$ref": "#/components/schemas/DealStructureImportantDateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealStructureImportantDateAttributes": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "nullable": true, "readOnly": true }, "dateType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/LoanStructureImportantDateTypes" } ], "readOnly": true }, "finishDate": { "type": "string", "format": "date", "nullable": true, "readOnly": true } } }, "DealStructureImportantDateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealStructureImportantDate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealStructureImportantDateRelationships": { "type": "object", "properties": { "dealStructure": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } } }, "DealStructureImportantDatesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealStructureImportantDate" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealStructureImportantDatesEntityType": { "enum": [ "deal-structure-important-dates" ], "type": "string" }, "DealStructurePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/DealStructuresEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/DealStructureAttributes" }, "relationships": { "$ref": "#/components/schemas/DealStructurePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "DealStructurePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/DealStructurePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealStructurePatchRelationships": { "type": "object" }, "DealStructureRelationships": { "type": "object", "properties": { "dealImportantDates": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "deal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "DealStructuresDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealStructure" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealStructuresEntityType": { "enum": [ "deal-structures" ], "type": "string" }, "DealType": { "enum": [ "Residential", "Commercial", "SmallBusiness", "AssetFinance", "PersonalLoan", "DepositBond" ], "type": "string", "x-ms-enum": { "name": "DealType", "modelAsString": true } }, "DealsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "DealsEntityType": { "enum": [ "deals" ], "type": "string" }, "Dimension": { "enum": [ "Point", "Curve", "Surface", "Collapse", "Dontcare", "True", "False" ], "type": "string", "x-ms-enum": { "name": "Dimension", "modelAsString": true } }, "ElevationModel": { "type": "object", "properties": { "extent": { "$ref": "#/components/schemas/Envelope" } }, "additionalProperties": false }, "EmployerType": { "enum": [ "Private", "Public" ], "type": "string", "x-ms-enum": { "name": "EmployerType", "modelAsString": true } }, "EmploymentBasis": { "enum": [ "FullTime", "PartTime", "Contract", "Temporary", "Casual" ], "type": "string", "x-ms-enum": { "name": "EmploymentBasis", "modelAsString": true } }, "EmploymentStatus": { "enum": [ "PrimaryEmployment", "SecondaryEmployment", "PreviousEmployment" ], "type": "string", "x-ms-enum": { "name": "EmploymentStatus", "modelAsString": true } }, "EmploymentType": { "enum": [ "PAYG", "SelfEmployed", "Unemployed", "Retired", "HomeDuties", "Student" ], "type": "string", "x-ms-enum": { "name": "EmploymentType", "modelAsString": true } }, "EnquirySource": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/EnquirySourceEntityType" }, "id": { "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/EnquirySourceAttributes" }, "relationships": { "$ref": "#/components/schemas/EnquirySourceRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "EnquirySourceAttributes": { "type": "object", "properties": { "sourceCategoryId": { "type": "integer", "format": "int32", "readOnly": true }, "sourceCategoryName": { "type": "string", "nullable": true, "readOnly": true }, "sourceId": { "type": "integer", "format": "int32", "readOnly": true }, "sourceName": { "type": "string", "nullable": true, "readOnly": true } } }, "EnquirySourceDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/EnquirySource" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "EnquirySourceEntityType": { "enum": [ "enquiry-source" ], "type": "string" }, "EnquirySourceRelationships": { "type": "object" }, "EnquirySourcesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EnquirySource" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "Envelope": { "type": "object", "properties": { "isNull": { "type": "boolean", "readOnly": true }, "width": { "type": "number", "format": "double", "readOnly": true }, "height": { "type": "number", "format": "double", "readOnly": true }, "diameter": { "type": "number", "format": "double", "readOnly": true }, "minX": { "type": "number", "format": "double", "readOnly": true }, "maxX": { "type": "number", "format": "double", "readOnly": true }, "minY": { "type": "number", "format": "double", "readOnly": true }, "maxY": { "type": "number", "format": "double", "readOnly": true }, "area": { "type": "number", "format": "double", "readOnly": true }, "minExtent": { "type": "number", "format": "double", "readOnly": true }, "maxExtent": { "type": "number", "format": "double", "readOnly": true }, "centre": { "$ref": "#/components/schemas/Coordinate" } }, "additionalProperties": false }, "ErrorDocument": { "type": "object", "properties": { "links": { "$ref": "#/components/schemas/TopLevelLinks" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorObject" }, "nullable": true } }, "additionalProperties": false }, "ErrorLinks": { "type": "object", "properties": { "about": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ErrorObject": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "links": { "$ref": "#/components/schemas/ErrorLinks" }, "status": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "source": { "$ref": "#/components/schemas/ErrorSource" }, "meta": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "ErrorSource": { "type": "object", "properties": { "pointer": { "type": "string", "nullable": true }, "parameter": { "type": "string", "nullable": true }, "header": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExistingContactCheck": { "enum": [ "Email", "EmailMobile", "EmailName", "EmailMobileName", "EmailDateOfBirth", "EmailDateOfBirthName" ], "type": "string", "x-ms-enum": { "name": "ExistingContactCheck", "modelAsString": true } }, "Expense": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpensesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "expenseTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "frequency": { "type": "string", "nullable": true, "readOnly": true }, "expenseCategory": { "type": "string", "nullable": true, "readOnly": true }, "expenseType": { "type": "string", "nullable": true, "readOnly": true }, "expenseCategoryId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } }, "ExpenseCategoriesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseCategoriesEntityType": { "enum": [ "expense-categories" ], "type": "string" }, "ExpenseCategory": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseCategoryAttributes": { "type": "object", "properties": { "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "ExpenseCategoryCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCategoryCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseCategoryCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCategoryCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseCategoryCreateRelationships": { "type": "object" }, "ExpenseCategoryDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseCategoryPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCategoryPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseCategoryPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCategoryPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseCategoryPatchRelationships": { "type": "object" }, "ExpenseCategoryRelationships": { "type": "object", "properties": { "expenseTypes": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "ExpenseCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpensesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseCreateRelationships": { "type": "object" }, "ExpenseDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Expense" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpensePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpensesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpensePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpensePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpensePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpensePatchRelationships": { "type": "object" }, "ExpenseRelationships": { "type": "object", "properties": { "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "ExpenseType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseTypeAttributes": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "ExpenseTypeCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseTypeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseTypeCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseTypeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseTypeCreateRelationships": { "type": "object" }, "ExpenseTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseTypePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ExpenseTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ExpenseTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/ExpenseTypePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ExpenseTypePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ExpenseTypePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseTypePatchRelationships": { "type": "object" }, "ExpenseTypeRelationships": { "type": "object", "properties": { "expenseCategory": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } } }, "ExpenseTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpenseTypesEntityType": { "enum": [ "expense-types" ], "type": "string" }, "ExpensesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ExpensesEntityType": { "enum": [ "expenses" ], "type": "string" }, "Financial": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/FinancialsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/FinancialAttributes" }, "relationships": { "$ref": "#/components/schemas/FinancialRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "FinancialAddress": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/FinancialAddressEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/FinancialAddressAttributes" }, "relationships": { "$ref": "#/components/schemas/FinancialAddressRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "FinancialAddressAttributes": { "type": "object", "properties": { "formattedAddress": { "type": "string", "nullable": true, "readOnly": true }, "streetAddress": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "suburb": { "type": "string", "nullable": true, "readOnly": true }, "postCode": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true } } }, "FinancialAddressDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/FinancialAddress" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "FinancialAddressEntityType": { "enum": [ "financial-address" ], "type": "string" }, "FinancialAddressRelationships": { "type": "object" }, "FinancialAddressesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAddress" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "FinancialAttributes": { "type": "object" }, "FinancialDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Financial" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "FinancialRelationships": { "type": "object", "properties": { "expenses": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "addresses": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "clients": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "incomes": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "liabilities": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "assets": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "FinancialsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Financial" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "FinancialsEntityType": { "enum": [ "financials" ], "type": "string" }, "Frequency": { "enum": [ "Yearly", "HalfYearly", "Quarterly", "Monthly", "Fortnightly", "Weekly", "HalfMonthly" ], "type": "string", "x-ms-enum": { "name": "Frequency", "modelAsString": true } }, "FrequencyType": { "enum": [ "Yearly", "HalfYearly", "Quarterly", "Monthly", "Fortnightly", "Weekly", "HalfMonthly" ], "type": "string", "x-ms-enum": { "name": "FrequencyType", "modelAsString": true } }, "Gender": { "enum": [ "Male", "Female", "Undisclosed" ], "type": "string", "x-ms-enum": { "name": "Gender", "modelAsString": true } }, "GenderCode": { "enum": [ "Male", "Female", "Undisclosed" ], "type": "string", "x-ms-enum": { "name": "GenderCode", "modelAsString": true } }, "Geometry": { "type": "object", "properties": { "factory": { "$ref": "#/components/schemas/GeometryFactory" }, "userData": { "nullable": true }, "srid": { "type": "integer", "format": "int32" }, "geometryType": { "type": "string", "nullable": true, "readOnly": true }, "ogcGeometryType": { "$ref": "#/components/schemas/OgcGeometryType" }, "precisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "coordinate": { "$ref": "#/components/schemas/Coordinate" }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Coordinate" }, "nullable": true, "readOnly": true }, "numPoints": { "type": "integer", "format": "int32", "readOnly": true }, "numGeometries": { "type": "integer", "format": "int32", "readOnly": true }, "isSimple": { "type": "boolean", "readOnly": true }, "isValid": { "type": "boolean", "readOnly": true }, "isEmpty": { "type": "boolean", "readOnly": true }, "area": { "type": "number", "format": "double", "readOnly": true }, "length": { "type": "number", "format": "double", "readOnly": true }, "centroid": { "$ref": "#/components/schemas/Point" }, "interiorPoint": { "$ref": "#/components/schemas/Point" }, "pointOnSurface": { "$ref": "#/components/schemas/Point" }, "dimension": { "$ref": "#/components/schemas/Dimension" }, "boundary": { "$ref": "#/components/schemas/Geometry" }, "boundaryDimension": { "$ref": "#/components/schemas/Dimension" }, "envelope": { "$ref": "#/components/schemas/Geometry" }, "envelopeInternal": { "$ref": "#/components/schemas/Envelope" }, "isRectangle": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "GeometryFactory": { "type": "object", "properties": { "precisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "coordinateSequenceFactory": { "$ref": "#/components/schemas/CoordinateSequenceFactory" }, "srid": { "type": "integer", "format": "int32", "readOnly": true }, "elevationModel": { "$ref": "#/components/schemas/ElevationModel" }, "geometryServices": { "$ref": "#/components/schemas/NtsGeometryServices" } }, "additionalProperties": false }, "GeometryOverlay": { "type": "object", "additionalProperties": false }, "GeometryRelate": { "type": "object", "additionalProperties": false }, "HighLevelSummariesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/HighLevelSummary" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "HighLevelSummary": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/HighLevelSummaryEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/HighLevelSummaryAttributes" }, "relationships": { "$ref": "#/components/schemas/HighLevelSummaryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "HighLevelSummaryAttributes": { "type": "object", "properties": { "proposedLoanAmount": { "type": "number", "format": "double", "nullable": true }, "securityAmount": { "type": "number", "format": "double", "nullable": true }, "summaryNotes": { "maxLength": 4000, "minLength": 0, "type": "string", "nullable": true } } }, "HighLevelSummaryDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/HighLevelSummary" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "HighLevelSummaryEntityType": { "enum": [ "high-level-summary" ], "type": "string" }, "HighLevelSummaryRelationships": { "type": "object", "properties": { "dealScenario": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } } }, "ImportantDate": { "enum": [ "Settled", "FinanceClause", "NotProceeding", "Lodged", "PreApproved", "ConditionallyApproved", "Approved", "PreApprovedExpiry", "EstimatedSettled" ], "type": "string", "x-ms-enum": { "name": "ImportantDate", "modelAsString": true } }, "ImportantDatesSet": { "type": "object", "properties": { "settled": { "type": "string", "format": "date", "nullable": true }, "lodged": { "type": "string", "format": "date", "nullable": true }, "financeClause": { "type": "string", "format": "date", "nullable": true }, "notProceeding": { "type": "string", "format": "date", "nullable": true }, "approved": { "type": "string", "format": "date", "nullable": true }, "preApproved": { "type": "string", "format": "date", "nullable": true }, "conditionallyApproved": { "type": "string", "format": "date", "nullable": true }, "preApprovedExpiry": { "type": "string", "format": "date", "nullable": true }, "estimatedSettled": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "IncludedResource": { "required": [ "type" ], "type": "object", "properties": { "type": { "minLength": 1, "type": "string" }, "id": { "type": "string", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "type", "mapping": { "contact-categories": "#/components/schemas/ContactCategory", "contact-address": "#/components/schemas/ContactAddress", "asset-categories": "#/components/schemas/AssetCategory", "asset-types": "#/components/schemas/AssetType", "asset-sub-types": "#/components/schemas/AssetSubType", "liability-categories": "#/components/schemas/LiabilityCategory", "liability-sub-types": "#/components/schemas/LiabilitySubType", "liability-types": "#/components/schemas/LiabilityType", "deal-participants": "#/components/schemas/DealParticipant", "expense-categories": "#/components/schemas/ExpenseCategory", "expense-types": "#/components/schemas/ExpenseType", "expenses": "#/components/schemas/Expense", "deal-structure-important-dates": "#/components/schemas/DealStructureImportantDate", "deal-structures": "#/components/schemas/DealStructure", "income-categories": "#/components/schemas/IncomeCategory", "income-types": "#/components/schemas/IncomeType", "incomes": "#/components/schemas/Income", "deal-security-ownership": "#/components/schemas/DealSecurityOwnership", "business": "#/components/schemas/Business", "owners": "#/components/schemas/Owner", "liabilities": "#/components/schemas/Liability", "deal-important-dates": "#/components/schemas/DealImportantDate", "integrations": "#/components/schemas/Integration", "deal-external-references": "#/components/schemas/DealExternalReference", "adviser-details": "#/components/schemas/AdviserDetail", "agreement-holders": "#/components/schemas/AgreementHolder", "adviser-address": "#/components/schemas/AdviserAddress", "advisers": "#/components/schemas/Adviser", "deal-notes": "#/components/schemas/DealNote", "deals": "#/components/schemas/Deal", "high-level-summary": "#/components/schemas/HighLevelSummary", "deal-scenario": "#/components/schemas/DealScenario", "financial-address": "#/components/schemas/FinancialAddress", "financials": "#/components/schemas/Financial", "property-types": "#/components/schemas/PropertyType", "assets": "#/components/schemas/Asset", "deal-security-title-identity": "#/components/schemas/DealSecurityTitleIdentity", "deal-securities": "#/components/schemas/DealSecurity", "organisation-addresses": "#/components/schemas/OrganisationAddress", "organisations": "#/components/schemas/Organisation", "custom-statuses": "#/components/schemas/CustomStatus", "referrer-members": "#/components/schemas/ReferrerMember", "referrer-organisation": "#/components/schemas/ReferrerOrganisation", "contact-groups": "#/components/schemas/ContactGroup", "contacts": "#/components/schemas/Contact", "contact-external-references": "#/components/schemas/ContactExternalReference", "contact-marketing": "#/components/schemas/ContactMarketing", "leads": "#/components/schemas/Lead", "structured-leads": "#/components/schemas/StructuredLead", "tasks": "#/components/schemas/Task", "enquiry-source": "#/components/schemas/EnquirySource", "referrers": "#/components/schemas/Referrer" } } }, "Income": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "incomeTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "incomeVerification": { "type": "string", "nullable": true, "readOnly": true }, "frequency": { "type": "string", "nullable": true, "readOnly": true }, "incomeCategory": { "type": "string", "nullable": true, "readOnly": true }, "incomeType": { "type": "string", "nullable": true, "readOnly": true }, "incomeCategoryId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } }, "IncomeCategoriesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/IncomeCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeCategoriesEntityType": { "enum": [ "income-categories" ], "type": "string" }, "IncomeCategory": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeCategoryAttributes": { "type": "object", "properties": { "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "IncomeCategoryCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCategoryCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeCategoryCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCategoryCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeCategoryCreateRelationships": { "type": "object" }, "IncomeCategoryDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeCategoryPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCategoryPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeCategoryPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCategoryPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeCategoryPatchRelationships": { "type": "object" }, "IncomeCategoryRelationships": { "type": "object", "properties": { "incomeTypes": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "IncomeCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeCreateRelationships": { "type": "object" }, "IncomeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Income" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomePatchRelationships": { "type": "object" }, "IncomeRelationships": { "type": "object", "properties": { "linkedAsset": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "IncomeType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeTypeAttributes": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "IncomeTypeCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeTypeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeTypeCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeTypeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeTypeCreateRelationships": { "type": "object" }, "IncomeTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeTypePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IncomeTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IncomeTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/IncomeTypePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IncomeTypePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IncomeTypePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeTypePatchRelationships": { "type": "object" }, "IncomeTypeRelationships": { "type": "object", "properties": { "incomeCategory": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } } }, "IncomeTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/IncomeType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomeTypesEntityType": { "enum": [ "income-types" ], "type": "string" }, "IncomeVerificationEnum": { "enum": [ "CurrentPayslips", "CurrentGroupCertificate", "CurrentPersonalTaxReturn", "PreviousYearPersonalTaxReturn", "NoticeOfAssessment", "CurrentCompanyTaxReturn", "PreviousCompanyTaxReturn", "LetterFromEmployer", "EmploymentContract", "BankAccountStatement", "Other" ], "type": "string", "x-ms-enum": { "name": "IncomeVerificationEnum", "modelAsString": true } }, "IncomesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Income" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IncomesEntityType": { "enum": [ "incomes" ], "type": "string" }, "Integration": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IntegrationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IntegrationAttributes" }, "relationships": { "$ref": "#/components/schemas/IntegrationRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IntegrationAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "name": { "maxLength": 100, "minLength": 0, "type": "string" }, "description": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true } } }, "IntegrationCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IntegrationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IntegrationAttributes" }, "relationships": { "$ref": "#/components/schemas/IntegrationCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IntegrationCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IntegrationCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IntegrationCreateRelationships": { "type": "object" }, "IntegrationDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Integration" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IntegrationPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/IntegrationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/IntegrationAttributes" }, "relationships": { "$ref": "#/components/schemas/IntegrationPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "IntegrationPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/IntegrationPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IntegrationPatchRelationships": { "type": "object" }, "IntegrationRelationships": { "type": "object", "properties": { "contactExternalReferences": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "dealExternalReferences": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "IntegrationsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "IntegrationsEntityType": { "enum": [ "integrations" ], "type": "string" }, "InteractiveTaskPriorityDto": { "enum": [ "Critical", "High", "Medium", "Normal" ], "type": "string", "x-ms-enum": { "name": "InteractiveTaskPriorityDto", "modelAsString": true } }, "InteractiveTaskProgressDto": { "enum": [ "Completed", "InProgress", "NotRequired", "NotStarted", "OnHold" ], "type": "string", "x-ms-enum": { "name": "InteractiveTaskProgressDto", "modelAsString": true } }, "Lead": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LeadsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LeadAttributes" }, "relationships": { "$ref": "#/components/schemas/LeadRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LeadAddress": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "formattedAddress": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "streetAddress": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "suburb": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "state": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "postCode": { "maxLength": 4, "minLength": 0, "type": "string", "nullable": true }, "country": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "addressType": { "$ref": "#/components/schemas/ClientAddressType" } }, "additionalProperties": false }, "LeadAddressReference": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "LeadAsset": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "assetTypeId": { "type": "integer", "format": "int32", "nullable": true }, "assetSubTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "institution": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "bsb": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accountNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "vehicleMake": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "vehicleYear": { "type": "integer", "format": "int32", "nullable": true }, "propertyZoningId": { "type": "integer", "format": "int32", "nullable": true }, "propertyTypeId": { "type": "integer", "format": "int32", "nullable": true }, "propertyPrimaryPurpose": { "$ref": "#/components/schemas/PropertyPrimaryPurpose" }, "valueBasis": { "$ref": "#/components/schemas/PropertyValueEstimatedBasis" }, "address": { "$ref": "#/components/schemas/LeadAddressReference" }, "ownership": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContactReference" }, "nullable": true } }, "additionalProperties": false }, "LeadAssetReference": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "LeadAttributes": { "type": "object", "properties": { "categoriesAllowCreate": { "type": "boolean", "writeOnly": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true, "writeOnly": true }, "dateOfBirth": { "type": "string", "format": "date", "nullable": true, "writeOnly": true }, "title": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/Title" } ], "writeOnly": true }, "firstName": { "type": "string", "nullable": true, "writeOnly": true }, "preferredName": { "type": "string", "nullable": true, "writeOnly": true }, "lastName": { "type": "string", "nullable": true, "writeOnly": true }, "email": { "type": "string", "nullable": true, "writeOnly": true }, "mobile": { "type": "string", "nullable": true, "writeOnly": true }, "contactMatchExisting": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ExistingContactCheck" } ], "writeOnly": true }, "gender": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/Gender" } ], "writeOnly": true }, "maritalStatus": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/MaritalStatus" } ], "writeOnly": true }, "hasMarketingConsent": { "type": "boolean", "nullable": true, "writeOnly": true }, "isGuarantor": { "type": "boolean", "nullable": true, "writeOnly": true }, "isDependant": { "type": "boolean", "nullable": true, "writeOnly": true }, "isPrimary": { "type": "boolean", "nullable": true, "writeOnly": true }, "streetAddress": { "type": "string", "nullable": true, "writeOnly": true }, "suburb": { "type": "string", "nullable": true, "writeOnly": true }, "state": { "type": "string", "nullable": true, "writeOnly": true }, "postCode": { "type": "string", "nullable": true, "writeOnly": true }, "country": { "type": "string", "nullable": true, "writeOnly": true }, "addressType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/ClientAddressType" } ], "writeOnly": true }, "formattedAddress": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "dealName": { "type": "string", "nullable": true, "writeOnly": true }, "noteTitle": { "type": "string", "nullable": true, "writeOnly": true }, "noteDetails": { "type": "string", "nullable": true, "writeOnly": true }, "utmSource": { "type": "string", "nullable": true, "writeOnly": true }, "utmMedium": { "type": "string", "nullable": true, "writeOnly": true }, "utmCampaign": { "type": "string", "nullable": true, "writeOnly": true }, "utmTerm": { "type": "string", "nullable": true, "writeOnly": true }, "utmContent": { "type": "string", "nullable": true, "writeOnly": true }, "sourceSystemUrl": { "type": "string", "nullable": true, "writeOnly": true }, "sourceId": { "type": "integer", "format": "int32", "nullable": true, "writeOnly": true }, "sourceCategoryId": { "type": "integer", "format": "int32", "nullable": true, "writeOnly": true }, "sourceReferrerId": { "type": "string", "nullable": true, "writeOnly": true }, "sourceAdditionalDetails": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "externalReference": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "externalIntegration": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "externalIntegrationAllowCreate": { "type": "boolean", "writeOnly": true }, "sendNotification": { "type": "boolean", "writeOnly": true }, "customStatusName": { "type": "string", "nullable": true, "readOnly": true }, "dealStatus": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SystemStatus" } ], "readOnly": true } } }, "LeadContact": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "title": { "$ref": "#/components/schemas/Title" }, "firstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "preferredName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "mobile": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "homePhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "businessPhone": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "dateOfBirthAsString": { "type": "string", "format": "date", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "gender": { "$ref": "#/components/schemas/Gender" }, "maritalStatus": { "$ref": "#/components/schemas/MaritalStatus" }, "hasMarketingConsent": { "type": "boolean", "nullable": true }, "isGuarantor": { "type": "boolean", "nullable": true }, "isDependant": { "type": "boolean", "nullable": true }, "isPrimary": { "type": "boolean", "nullable": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/LeadAddressReference" }, "nullable": true }, "employments": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmploymentReference" }, "nullable": true } }, "additionalProperties": false }, "LeadContactReference": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "LeadDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Lead" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LeadEmployment": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "employmentStatus": { "$ref": "#/components/schemas/EmploymentStatus" }, "employmentType": { "$ref": "#/components/schemas/EmploymentType" }, "dateStartedAsString": { "type": "string", "format": "date", "nullable": true }, "dateStarted": { "type": "string", "format": "date-time", "nullable": true }, "dateEndedAsString": { "type": "string", "format": "date", "nullable": true }, "dateEnded": { "type": "string", "format": "date-time", "nullable": true }, "employmentRoleName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "employmentBasis": { "$ref": "#/components/schemas/EmploymentBasis" }, "isProbation": { "type": "boolean", "nullable": true }, "businessNumber": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "companyNumber": { "maxLength": 80, "minLength": 0, "type": "string", "nullable": true }, "employerName": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "employerContactTitle": { "$ref": "#/components/schemas/Title" }, "employerContactFirstName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "employerContactLastName": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "employerType": { "$ref": "#/components/schemas/EmployerType" }, "employerPhone": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/LeadAddressReference" } }, "additionalProperties": false }, "LeadEmploymentReference": { "required": [ "lid" ], "type": "object", "properties": { "lid": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "LeadExpense": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "expenseTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "frequency": { "$ref": "#/components/schemas/Frequency" }, "ownership": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContactReference" }, "nullable": true } }, "additionalProperties": false }, "LeadIncome": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "incomeTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "frequency": { "$ref": "#/components/schemas/Frequency" }, "incomeVerification": { "$ref": "#/components/schemas/IncomeVerificationEnum" }, "ownership": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContactReference" }, "nullable": true }, "asset": { "$ref": "#/components/schemas/LeadAssetReference" }, "employment": { "$ref": "#/components/schemas/LeadEmploymentReference" } }, "additionalProperties": false }, "LeadLiability": { "type": "object", "properties": { "lid": { "type": "string", "nullable": true }, "liabilityTypeId": { "type": "integer", "format": "int32", "nullable": true }, "liabilitySubTypeId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "bsb": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "accountNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "limit": { "type": "number", "format": "double", "nullable": true }, "repayments": { "type": "number", "format": "double", "nullable": true }, "repaymentFrequency": { "$ref": "#/components/schemas/Frequency" }, "interestRate": { "type": "number", "format": "double", "nullable": true }, "interestTaxDeductible": { "type": "boolean", "nullable": true }, "creditorName": { "maxLength": 250, "minLength": 0, "type": "string", "nullable": true }, "loanTerm": { "type": "integer", "format": "int32", "nullable": true }, "loanRepaymentType": { "$ref": "#/components/schemas/LiabilityRepaymentType" }, "mortgagePriority": { "$ref": "#/components/schemas/MortgagePriority" }, "asset": { "$ref": "#/components/schemas/LeadAssetReference" }, "ownership": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContactReference" }, "nullable": true } }, "additionalProperties": false }, "LeadRelationships": { "type": "object" }, "LeadsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Lead" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LeadsEntityType": { "enum": [ "leads" ], "type": "string" }, "LiabilitiesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Liability" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilitiesEntityType": { "enum": [ "liabilities" ], "type": "string" }, "Liability": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityAttributes": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "repayment": { "type": "number", "format": "double", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "limit": { "type": "number", "format": "double", "nullable": true }, "accountName": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "accountNumber": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true }, "bsb": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "interestTaxDeductible": { "type": "boolean", "nullable": true }, "interestRate": { "type": "number", "format": "double", "nullable": true }, "isAccountDetailsKnown": { "type": "boolean", "nullable": true }, "liabilityTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "loanTerm": { "type": "integer", "format": "int32", "nullable": true }, "liabilitySubTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "repaymentFrequency": { "type": "string", "nullable": true, "readOnly": true }, "liabilityCategory": { "type": "string", "nullable": true, "readOnly": true }, "liabilitySubType": { "type": "string", "nullable": true, "readOnly": true }, "liabilityType": { "type": "string", "nullable": true, "readOnly": true }, "mortgagePriority": { "type": "string", "nullable": true, "readOnly": true }, "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "creditorName": { "type": "string", "nullable": true, "readOnly": true }, "loanRepaymentType": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/LiabilityRepaymentType" } ], "readOnly": true }, "liabilityCategoryId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } }, "LiabilityCategoriesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LiabilityCategory" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityCategoriesEntityType": { "enum": [ "liability-categories" ], "type": "string" }, "LiabilityCategory": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCategoryRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityCategoryAttributes": { "type": "object", "properties": { "description": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "LiabilityCategoryCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCategoryCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityCategoryCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCategoryCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityCategoryCreateRelationships": { "type": "object" }, "LiabilityCategoryDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCategory" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityCategoryPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityCategoriesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityCategoryAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCategoryPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityCategoryPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCategoryPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityCategoryPatchRelationships": { "type": "object" }, "LiabilityCategoryRelationships": { "type": "object", "properties": { "liabilityTypes": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "LiabilityCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityCreateRelationships": { "type": "object" }, "LiabilityDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Liability" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitiesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityPatchRelationships": { "type": "object" }, "LiabilityRelationships": { "type": "object", "properties": { "linkedAsset": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "ownership": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } } }, "LiabilityRepaymentType": { "enum": [ "InterestOnly", "PrincipalInterest" ], "type": "string", "x-ms-enum": { "name": "LiabilityRepaymentType", "modelAsString": true } }, "LiabilitySubType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilitySubTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilitySubTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilitySubTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilitySubTypeAttributes": { "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "LiabilitySubTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilitySubType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilitySubTypeRelationships": { "type": "object" }, "LiabilitySubTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LiabilitySubType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilitySubTypesEntityType": { "enum": [ "liability-sub-types" ], "type": "string" }, "LiabilityType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityTypeAttributes": { "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "nullable": true, "readOnly": true } } }, "LiabilityTypeCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityTypeCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityTypeCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityTypeCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityTypeCreateRelationships": { "type": "object" }, "LiabilityTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityTypePatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/LiabilityTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/LiabilityTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/LiabilityTypePatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "LiabilityTypePatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/LiabilityTypePatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityTypePatchRelationships": { "type": "object" }, "LiabilityTypeRelationships": { "type": "object", "properties": { "liabilityCategory": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "liabilitySubTypes": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "LiabilityTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LiabilityType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "LiabilityTypesEntityType": { "enum": [ "liability-types" ], "type": "string" }, "LoanStructureImportantDateTypes": { "enum": [ "InterestOnly", "RepaymentHoliday" ], "type": "string", "x-ms-enum": { "name": "LoanStructureImportantDateTypes", "modelAsString": true } }, "LoanStructureType": { "enum": [ "PrincipalInterest", "InterestOnly", "RevolvingCredit", "Offset" ], "type": "string", "x-ms-enum": { "name": "LoanStructureType", "modelAsString": true } }, "MaritalStatus": { "enum": [ "Single", "Married", "DeFacto", "Separated", "Divorced", "Widowed" ], "type": "string", "x-ms-enum": { "name": "MaritalStatus", "modelAsString": true } }, "MortgagePriority": { "enum": [ "First", "Second", "Third" ], "type": "string", "x-ms-enum": { "name": "MortgagePriority", "modelAsString": true } }, "NtsGeometryServices": { "type": "object", "properties": { "geometryOverlay": { "$ref": "#/components/schemas/GeometryOverlay" }, "geometryRelate": { "$ref": "#/components/schemas/GeometryRelate" }, "coordinateEqualityComparer": { "$ref": "#/components/schemas/CoordinateEqualityComparer" }, "defaultSRID": { "type": "integer", "format": "int32", "readOnly": true }, "defaultCoordinateSequenceFactory": { "$ref": "#/components/schemas/CoordinateSequenceFactory" }, "defaultPrecisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "defaultElevationModel": { "$ref": "#/components/schemas/ElevationModel" } }, "additionalProperties": false }, "NzDealRationale": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true }, "lenderPreferences": { "type": "string", "nullable": true }, "loanStructure": { "type": "string", "nullable": true }, "productFeatures": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OgcGeometryType": { "enum": [ "Point", "LineString", "Polygon", "MultiPoint", "MultiLineString", "MultiPolygon", "GeometryCollection", "CircularString", "CompoundCurve", "CurvePolygon", "MultiCurve", "MultiSurface", "Curve", "Surface", "PolyhedralSurface", "TIN" ], "type": "string", "x-ms-enum": { "name": "OgcGeometryType", "modelAsString": true } }, "Opportunity": { "type": "object", "properties": { "proposedLoanAmount": { "type": "number", "format": "double", "nullable": true }, "securityAmount": { "type": "number", "format": "double", "nullable": true }, "summaryNotes": { "type": "string", "nullable": true }, "loanPurpose": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Ordinates": { "enum": [ "None", "X", "Y", "XY", "Z", "XYZ", "Spatial4", "Spatial5", "Spatial6", "Spatial7", "Spatial8", "Spatial9", "Spatial10", "Spatial11", "Spatial12", "Spatial13", "Spatial14", "Spatial15", "Spatial16", "AllSpatialOrdinates", "M", "XYM", "XYZM", "Measure2", "Measure3", "Measure4", "Measure5", "Measure6", "Measure7", "Measure8", "Measure9", "Measure10", "Measure11", "Measure12", "Measure13", "Measure14", "Measure15", "Measure16", "AllMeasureOrdinates", "AllOrdinates" ], "type": "string", "x-ms-enum": { "name": "Ordinates", "modelAsString": true } }, "Organisation": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OrganisationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OrganisationAttributes" }, "relationships": { "$ref": "#/components/schemas/OrganisationRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "OrganisationAddress": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OrganisationAddressesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OrganisationAddressAttributes" }, "relationships": { "$ref": "#/components/schemas/OrganisationAddressRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "OrganisationAddressAttributes": { "type": "object", "properties": { "isMailing": { "type": "boolean", "nullable": true }, "isCustomAddress": { "type": "boolean", "nullable": true }, "formattedAddress": { "type": "string", "nullable": true, "readOnly": true }, "streetAddress": { "type": "string", "nullable": true, "readOnly": true }, "country": { "type": "string", "nullable": true, "readOnly": true }, "suburb": { "type": "string", "nullable": true, "readOnly": true }, "postCode": { "type": "string", "nullable": true, "readOnly": true }, "state": { "type": "string", "nullable": true, "readOnly": true } } }, "OrganisationAddressDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/OrganisationAddress" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OrganisationAddressRelationships": { "type": "object" }, "OrganisationAddressesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationAddress" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OrganisationAddressesEntityType": { "enum": [ "organisation-addresses" ], "type": "string" }, "OrganisationAttributes": { "type": "object", "properties": { "brandedCategory": { "type": "string", "nullable": true, "readOnly": true }, "primaryBrandColour": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "name": { "maxLength": 300, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "tradingName": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "website": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "companyEmail": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "isBrokerSearchVisible": { "type": "boolean", "nullable": true, "readOnly": true }, "status": { "type": "string", "nullable": true, "readOnly": true }, "slug": { "type": "string", "nullable": true, "readOnly": true }, "businessNumber": { "type": "string", "nullable": true, "readOnly": true }, "companyNumber": { "type": "string", "nullable": true, "readOnly": true }, "officeDisplayName": { "type": "string", "nullable": true, "readOnly": true }, "emailForCommissions": { "type": "string", "nullable": true, "readOnly": true }, "phone": { "type": "string", "nullable": true, "readOnly": true }, "fax": { "type": "string", "nullable": true, "readOnly": true }, "brandLogoUrl": { "type": "string", "format": "uri", "nullable": true, "readOnly": true } } }, "OrganisationCreate": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OrganisationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OrganisationAttributes" }, "relationships": { "$ref": "#/components/schemas/OrganisationCreateRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "OrganisationCreateDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/OrganisationCreate" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OrganisationCreateRelationships": { "type": "object" }, "OrganisationDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Organisation" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OrganisationPatch": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OrganisationsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OrganisationAttributes" }, "relationships": { "$ref": "#/components/schemas/OrganisationPatchRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "OrganisationPatchDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/OrganisationPatch" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OrganisationPatchRelationships": { "type": "object" }, "OrganisationRelationships": { "type": "object", "properties": { "customStatuses": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "addresses": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "OrganisationsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Organisation" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OrganisationsEntityType": { "enum": [ "organisations" ], "type": "string" }, "Owner": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/OwnersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/OwnerAttributes" }, "relationships": { "$ref": "#/components/schemas/OwnerRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "OwnerAttributes": { "type": "object", "properties": { "updated": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "created": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true, "readOnly": true } } }, "OwnerDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Owner" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OwnerRelationships": { "type": "object", "properties": { "contact": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "business": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "asset": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "expense": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "liability": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true }, "income": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsSingleDocument" } ], "writeOnly": true } } }, "OwnersDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Owner" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "OwnersEntityType": { "enum": [ "owners" ], "type": "string" }, "Pagination": { "type": "object", "properties": { "size": { "type": "integer", "format": "int32" }, "number": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Point": { "type": "object", "properties": { "factory": { "$ref": "#/components/schemas/GeometryFactory" }, "userData": { "nullable": true }, "srid": { "type": "integer", "format": "int32" }, "precisionModel": { "$ref": "#/components/schemas/PrecisionModel" }, "numGeometries": { "type": "integer", "format": "int32", "readOnly": true }, "isSimple": { "type": "boolean", "readOnly": true }, "isValid": { "type": "boolean", "readOnly": true }, "area": { "type": "number", "format": "double", "readOnly": true }, "length": { "type": "number", "format": "double", "readOnly": true }, "centroid": { "$ref": "#/components/schemas/Point" }, "interiorPoint": { "$ref": "#/components/schemas/Point" }, "pointOnSurface": { "$ref": "#/components/schemas/Point" }, "envelope": { "$ref": "#/components/schemas/Geometry" }, "envelopeInternal": { "$ref": "#/components/schemas/Envelope" }, "isRectangle": { "type": "boolean", "readOnly": true }, "coordinateSequence": { "$ref": "#/components/schemas/CoordinateSequence" }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/Coordinate" }, "nullable": true, "readOnly": true }, "numPoints": { "type": "integer", "format": "int32", "readOnly": true }, "isEmpty": { "type": "boolean", "readOnly": true }, "dimension": { "$ref": "#/components/schemas/Dimension" }, "boundaryDimension": { "$ref": "#/components/schemas/Dimension" }, "x": { "type": "number", "format": "double" }, "y": { "type": "number", "format": "double" }, "coordinate": { "$ref": "#/components/schemas/Coordinate" }, "geometryType": { "type": "string", "nullable": true, "readOnly": true }, "ogcGeometryType": { "$ref": "#/components/schemas/OgcGeometryType" }, "boundary": { "$ref": "#/components/schemas/Geometry" }, "z": { "type": "number", "format": "double" }, "m": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PrecisionModel": { "type": "object", "properties": { "isFloating": { "type": "boolean", "readOnly": true }, "maximumSignificantDigits": { "type": "integer", "format": "int32", "readOnly": true }, "scale": { "type": "number", "format": "double" }, "gridSize": { "type": "number", "format": "double", "readOnly": true }, "precisionModelType": { "$ref": "#/components/schemas/PrecisionModels" } }, "additionalProperties": false }, "PrecisionModels": { "enum": [ "Floating", "FloatingSingle", "Fixed" ], "type": "string", "x-ms-enum": { "name": "PrecisionModels", "modelAsString": true } }, "PropertyPrimaryPurpose": { "enum": [ "PurchaseOwnerOccupied", "PurchaseInvestment" ], "type": "string", "x-ms-enum": { "name": "PropertyPrimaryPurpose", "modelAsString": true } }, "PropertyType": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/PropertyTypesEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/PropertyTypeAttributes" }, "relationships": { "$ref": "#/components/schemas/PropertyTypeRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "PropertyTypeAttributes": { "type": "object", "properties": { "propertyZoningType": { "type": "string", "nullable": true, "readOnly": true }, "name": { "maxLength": 2000, "minLength": 0, "type": "string", "nullable": true, "readOnly": true }, "propertyZoningTypeId": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } } }, "PropertyTypeDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/PropertyType" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "PropertyTypeRelationships": { "type": "object" }, "PropertyTypesDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyType" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "PropertyTypesEntityType": { "enum": [ "property-types" ], "type": "string" }, "PropertyValueEstimatedBasis": { "enum": [ "ApplicantEstimate", "CertifiedValuation", "ActualValue" ], "type": "string", "x-ms-enum": { "name": "PropertyValueEstimatedBasis", "modelAsString": true } }, "PropertyZoningTypesEntityType": { "enum": [ "property-zoning-types" ], "type": "string" }, "Referrer": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ReferrersEntityType" }, "id": { "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ReferrerAttributes" }, "relationships": { "$ref": "#/components/schemas/ReferrerRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ReferrerAttributes": { "type": "object", "properties": { "referrerOrganisationName": { "type": "string", "nullable": true, "readOnly": true }, "referrerName": { "type": "string", "nullable": true, "readOnly": true } } }, "ReferrerDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Referrer" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ReferrerMember": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ReferrerMembersEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ReferrerMemberAttributes" }, "relationships": { "$ref": "#/components/schemas/ReferrerMemberRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ReferrerMemberAttributes": { "type": "object", "properties": { "referrerName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true } } }, "ReferrerMemberDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ReferrerMember" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ReferrerMemberRelationships": { "type": "object", "properties": { "contactGroups": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "ReferrerMembersDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReferrerMember" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ReferrerMembersEntityType": { "enum": [ "referrer-members" ], "type": "string" }, "ReferrerOrganisation": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/ReferrerOrganisationEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/ReferrerOrganisationAttributes" }, "relationships": { "$ref": "#/components/schemas/ReferrerOrganisationRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ReferrerOrganisationAttributes": { "type": "object", "properties": { "referrerOrgName": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true } } }, "ReferrerOrganisationDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ReferrerOrganisation" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ReferrerOrganisationEntityType": { "enum": [ "referrer-organisation" ], "type": "string" }, "ReferrerOrganisationRelationships": { "type": "object", "properties": { "contactGroups": { "allOf": [ { "$ref": "#/components/schemas/RelationshipsMultipleDocument" } ], "writeOnly": true } } }, "ReferrerOrganisationsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReferrerOrganisation" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ReferrerRelationships": { "type": "object" }, "ReferrersDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Referrer" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ReferrersEntityType": { "enum": [ "referrers" ], "type": "string" }, "RelationshipLinks": { "type": "object", "properties": { "self": { "type": "string", "nullable": true }, "related": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RelationshipsMultipleDocument": { "required": [ "data" ], "type": "object", "properties": { "links": { "allOf": [ { "$ref": "#/components/schemas/RelationshipLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceIdentifier" }, "nullable": true } }, "additionalProperties": false }, "RelationshipsSingleDocument": { "required": [ "data" ], "type": "object", "properties": { "links": { "allOf": [ { "$ref": "#/components/schemas/RelationshipLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/ResourceIdentifier" } ], "nullable": true } }, "additionalProperties": false }, "ResourceIdentifier": { "required": [ "type" ], "type": "object", "properties": { "type": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" } }, "additionalProperties": false, "discriminator": { "propertyName": "type" } }, "ResourceLinks": { "type": "object", "properties": { "self": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResourceObject": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "attributes": { "$ref": "#/components/schemas/ResourceObjectAttributes" }, "relationships": { "$ref": "#/components/schemas/ResourceObjectRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "ResourceObjectAttributes": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "lid": { "type": "string", "nullable": true }, "links": { "$ref": "#/components/schemas/ResourceLinks" } } }, "ResourceObjectDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/ResourceObject" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "ResourceObjectRelationships": { "type": "object" }, "ResourceObjectsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceObject" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "Split": { "type": "object", "properties": { "loanTermYears": { "type": "number", "format": "double", "nullable": true }, "rateType": { "type": "string", "nullable": true }, "loanStructureType": { "$ref": "#/components/schemas/LoanStructureType" }, "amount": { "type": "number", "format": "double", "nullable": true }, "capitaliseLmi": { "type": "boolean", "nullable": true }, "lmiPremium": { "type": "number", "format": "double", "nullable": true }, "amountInclLmi": { "type": "number", "format": "double", "nullable": true }, "interestRate": { "type": "number", "format": "double", "nullable": true }, "rateTypePeriodMonths": { "type": "integer", "format": "int32", "nullable": true }, "paymentAmount": { "type": "number", "format": "double", "nullable": true }, "fixedRateStartDate": { "type": "string", "format": "date", "nullable": true }, "fixedRateEndDate": { "type": "string", "format": "date", "nullable": true }, "interestOnlyStartDate": { "type": "string", "format": "date", "nullable": true }, "interestOnlyEndDate": { "type": "string", "format": "date", "nullable": true }, "repaymentHolidayStartDate": { "type": "string", "format": "date", "nullable": true }, "repaymentHolidayEndDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "StructuredLead": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/StructuredLeadsEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/StructuredLeadAttributes" }, "relationships": { "$ref": "#/components/schemas/StructuredLeadRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "StructuredLeadAttributes": { "type": "object", "properties": { "categoriesAllowCreate": { "type": "boolean", "writeOnly": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true, "writeOnly": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/LeadContact" }, "nullable": true, "writeOnly": true }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/LeadAddress" }, "nullable": true, "writeOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/LeadAsset" }, "nullable": true, "writeOnly": true }, "expenses": { "type": "array", "items": { "$ref": "#/components/schemas/LeadExpense" }, "nullable": true, "writeOnly": true }, "incomes": { "type": "array", "items": { "$ref": "#/components/schemas/LeadIncome" }, "nullable": true, "writeOnly": true }, "liabilities": { "type": "array", "items": { "$ref": "#/components/schemas/LeadLiability" }, "nullable": true, "writeOnly": true }, "employments": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmployment" }, "nullable": true, "writeOnly": true }, "utmSource": { "type": "string", "nullable": true, "writeOnly": true }, "utmMedium": { "type": "string", "nullable": true, "writeOnly": true }, "utmCampaign": { "type": "string", "nullable": true, "writeOnly": true }, "utmTerm": { "type": "string", "nullable": true, "writeOnly": true }, "utmContent": { "type": "string", "nullable": true, "writeOnly": true }, "sourceId": { "type": "integer", "format": "int32", "nullable": true, "writeOnly": true }, "sourceCategoryId": { "type": "integer", "format": "int32", "nullable": true, "writeOnly": true }, "sourceReferrerId": { "type": "string", "nullable": true, "writeOnly": true }, "sourceAdditionalDetails": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "sourceSystemUrl": { "type": "string", "nullable": true, "writeOnly": true }, "dealName": { "type": "string", "nullable": true, "writeOnly": true }, "noteTitle": { "type": "string", "nullable": true, "writeOnly": true }, "noteDetails": { "type": "string", "nullable": true, "writeOnly": true }, "externalReference": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "externalIntegration": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true, "writeOnly": true }, "externalIntegrationAllowCreate": { "type": "boolean", "writeOnly": true }, "sendNotification": { "type": "boolean", "writeOnly": true }, "customStatusName": { "type": "string", "nullable": true, "readOnly": true }, "dealStatus": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/SystemStatus" } ], "readOnly": true } } }, "StructuredLeadDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/StructuredLead" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "StructuredLeadRelationships": { "type": "object" }, "StructuredLeadsDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/StructuredLead" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "StructuredLeadsEntityType": { "enum": [ "structured-leads" ], "type": "string" }, "SystemStatus": { "enum": [ "NewLeads", "Researching", "PreApproved", "ConditionallyApproved", "UnconditionallyApproved", "Lodged", "InProgress", "PendingSettlement", "Varied", "Repaid", "Withdrawn", "Cancelled", "Settled" ], "type": "string", "x-ms-enum": { "name": "SystemStatus", "modelAsString": true } }, "Task": { "required": [ "type", "id" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/IncludedResource" } ], "properties": { "type": { "$ref": "#/components/schemas/TasksEntityType" }, "id": { "pattern": "^[1-9]\\d*$", "type": "string", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/TaskAttributes" }, "relationships": { "$ref": "#/components/schemas/TaskRelationships" }, "links": { "allOf": [ { "$ref": "#/components/schemas/ResourceLinks" } ], "readOnly": true }, "meta": { "type": "object", "additionalProperties": { }, "readOnly": true } }, "additionalProperties": false }, "TaskAttributes": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "progress": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/InteractiveTaskProgressDto" } ] }, "priority": { "type": "string", "allOf": [ { "$ref": "#/components/schemas/InteractiveTaskPriorityDto" } ] }, "dueDate": { "type": "string", "format": "date-time", "nullable": true } } }, "TaskDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "$ref": "#/components/schemas/Task" }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "TaskRelationships": { "type": "object", "properties": { "assignee": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "residentialDeal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "contactGroups": { "$ref": "#/components/schemas/RelationshipsMultipleDocument" }, "assetFinanceDiversifiedDeal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" }, "commercialFinanceDiversifiedDeal": { "$ref": "#/components/schemas/RelationshipsSingleDocument" } } }, "TasksDocument": { "required": [ "data" ], "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "jsonApi": { "type": "object", "additionalProperties": { "nullable": true }, "readOnly": true }, "links": { "allOf": [ { "$ref": "#/components/schemas/TopLevelLinks" } ], "readOnly": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "included": { "type": "array", "items": { "$ref": "#/components/schemas/IncludedResource" }, "nullable": true, "readOnly": true } } }, "TasksEntityType": { "enum": [ "tasks" ], "type": "string" }, "Title": { "enum": [ "Mr", "Mrs", "Ms", "Miss", "Master", "Dr" ], "type": "string", "x-ms-enum": { "name": "Title", "modelAsString": true } }, "TopLevelLinks": { "type": "object", "properties": { "self": { "type": "string", "nullable": true }, "related": { "type": "string", "nullable": true }, "describedby": { "type": "string", "nullable": true }, "first": { "type": "string", "nullable": true }, "last": { "type": "string", "nullable": true }, "prev": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT authorization header using the Bearer scheme.", "scheme": "Bearer" } } }, "security": [ { "Bearer": [ ] } ] }