ConnectWise API Gateway MCP Server

{ "openapi": "3.0.1", "info": { "title": "Connectwise Manage Public Endpoints", "version": "2025.1" }, "servers": [ { "url": "http://na.myconnectwise.net/v4_6_release/apis/3.0" } ], "paths": { "/company/addressFormats": { "get": { "tags": [ "AddressFormats" ], "summary": "Get List of AddressFormat", "operationId": "getCompanyAddressFormats", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AddressFormat", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressFormat" } } } } } } }, "post": { "tags": [ "AddressFormats" ], "summary": "Post AddressFormat", "operationId": "postCompanyAddressFormats", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "addressFormat", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressFormat" } } }, "required": true }, "responses": { "201": { "description": "AddressFormat", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AddressFormat" } } } } } } }, "/company/addressFormats/{id}": { "get": { "tags": [ "AddressFormats" ], "summary": "Get AddressFormat", "operationId": "getCompanyAddressFormatsById", "parameters": [ { "name": "id", "in": "path", "description": "addressFormatId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AddressFormat", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AddressFormat" } } } } } }, "delete": { "tags": [ "AddressFormats" ], "summary": "Delete AddressFormat", "operationId": "deleteCompanyAddressFormatsById", "parameters": [ { "name": "id", "in": "path", "description": "addressFormatId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AddressFormats" ], "summary": "Put AddressFormat", "operationId": "putCompanyAddressFormatsById", "parameters": [ { "name": "id", "in": "path", "description": "addressFormatId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "addressFormat", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressFormat" } } }, "required": true }, "responses": { "200": { "description": "AddressFormat", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AddressFormat" } } } } } }, "patch": { "tags": [ "AddressFormats" ], "summary": "Patch AddressFormat", "operationId": "patchCompanyAddressFormatsById", "parameters": [ { "name": "id", "in": "path", "description": "addressFormatId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AddressFormat", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AddressFormat" } } } } } } }, "/company/addressFormats/{id}/info": { "get": { "tags": [ "AddressFormatInfos" ], "summary": "Get AddressFormatInfos", "operationId": "getCompanyAddressFormatsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "AddressFormatInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AddressFormatInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AddressFormatInfo" } } } } } } }, "/company/addressFormats/count": { "get": { "tags": [ "AddressFormats" ], "summary": "Get Count of AddressFormat", "operationId": "getCompanyAddressFormatsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/addressFormats/info": { "get": { "tags": [ "AddressFormatInfos" ], "summary": "Get List of AddressFormatInfos", "operationId": "getCompanyAddressFormatsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of addressFormatInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressFormatInfo" } } } } } } } }, "/company/addressFormats/info/count": { "get": { "tags": [ "AddressFormatInfos" ], "summary": "Get Count of AddressFormatInfos", "operationId": "getCompanyAddressFormatsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/communicationTypes": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get List of CommunicationType", "operationId": "getCompanyCommunicationTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationType" } } } } } } }, "post": { "tags": [ "CommunicationTypes" ], "summary": "Post CommunicationType", "operationId": "postCompanyCommunicationTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "communicationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } }, "required": true }, "responses": { "201": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } } }, "/company/communicationTypes/{id}": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get CommunicationType", "operationId": "getCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } }, "delete": { "tags": [ "CommunicationTypes" ], "summary": "Delete CommunicationType", "operationId": "deleteCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CommunicationTypes" ], "summary": "Put CommunicationType", "operationId": "putCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "communicationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } }, "required": true }, "responses": { "200": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } }, "patch": { "tags": [ "CommunicationTypes" ], "summary": "Patch CommunicationType", "operationId": "patchCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } } }, "/company/communicationTypes/{id}/info": { "get": { "tags": [ "CommunicationTypeInfo" ], "summary": "Get CommunicationTypeInfos", "operationId": "getCompanyCommunicationTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "AddressFormatInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CommunicationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CommunicationTypeInfo" } } } } } } }, "/company/communicationTypes/{id}/usages": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCommunicationTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/communicationTypes/{id}/usages/list": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get List of Usage", "operationId": "getCompanyCommunicationTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/communicationTypes/count": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get Count of Usage", "operationId": "getCompanyCommunicationTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/communicationTypes/info": { "get": { "tags": [ "CommunicationTypeInfo" ], "summary": "Get List of CommunicationTypeInfos", "operationId": "getCompanyCommunicationTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CommunicationTypeInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationTypeInfo" } } } } } } } }, "/company/communicationTypes/info/count": { "get": { "tags": [ "CommunicationTypeInfo" ], "summary": "Get Count of CommunicationTypeInfos", "operationId": "getCompanyCommunicationTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies": { "get": { "tags": [ "Companies" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompanies", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Post ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "postCompanyCompanies", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "company", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "required": true }, "responses": { "201": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/company/companies/{id}": { "get": { "tags": [ "Companies" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "deleteCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Companies" ], "summary": "Put ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "putCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "company", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company" } } } } } }, "patch": { "tags": [ "Companies" ], "summary": "Patch ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "patchCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/company/companies/{id}/merge": { "post": { "tags": [ "Companies" ], "summary": "Post SuccessResponse", "operationId": "postCompanyCompaniesByIdMerge", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "merge", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMerge" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/company/companies/{id}/usages": { "get": { "tags": [ "Companies" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{id}/usages/list": { "get": { "tags": [ "Companies" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{parentId}/customStatusNotes": { "get": { "tags": [ "CompanyCustomNotes" ], "summary": "Get List of CompanyCustomNote", "operationId": "getCompanyCompaniesByParentIdCustomStatusNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } } }, "post": { "tags": [ "CompanyCustomNotes" ], "summary": "Post CompanyCustomNote", "operationId": "postCompanyCompaniesByParentIdCustomStatusNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } }, "required": true }, "responses": { "201": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } } }, "/company/companies/{parentId}/customStatusNotes/{id}": { "get": { "tags": [ "CompanyCustomNotes" ], "summary": "Get CompanyCustomNote", "operationId": "getCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } }, "delete": { "tags": [ "CompanyCustomNotes" ], "summary": "Delete CompanyCustomNote", "operationId": "deleteCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyCustomNotes" ], "summary": "Put CompanyCustomNote", "operationId": "putCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } }, "required": true }, "responses": { "200": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } }, "patch": { "tags": [ "CompanyCustomNotes" ], "summary": "Patch CompanyCustomNote", "operationId": "patchCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } } }, "/company/companies/{parentId}/customStatusNotes/count": { "get": { "tags": [ "CompanyCustomNotes" ], "summary": "Get Count of CompanyCustomNote", "operationId": "getCompanyCompaniesByParentIdCustomStatusNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/groups": { "get": { "tags": [ "CompanyGroups" ], "summary": "Get List of CompanyGroup", "operationId": "getCompanyCompaniesByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyGroup" } } } } } } }, "post": { "tags": [ "CompanyGroups" ], "summary": "Post CompanyGroup", "operationId": "postCompanyCompaniesByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } }, "required": true }, "responses": { "201": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } } }, "/company/companies/{parentId}/groups/{id}": { "get": { "tags": [ "CompanyGroups" ], "summary": "Get CompanyGroup", "operationId": "getCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } }, "delete": { "tags": [ "CompanyGroups" ], "summary": "Delete CompanyGroup", "operationId": "deleteCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyGroups" ], "summary": "Put CompanyGroup", "operationId": "putCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } }, "required": true }, "responses": { "200": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } }, "patch": { "tags": [ "CompanyGroups" ], "summary": "Patch CompanyGroup", "operationId": "patchCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } } }, "/company/companies/{parentId}/groups/count": { "get": { "tags": [ "CompanyGroups" ], "summary": "Get Count of CompanyGroup", "operationId": "getCompanyCompaniesByParentIdGroupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/managementReportNotifications": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get List of ManagementReportNotification", "operationId": "getCompanyCompaniesByParentIdManagementReportNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "post": { "tags": [ "ManagementReportNotifications" ], "summary": "Post ManagementReportNotification", "operationId": "postCompanyCompaniesByParentIdManagementReportNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } }, "required": true }, "responses": { "201": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "/company/companies/{parentId}/managementReportNotifications/{id}": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get ManagementReportNotification", "operationId": "getCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } }, "delete": { "tags": [ "ManagementReportNotifications" ], "summary": "Delete ManagementReportNotification", "operationId": "deleteCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagementReportNotifications" ], "summary": "Put ManagementReportNotification", "operationId": "putCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } }, "required": true }, "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } }, "patch": { "tags": [ "ManagementReportNotifications" ], "summary": "Patch ManagementReportNotification", "operationId": "patchCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "/company/companies/{parentId}/managementReportNotifications/count": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get Count of ManagementReportNotification", "operationId": "getCompanyCompaniesByParentIdManagementReportNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/managementReportSetup": { "get": { "tags": [ "ManagementReportSetups" ], "summary": "Get List of ManagementReportSetup", "operationId": "getCompanyCompaniesByParentIdManagementReportSetup", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } } }, "post": { "tags": [ "ManagementReportSetups" ], "summary": "Post ManagementReportSetup", "operationId": "postCompanyCompaniesByParentIdManagementReportSetup", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } }, "required": true }, "responses": { "201": { "description": "ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } } }, "/company/companies/{parentId}/managementReportSetup/{id}": { "put": { "tags": [ "ManagementReportSetups" ], "summary": "Put ManagementReportSetup", "operationId": "putCompanyCompaniesByParentIdManagementReportSetupById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } }, "required": true }, "responses": { "200": { "description": "ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } }, "patch": { "tags": [ "ManagementReportSetups" ], "summary": "Patch ManagementReportSetup", "operationId": "patchCompanyCompaniesByParentIdManagementReportSetupById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } } }, "/company/companies/{parentId}/managementSummaryReports": { "get": { "tags": [ "CompanyManagementSummarys" ], "summary": "Get List of CompanyManagementSummary", "operationId": "getCompanyCompaniesByParentIdManagementSummaryReports", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } } }, "post": { "tags": [ "CompanyManagementSummarys" ], "summary": "Post CompanyManagementSummary", "operationId": "postCompanyCompaniesByParentIdManagementSummaryReports", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementSummary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } }, "required": true }, "responses": { "201": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } } }, "/company/companies/{parentId}/managementSummaryReports/{id}": { "get": { "tags": [ "CompanyManagementSummarys" ], "summary": "Get CompanyManagementSummary", "operationId": "getCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } }, "delete": { "tags": [ "CompanyManagementSummarys" ], "summary": "Delete CompanyManagementSummary", "operationId": "deleteCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyManagementSummarys" ], "summary": "Put CompanyManagementSummary", "operationId": "putCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementSummary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } }, "required": true }, "responses": { "200": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } }, "patch": { "tags": [ "CompanyManagementSummarys" ], "summary": "Patch CompanyManagementSummary", "operationId": "patchCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } } }, "/company/companies/{parentId}/managementSummaryReports/count": { "get": { "tags": [ "CompanyManagementSummarys" ], "summary": "Get Count of CompanyManagementSummary", "operationId": "getCompanyCompaniesByParentIdManagementSummaryReportsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/notes": { "get": { "tags": [ "CompanyNotes" ], "summary": "Get List of CompanyNote", "operationId": "getCompanyCompaniesByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNote" } } } } } } }, "post": { "tags": [ "CompanyNotes" ], "summary": "Post CompanyNote", "operationId": "postCompanyCompaniesByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } }, "required": true }, "responses": { "201": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } } }, "/company/companies/{parentId}/notes/{id}": { "get": { "tags": [ "CompanyNotes" ], "summary": "Get CompanyNote", "operationId": "getCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } }, "delete": { "tags": [ "CompanyNotes" ], "summary": "Delete CompanyNote", "operationId": "deleteCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyNotes" ], "summary": "Put CompanyNote", "operationId": "putCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } }, "required": true }, "responses": { "200": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } }, "patch": { "tags": [ "CompanyNotes" ], "summary": "Patch CompanyNote", "operationId": "patchCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } } }, "/company/companies/{parentId}/notes/count": { "get": { "tags": [ "CompanyNotes" ], "summary": "Get Count of CompanyNote", "operationId": "getCompanyCompaniesByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/sites": { "get": { "tags": [ "CompanySites" ], "summary": "Get List of CompanySite", "operationId": "getCompanyCompaniesByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySite" } } } } } } }, "post": { "tags": [ "CompanySites" ], "summary": "Post CompanySite", "operationId": "postCompanyCompaniesByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySite" } } }, "required": true }, "responses": { "201": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } } }, "/company/companies/{parentId}/sites/{id}": { "get": { "tags": [ "CompanySites" ], "summary": "Get CompanySite", "operationId": "getCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } }, "delete": { "tags": [ "CompanySites" ], "summary": "Delete CompanySite", "operationId": "deleteCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanySites" ], "summary": "Put CompanySite", "operationId": "putCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySite" } } }, "required": true }, "responses": { "200": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } }, "patch": { "tags": [ "CompanySites" ], "summary": "Patch CompanySite", "operationId": "patchCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } } }, "/company/companies/{parentId}/sites/{id}/info": { "get": { "tags": [ "CompanySiteInfos" ], "summary": "Get CompanySiteInfos", "operationId": "getCompanyCompaniesByParentIdSitesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanySiteInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanySiteInfo" } } } } } } }, "/company/companies/{parentId}/sites/{id}/usages": { "get": { "tags": [ "CompanySites" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesByParentIdSitesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{parentId}/sites/{id}/usages/list": { "get": { "tags": [ "CompanySites" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesByParentIdSitesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{parentId}/sites/count": { "get": { "tags": [ "CompanySites" ], "summary": "Get Count of CompanySite", "operationId": "getCompanyCompaniesByParentIdSitesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/sites/info": { "get": { "tags": [ "CompanySiteInfos" ], "summary": "Get List of CompanySiteInfos", "operationId": "getCompanyCompaniesByParentIdSitesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of companySiteInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySiteInfo" } } } } } } } }, "/company/companies/{parentId}/sites/info/count": { "get": { "tags": [ "CompanySiteInfos" ], "summary": "Get Count of CompanySite", "operationId": "getCompanyCompaniesByParentIdSitesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/surveys/count": { "get": { "tags": [ "CompanySurveys" ], "summary": "Get Count of", "operationId": "getCompanyCompaniesByParentIdSurveysCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/teams": { "get": { "tags": [ "CompanyTeams" ], "summary": "Get List of CompanyTeam", "operationId": "getCompanyCompaniesByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTeam" } } } } } } }, "post": { "tags": [ "CompanyTeams" ], "summary": "Post CompanyTeam", "operationId": "postCompanyCompaniesByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } }, "required": true }, "responses": { "201": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } } }, "/company/companies/{parentId}/teams/{id}": { "get": { "tags": [ "CompanyTeams" ], "summary": "Get CompanyTeam", "operationId": "getCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } }, "delete": { "tags": [ "CompanyTeams" ], "summary": "Delete CompanyTeam", "operationId": "deleteCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyTeams" ], "summary": "Put CompanyTeam", "operationId": "putCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } }, "required": true }, "responses": { "200": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } }, "patch": { "tags": [ "CompanyTeams" ], "summary": "Patch CompanyTeam", "operationId": "patchCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } } }, "/company/companies/{parentId}/teams/count": { "get": { "tags": [ "CompanyTeams" ], "summary": "Get Count of CompanyTeam", "operationId": "getCompanyCompaniesByParentIdTeamsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/tracks": { "get": { "tags": [ "CompanyTracks" ], "summary": "Get List of ContactTrack", "operationId": "getCompanyCompaniesByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "post": { "tags": [ "CompanyTracks" ], "summary": "Post ContactTrack", "operationId": "postCompanyCompaniesByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } }, "required": true }, "responses": { "201": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "/company/companies/{parentId}/tracks/{id}": { "get": { "tags": [ "CompanyTracks" ], "summary": "Get ContactTrack", "operationId": "getCompanyCompaniesByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } }, "delete": { "tags": [ "CompanyTracks" ], "summary": "Delete ContactTrack", "operationId": "deleteCompanyCompaniesByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/companies/{parentId}/tracks/count": { "get": { "tags": [ "CompanyTracks" ], "summary": "Get Count of ContactTrack", "operationId": "getCompanyCompaniesByParentIdTracksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/typeAssociations": { "get": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Get List of CompanyTypeAssociation", "operationId": "getCompanyCompaniesByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } } }, "post": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Post CompanyTypeAssociation", "operationId": "postCompanyCompaniesByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } }, "required": true }, "responses": { "201": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } } }, "/company/companies/{parentId}/typeAssociations/{id}": { "get": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Get CompanyTypeAssociation", "operationId": "getCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } }, "delete": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Delete CompanyTypeAssociation", "operationId": "deleteCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Put CompanyTypeAssociation", "operationId": "putCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } }, "required": true }, "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } }, "patch": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Patch CompanyTypeAssociation", "operationId": "patchCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } } }, "/company/companies/{parentId}/typeAssociations/count": { "get": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Get Count of CompanyTypeAssociation", "operationId": "getCompanyCompaniesByParentIdTypeAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/count": { "get": { "tags": [ "Companies" ], "summary": "Get Count of ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompaniesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/default": { "get": { "tags": [ "Companies" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompaniesDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/company/companies/info": { "get": { "tags": [ "CompanyInfos" ], "summary": "Get List of CompanyInfos", "operationId": "getCompanyCompaniesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of companyInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" } } } } } } } }, "/company/companies/info/count": { "get": { "tags": [ "CompanyInfos" ], "summary": "Get Count of CompanyInfos", "operationId": "getCompanyCompaniesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/info/types": { "get": { "tags": [ "CompanyTypeInfos" ], "summary": "Get List of CompanyTypeInfo", "operationId": "getCompanyCompaniesInfoTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTypeInfo" } } } } } } } }, "/company/companies/info/types/{id}": { "get": { "tags": [ "CompanyTypeInfos" ], "summary": "Get CompanyTypeInfo", "operationId": "getCompanyCompaniesInfoTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyTypeInfo" } } } } } } }, "/company/companies/info/types/count": { "get": { "tags": [ "CompanyTypeInfos" ], "summary": "Get Count of CompanyTypeInfo", "operationId": "getCompanyCompaniesInfoTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/statuses": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get List of CompanyStatus", "operationId": "getCompanyCompaniesStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyStatus" } } } } } } }, "post": { "tags": [ "CompanyStatuses" ], "summary": "Post CompanyStatus", "operationId": "postCompanyCompaniesStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } }, "required": true }, "responses": { "201": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } } }, "/company/companies/statuses/{id}": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get CompanyStatus", "operationId": "getCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } }, "delete": { "tags": [ "CompanyStatuses" ], "summary": "Delete CompanyStatus", "operationId": "deleteCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyStatuses" ], "summary": "Put CompanyStatus", "operationId": "putCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } }, "required": true }, "responses": { "200": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } }, "patch": { "tags": [ "CompanyStatuses" ], "summary": "Patch CompanyStatus", "operationId": "patchCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } } }, "/company/companies/statuses/{id}/usages": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/statuses/{id}/usages/list": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/statuses/count": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get Count of CompanyStatus", "operationId": "getCompanyCompaniesStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/types": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get List of CompanyType", "operationId": "getCompanyCompaniesTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" } } } } } } }, "post": { "tags": [ "CompanyTypes" ], "summary": "Post CompanyType", "operationId": "postCompanyCompaniesTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyType" } } }, "required": true }, "responses": { "201": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } } }, "/company/companies/types/{id}": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get CompanyType", "operationId": "getCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } }, "delete": { "tags": [ "CompanyTypes" ], "summary": "Delete Usage", "operationId": "deleteCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyTypes" ], "summary": "Put CompanyType", "operationId": "putCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyType" } } }, "required": true }, "responses": { "200": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } }, "patch": { "tags": [ "CompanyTypes" ], "summary": "Patch CompanyType", "operationId": "patchCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } } }, "/company/companies/types/{id}/usages": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/types/{id}/usages/list": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/types/count": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get Count of CompanyType", "operationId": "getCompanyCompaniesTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companyPickerItems": { "get": { "tags": [ "CompanyPickerItems" ], "summary": "Get List of CompanyPickerItem", "operationId": "getCompanyCompanyPickerItems", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyPickerItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyPickerItem" } } } } } } }, "post": { "tags": [ "CompanyPickerItems" ], "summary": "Post CompanyPickerItem", "operationId": "postCompanyCompanyPickerItems", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyPickerItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPickerItem" } } }, "required": true }, "responses": { "201": { "description": "CompanyPickerItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyPickerItem" } } } } } } }, "/company/companyPickerItems/{id}": { "get": { "tags": [ "CompanyPickerItems" ], "summary": "Get CompanyPickerItem", "operationId": "getCompanyCompanyPickerItemsById", "parameters": [ { "name": "id", "in": "path", "description": "companyPickerItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyPickerItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyPickerItem" } } } } } }, "delete": { "tags": [ "CompanyPickerItems" ], "summary": "Delete CompanyPickerItem", "operationId": "deleteCompanyCompanyPickerItemsById", "parameters": [ { "name": "id", "in": "path", "description": "companyPickerItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/companyPickerItems/clear": { "post": { "tags": [ "CompanyPickerItems" ], "summary": "Post ClearPickerRequest", "operationId": "postCompanyCompanyPickerItemsClear", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "clearPickerRequest", "in": "path", "description": "clearPickerRequest", "required": true, "schema": { "$ref": "#/components/schemas/ClearPickerRequest" } } ], "responses": { "204": { "description": "ClearPickerRequest", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ClearPickerRequest" } } } } } } }, "/company/companyPickerItems/count": { "get": { "tags": [ "CompanyPickerItems" ], "summary": "Get Count of CompanyPickerItem", "operationId": "getCompanyCompanyPickerItemsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companyTypeAssociations": { "get": { "tags": [ "CompanyTypeAssociations" ], "summary": "Get List of CompanyTypeAssociation", "operationId": "getCompanyCompanyTypeAssociations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } } } } } }, "post": { "tags": [ "CompanyTypeAssociations" ], "summary": "Post CompanyTypeAssociation", "operationId": "postCompanyCompanyTypeAssociations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } }, "required": true }, "responses": { "201": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } } } } } }, "/company/companyTypeAssociations/{id}": { "get": { "tags": [ "CompanyTypeAssociations" ], "summary": "Get CompanyTypeAssociation", "operationId": "getCompanyCompanyTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "companyTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } } } } }, "delete": { "tags": [ "CompanyTypeAssociations" ], "summary": "Delete CompanyTypeAssociation", "operationId": "deleteCompanyCompanyTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "companyTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyTypeAssociations" ], "summary": "Put CompanyTypeAssociation", "operationId": "putCompanyCompanyTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "companyTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } }, "required": true }, "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } } } } }, "patch": { "tags": [ "CompanyTypeAssociations" ], "summary": "Patch CompanyTypeAssociation", "operationId": "patchCompanyCompanyTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "companyTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.CompanyTypeAssociation" } } } } } } }, "/company/companyTypeAssociations/count": { "get": { "tags": [ "CompanyTypeAssociations" ], "summary": "Get Count of CompanyTypeAssociation", "operationId": "getCompanyCompanyTypeAssociationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations": { "get": { "tags": [ "Configurations" ], "summary": "Get List of Configuration", "operationId": "getCompanyConfigurations", "parameters": [ { "name": "managedIdentifier", "in": "query", "description": "managedIdentifier", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "post": { "tags": [ "Configurations" ], "summary": "Post Configuration", "operationId": "postCompanyConfigurations", "parameters": [ { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } }, "required": true }, "responses": { "201": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/{id}": { "get": { "tags": [ "Configurations" ], "summary": "Get Configuration", "operationId": "getCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } }, "delete": { "tags": [ "Configurations" ], "summary": "Delete Configuration", "operationId": "deleteCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Configurations" ], "summary": "Put Configuration", "operationId": "putCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } }, "required": true }, "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } }, "patch": { "tags": [ "Configurations" ], "summary": "Patch Configuration", "operationId": "patchCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/{id}/changeType": { "patch": { "tags": [ "Configurations" ], "summary": "Patch Configuration", "operationId": "patchCompanyConfigurationsByIdChangeType", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/{id}/quickAccess/count": { "get": { "tags": [ "Configurations" ], "summary": "Get Configuration Tab Count", "operationId": "getCompanyConfigurationsByIdQuickAccessCount", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationApplicationParameters", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTabsCount" } } } } } } }, "/company/configurations/bulk": { "post": { "tags": [ "Configurations" ], "summary": "Post Configuration", "operationId": "postCompanyConfigurationsBulk", "parameters": [ { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of Configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.Configuration" } } } }, "required": true }, "responses": { "207": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } }, "delete": { "tags": [ "Configurations" ], "summary": "Delete BulkResult", "operationId": "deleteCompanyConfigurationsBulk", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } }, "put": { "tags": [ "Configurations" ], "summary": "Put Configuration", "operationId": "putCompanyConfigurationsBulk", "parameters": [ { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of Configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.Configuration" } } } }, "required": true }, "responses": { "207": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/count": { "get": { "tags": [ "Configurations" ], "summary": "Get Count of Configuration", "operationId": "getCompanyConfigurationsCount", "parameters": [ { "name": "managedIdentifier", "in": "query", "description": "managedIdentifier", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/statuses": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get List of ConfigurationStatus", "operationId": "getCompanyConfigurationsStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } } }, "post": { "tags": [ "ConfigurationStatuses" ], "summary": "Post ConfigurationStatus", "operationId": "postCompanyConfigurationsStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } } }, "/company/configurations/statuses/{id}": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get ConfigurationStatus", "operationId": "getCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } }, "delete": { "tags": [ "ConfigurationStatuses" ], "summary": "Delete ConfigurationStatus", "operationId": "deleteCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationStatuses" ], "summary": "Put ConfigurationStatus", "operationId": "putCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } }, "patch": { "tags": [ "ConfigurationStatuses" ], "summary": "Patch ConfigurationStatus", "operationId": "patchCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } } }, "/company/configurations/statuses/{id}/info": { "get": { "tags": [ "ConfigurationStatusInfos" ], "summary": "Get ConfigurationStatusInfos", "operationId": "getCompanyConfigurationsStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ConfigurationStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationStatusInfo" } } } } } } }, "/company/configurations/statuses/{id}/usages": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get List of Usage Count", "operationId": "getCompanyConfigurationsStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/statuses/{id}/usages/list": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/statuses/count": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get Count of ConfigurationStatus", "operationId": "getCompanyConfigurationsStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/statuses/info": { "get": { "tags": [ "ConfigurationStatusInfos" ], "summary": "Get List of ConfigurationStatusInfos", "operationId": "getCompanyConfigurationsStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of configurationStatusesInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationStatusInfo" } } } } } } } }, "/company/configurations/statuses/info/count": { "get": { "tags": [ "ConfigurationStatusInfos" ], "summary": "Get Count of ConfigurationStatusInfos", "operationId": "getCompanyConfigurationsStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/types": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get List of ConfigurationType", "operationId": "getCompanyConfigurationsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "post": { "tags": [ "ConfigurationTypes" ], "summary": "Post ConfigurationType", "operationId": "postCompanyConfigurationsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get List of ConfigurationTypeQuestionValue", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } } }, "post": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Post ConfigurationTypeQuestionValue", "operationId": "postCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestionValue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/{id}": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get ConfigurationTypeQuestionValue", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } }, "delete": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Delete ConfigurationTypeQuestionValue", "operationId": "deleteCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Put ConfigurationTypeQuestionValue", "operationId": "putCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestionValue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } }, "patch": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Patch ConfigurationTypeQuestionValue", "operationId": "patchCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/{id}/usages": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/{id}/usages/list": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/count": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get Count of ConfigurationTypeQuestionValue", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/types/{id}": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get ConfigurationType", "operationId": "getCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } }, "delete": { "tags": [ "ConfigurationTypes" ], "summary": "Delete ConfigurationType", "operationId": "deleteCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationTypes" ], "summary": "Put ConfigurationType", "operationId": "putCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } }, "patch": { "tags": [ "ConfigurationTypes" ], "summary": "Patch ConfigurationType", "operationId": "patchCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "/company/configurations/types/{id}/info": { "get": { "tags": [ "ConfigurationTypeInfos" ], "summary": "Get ConfigurationTypeInfos", "operationId": "getCompanyConfigurationsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ConfigurationTypeInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeInfo" } } } } } } }, "/company/configurations/types/{id}/usages": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get List of Usage Count", "operationId": "getCompanyConfigurationsTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{id}/usages/list": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{parentId}/questions": { "get": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Get List of ConfigurationTypeQuestion", "operationId": "getCompanyConfigurationsTypesByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } } }, "post": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Post ConfigurationTypeQuestion", "operationId": "postCompanyConfigurationsTypesByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } } }, "/company/configurations/types/{parentId}/questions/{id}": { "get": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Get ConfigurationTypeQuestion", "operationId": "getCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } }, "delete": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Delete ConfigurationTypeQuestion", "operationId": "deleteCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Put ConfigurationTypeQuestion", "operationId": "putCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } }, "patch": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Patch ConfigurationTypeQuestion", "operationId": "patchCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } } }, "/company/configurations/types/{parentId}/questions/count": { "get": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Get Count of ConfigurationTypeQuestion", "operationId": "getCompanyConfigurationsTypesByParentIdQuestionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/types/copy": { "post": { "tags": [ "ConfigurationTypes" ], "summary": "Post Board", "operationId": "postCompanyConfigurationsTypesCopy", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "copy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeCopy" } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "/company/configurations/types/count": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get Count of ConfigurationType", "operationId": "getCompanyConfigurationsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contact/types/{id}/usages/list": { "get": { "tags": [ "Contact Types" ], "summary": "Get List of Usage", "operationId": "getCompanyContactTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get List of ApiContact", "operationId": "getCompanyContacts", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Post ApiContact", "operationId": "postCompanyContacts", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "required": true }, "responses": { "201": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } } }, "/company/contacts/{id}": { "get": { "tags": [ "Contacts" ], "summary": "Get ApiContact", "operationId": "getCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete ApiContact", "operationId": "deleteCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "transferContactId", "in": "path", "description": "transferContactId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Contacts" ], "summary": "Put ApiContact", "operationId": "putCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "required": true }, "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Patch ApiContact", "operationId": "patchCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } } }, "/company/contacts/{id}/image": { "get": { "tags": [ "Contacts" ], "summary": "Get ValidatePortalResponse", "operationId": "getCompanyContactsByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "useDefaultFlag", "in": "path", "description": "useDefaultFlag", "required": true, "schema": { "type": "boolean" } }, { "name": "lastModified", "in": "path", "description": "lastModified", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/company/contacts/{id}/info": { "get": { "tags": [ "ContactInfos" ], "summary": "Get ContactInfos", "operationId": "getCompanyContactsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ContactInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactInfo" } } } } } } }, "/company/contacts/{id}/portalSecurity": { "get": { "tags": [ "Contacts" ], "summary": "Get List of PortalSecurity", "operationId": "getCompanyContactsByIdPortalSecurity", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalSecurity" } } } } } } } }, "/company/contacts/{id}/usages": { "get": { "tags": [ "Contacts" ], "summary": "Get List of Usage Count", "operationId": "getCompanyContactsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/{id}/usages/list": { "get": { "tags": [ "Contacts" ], "summary": "Get List of Usage", "operationId": "getCompanyContactsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/{parentId}/communications": { "get": { "tags": [ "ContactCommunications" ], "summary": "Get List of ContactCommunication", "operationId": "getCompanyContactsByParentIdCommunications", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCommunication" } } } } } } }, "post": { "tags": [ "ContactCommunications" ], "summary": "Post ContactCommunication", "operationId": "postCompanyContactsByParentIdCommunications", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactCommunication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } }, "required": true }, "responses": { "201": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } } }, "/company/contacts/{parentId}/communications/{id}": { "get": { "tags": [ "ContactCommunications" ], "summary": "Get ContactCommunication", "operationId": "getCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } }, "delete": { "tags": [ "ContactCommunications" ], "summary": "Delete ContactCommunication", "operationId": "deleteCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactCommunications" ], "summary": "Put ContactCommunication", "operationId": "putCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactCommunication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } }, "required": true }, "responses": { "200": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } }, "patch": { "tags": [ "ContactCommunications" ], "summary": "Patch ContactCommunication", "operationId": "patchCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } } }, "/company/contacts/{parentId}/communications/count": { "get": { "tags": [ "ContactCommunications" ], "summary": "Get Count of ContactCommunication", "operationId": "getCompanyContactsByParentIdCommunicationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/groups": { "get": { "tags": [ "ContactGroups" ], "summary": "Get List of ContactGroup", "operationId": "getCompanyContactsByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } } } } } }, "post": { "tags": [ "ContactGroups" ], "summary": "Post ContactGroup", "operationId": "postCompanyContactsByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } }, "required": true }, "responses": { "201": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } } }, "/company/contacts/{parentId}/groups/{id}": { "get": { "tags": [ "ContactGroups" ], "summary": "Get ContactGroup", "operationId": "getCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } }, "delete": { "tags": [ "ContactGroups" ], "summary": "Delete ContactGroup", "operationId": "deleteCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactGroups" ], "summary": "Put ContactGroup", "operationId": "putCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } }, "required": true }, "responses": { "200": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } }, "patch": { "tags": [ "ContactGroups" ], "summary": "Patch ContactGroup", "operationId": "patchCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } } }, "/company/contacts/{parentId}/groups/count": { "get": { "tags": [ "ContactGroups" ], "summary": "Get Count of ContactGroup", "operationId": "getCompanyContactsByParentIdGroupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/notes": { "get": { "tags": [ "ContactNotes" ], "summary": "Get List of ContactNote", "operationId": "getCompanyContactsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactNote" } } } } } } }, "post": { "tags": [ "ContactNotes" ], "summary": "Post ContactNote", "operationId": "postCompanyContactsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNote" } } }, "required": true }, "responses": { "201": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } } }, "/company/contacts/{parentId}/notes/{id}": { "get": { "tags": [ "ContactNotes" ], "summary": "Get ContactNote", "operationId": "getCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } }, "delete": { "tags": [ "ContactNotes" ], "summary": "Delete ContactNote", "operationId": "deleteCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactNotes" ], "summary": "Put ContactNote", "operationId": "putCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNote" } } }, "required": true }, "responses": { "200": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } }, "patch": { "tags": [ "ContactNotes" ], "summary": "Patch ContactNote", "operationId": "patchCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } } }, "/company/contacts/{parentId}/notes/count": { "get": { "tags": [ "ContactNotes" ], "summary": "Get Count of ContactNote", "operationId": "getCompanyContactsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/tracks": { "get": { "tags": [ "ContactTracks" ], "summary": "Get List of ContactTrack", "operationId": "getCompanyContactsByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "post": { "tags": [ "ContactTracks" ], "summary": "Post ContactTrack", "operationId": "postCompanyContactsByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } }, "required": true }, "responses": { "201": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "/company/contacts/{parentId}/tracks/{id}": { "get": { "tags": [ "ContactTracks" ], "summary": "Get ContactTrack", "operationId": "getCompanyContactsByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } }, "delete": { "tags": [ "ContactTracks" ], "summary": "Delete ContactTrack", "operationId": "deleteCompanyContactsByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/contacts/{parentId}/tracks/count": { "get": { "tags": [ "ContactTracks" ], "summary": "Get Count of ContactTrack", "operationId": "getCompanyContactsByParentIdTracksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/typeAssociations": { "get": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Get List of ContactTypeAssociation", "operationId": "getCompanyContactsByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } } }, "post": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Post ContactTypeAssociation", "operationId": "postCompanyContactsByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } }, "required": true }, "responses": { "201": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } } }, "/company/contacts/{parentId}/typeAssociations/{id}": { "get": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Get ContactTypeAssociation", "operationId": "getCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } }, "delete": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Delete ContactTypeAssociation", "operationId": "deleteCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Put ContactTypeAssociation", "operationId": "putCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } }, "required": true }, "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } }, "patch": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Patch ContactTypeAssociation", "operationId": "patchCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } } }, "/company/contacts/{parentId}/typeAssociations/count": { "get": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Get Count of ContactTypeAssociation", "operationId": "getCompanyContactsByParentIdTypeAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/count": { "get": { "tags": [ "Contacts" ], "summary": "Get Count of Usage", "operationId": "getCompanyContactsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/default": { "get": { "tags": [ "Contacts" ], "summary": "Get ApiContact", "operationId": "getCompanyContactsDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "companyId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } } }, "/company/contacts/departments": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get List of ContactDepartment", "operationId": "getCompanyContactsDepartments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDepartment" } } } } } } }, "post": { "tags": [ "ContactDepartments" ], "summary": "Post ContactDepartment", "operationId": "postCompanyContactsDepartments", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactDepartment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } }, "required": true }, "responses": { "201": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } } }, "/company/contacts/departments/{id}": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get ContactDepartment", "operationId": "getCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } }, "delete": { "tags": [ "ContactDepartments" ], "summary": "Delete Usage", "operationId": "deleteCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactDepartments" ], "summary": "Put ContactDepartment", "operationId": "putCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactDepartment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } }, "required": true }, "responses": { "200": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } }, "patch": { "tags": [ "ContactDepartments" ], "summary": "Patch ContactDepartment", "operationId": "patchCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } } }, "/company/contacts/departments/{id}/info": { "get": { "tags": [ "ContactDepartmentInfos" ], "summary": "Get ContactDepartmentInfos", "operationId": "getCompanyContactsDepartmentsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ContactDepartmentInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactDepartmentInfo" } } } } } } }, "/company/contacts/departments/{id}/usages": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get List of Usage Count", "operationId": "getCompanyContactsDepartmentsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/departments/{id}/usages/list": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get List of Usage", "operationId": "getCompanyContactsDepartmentsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/departments/count": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get Count of ContactDepartment", "operationId": "getCompanyContactsDepartmentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/departments/info": { "get": { "tags": [ "ContactDepartmentInfos" ], "summary": "Get List of ContactDepartmentInfos", "operationId": "getCompanyContactsDepartmentsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of contactDepartmentInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDepartmentInfo" } } } } } } } }, "/company/contacts/departments/info/count": { "get": { "tags": [ "ContactDepartmentInfos" ], "summary": "Get Count of ContactDepartmentInfos", "operationId": "getCompanyContactsDepartmentsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/info": { "get": { "tags": [ "ContactInfos" ], "summary": "Get List of ContactInfos", "operationId": "getCompanyContactsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of contactInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInfo" } } } } } } } }, "/company/contacts/info/count": { "get": { "tags": [ "ContactInfos" ], "summary": "Get Count of ContactInfos", "operationId": "getCompanyContactsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/relationships": { "get": { "tags": [ "ContactRelationships" ], "summary": "Get List of ContactRelationship", "operationId": "getCompanyContactsRelationships", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRelationship" } } } } } } }, "post": { "tags": [ "ContactRelationships" ], "summary": "Post ContactRelationship", "operationId": "postCompanyContactsRelationships", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactRelationship", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } }, "required": true }, "responses": { "201": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } } }, "/company/contacts/relationships/{id}": { "get": { "tags": [ "ContactRelationships" ], "summary": "Get ContactRelationship", "operationId": "getCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } }, "delete": { "tags": [ "ContactRelationships" ], "summary": "Delete ContactRelationship", "operationId": "deleteCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactRelationships" ], "summary": "Put ContactRelationship", "operationId": "putCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactRelationship", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } }, "required": true }, "responses": { "200": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } }, "patch": { "tags": [ "ContactRelationships" ], "summary": "Patch ContactRelationship", "operationId": "patchCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } } }, "/company/contacts/relationships/count": { "get": { "tags": [ "ContactRelationships" ], "summary": "Get Count of ContactRelationship", "operationId": "getCompanyContactsRelationshipsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/requestPassword": { "post": { "tags": [ "Contacts" ], "summary": "Post PortalSecurity", "operationId": "postCompanyContactsRequestPassword", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestPasswordRequest" } } }, "required": true }, "responses": { "204": { "description": "Email sent to email address in request." } } } }, "/company/contacts/types": { "get": { "tags": [ "ContactTypes" ], "summary": "Get List of ContactType", "operationId": "getCompanyContactsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactType" } } } } } } }, "post": { "tags": [ "ContactTypes" ], "summary": "Post ContactType", "operationId": "postCompanyContactsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactType" } } }, "required": true }, "responses": { "201": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } } }, "/company/contacts/types/{id}": { "get": { "tags": [ "ContactTypes" ], "summary": "Get ContactType", "operationId": "getCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } }, "delete": { "tags": [ "ContactTypes" ], "summary": "Delete ContactType", "operationId": "deleteCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactTypes" ], "summary": "Put ContactType", "operationId": "putCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactType" } } }, "required": true }, "responses": { "200": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } }, "patch": { "tags": [ "ContactTypes" ], "summary": "Patch ContactType", "operationId": "patchCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } } }, "/company/contacts/types/{id}/info": { "get": { "tags": [ "ContactTypes" ], "summary": "Get ContactTypeInfo", "operationId": "getCompanyContactsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTypInfoe", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ContactTypeInfo" } } } } } } }, "/company/contacts/types/count": { "get": { "tags": [ "ContactTypes" ], "summary": "Get Count of ContactType", "operationId": "getCompanyContactsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/types/count/info": { "get": { "tags": [ "ContactTypes" ], "summary": "Get Count of ContactTypeInfo", "operationId": "getCompanyContactsTypesCountInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/types/info": { "get": { "tags": [ "ContactTypes" ], "summary": "Get List of ContactTypeInfo", "operationId": "getCompanyContactsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeInfo" } } } } } } } }, "/company/contacts/validatePortalCredentials": { "post": { "tags": [ "Contacts" ], "summary": "Post ValidatePortalResponse", "operationId": "postCompanyContactsValidatePortalCredentials", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidatePortalRequest" } } }, "required": true }, "responses": { "200": { "description": "ValidatePortalResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ValidatePortalResponse" } } } } } } }, "/company/contactTypeAssociations": { "get": { "tags": [ "ContactTypeAssociations" ], "summary": "Get List of ContactTypeAssociation", "operationId": "getCompanyContactTypeAssociations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } } } } } }, "post": { "tags": [ "ContactTypeAssociations" ], "summary": "Post ContactTypeAssociation", "operationId": "postCompanyContactTypeAssociations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } }, "required": true }, "responses": { "201": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } } } } } }, "/company/contactTypeAssociations/{id}": { "get": { "tags": [ "ContactTypeAssociations" ], "summary": "Get ContactTypeAssociation", "operationId": "getCompanyContactTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "contactTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } } } } }, "delete": { "tags": [ "ContactTypeAssociations" ], "summary": "Delete ContactTypeAssociation", "operationId": "deleteCompanyContactTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "contactTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactTypeAssociations" ], "summary": "Put ContactTypeAssociation", "operationId": "putCompanyContactTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "contactTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } }, "required": true }, "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } } } } }, "patch": { "tags": [ "ContactTypeAssociations" ], "summary": "Patch ContactTypeAssociation", "operationId": "patchCompanyContactTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "contactTypeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Company.ContactTypeAssociation" } } } } } } }, "/company/contactTypeAssociations/count": { "get": { "tags": [ "ContactTypeAssociations" ], "summary": "Get Count of ContactTypeAssociation", "operationId": "getCompanyContactTypeAssociationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/countries": { "get": { "tags": [ "Countries" ], "summary": "Get List of", "operationId": "getCompanyCountries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Country", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } }, "post": { "tags": [ "Countries" ], "summary": "Post Count of", "operationId": "postCompanyCountries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "country", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country" } } }, "required": true }, "responses": { "201": { "description": "Country", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Country" } } } } } } }, "/company/countries/{id}": { "get": { "tags": [ "Countries" ], "summary": "Get Count of", "operationId": "getCompanyCountriesById", "parameters": [ { "name": "id", "in": "path", "description": "countryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Country", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Country" } } } } } }, "delete": { "tags": [ "Countries" ], "summary": "Delete", "operationId": "deleteCompanyCountriesById", "parameters": [ { "name": "id", "in": "path", "description": "countryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Countries" ], "summary": "Put Count of", "operationId": "putCompanyCountriesById", "parameters": [ { "name": "id", "in": "path", "description": "countryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "country", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country" } } }, "required": true }, "responses": { "200": { "description": "Country", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Country" } } } } } }, "patch": { "tags": [ "Countries" ], "summary": "Patch Count of", "operationId": "patchCompanyCountriesById", "parameters": [ { "name": "id", "in": "path", "description": "countryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Country", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Country" } } } } } } }, "/company/countries/{id}/info": { "get": { "tags": [ "CountryInfos" ], "summary": "Get CountryInfos", "operationId": "getCompanyCountriesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "CountryInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CountryInfo" } } } } } } }, "/company/countries/count": { "get": { "tags": [ "Countries" ], "summary": "Get Count of", "operationId": "getCompanyCountriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/countries/info": { "get": { "tags": [ "CountryInfos" ], "summary": "Get List of CountryInfos", "operationId": "getCompanyCountriesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of countryInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryInfo" } } } } } } } }, "/company/countries/info/count": { "get": { "tags": [ "CountryInfos" ], "summary": "Get Count of CountryInfos", "operationId": "getCompanyCountriesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/entityTypes": { "get": { "tags": [ "EntityTypes" ], "summary": "Get List of EntityType", "operationId": "getCompanyEntityTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EntityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntityType" } } } } } } } }, "/company/entityTypes/{id}": { "get": { "tags": [ "EntityTypes" ], "summary": "Get EntityType", "operationId": "getCompanyEntityTypesById", "parameters": [ { "name": "id", "in": "path", "description": "entityTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EntityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EntityType" } } } } } } }, "/company/entitytypes/{id}/info": { "get": { "tags": [ "EntityTypeInfos" ], "summary": "Get EntityTypeInfos", "operationId": "getCompanyEntitytypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "EntityTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EntityTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EntityTypeInfo" } } } } } } }, "/company/entityTypes/count": { "get": { "tags": [ "EntityTypes" ], "summary": "Get Count of EntityType", "operationId": "getCompanyEntityTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/entitytypes/info": { "get": { "tags": [ "EntityTypeInfos" ], "summary": "Get List of EntityTypeInfos", "operationId": "getCompanyEntitytypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of entityTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntityTypeInfo" } } } } } } } }, "/company/entityTypes/info/count": { "get": { "tags": [ "EntityTypeInfos" ], "summary": "Get Count of EntityTypeInfos", "operationId": "getCompanyEntityTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/expenseTypes/info/count": { "get": { "tags": [ "ExpenseTypeInfos" ], "summary": "Get Count of ExpenseTypeInfos", "operationId": "getCompanyExpenseTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/m365contact": { "get": { "tags": [ "M365Contacts" ], "summary": "Get List of M365Contacts", "operationId": "getCompanyM365contact", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of m365Contacts", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/M365Contact" } } } } } } } }, "/company/m365contact/{id}": { "get": { "tags": [ "M365Contacts" ], "summary": "Get M365Contacts", "operationId": "getCompanyM365contactById", "parameters": [ { "name": "id", "in": "path", "description": "M365ContactyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "M365Contact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365Contact" } } } } } } }, "/company/m365contact/count": { "get": { "tags": [ "M365Contacts" ], "summary": "Get Count of M365Contacts", "operationId": "getCompanyM365contactCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/m365contactsync/{id}/property": { "get": { "tags": [ "M365ContactSyncProperties" ], "summary": "Get M365ContactSyncProperties", "operationId": "getCompanyM365contactsyncByIdProperty", "parameters": [ { "name": "id", "in": "path", "description": "M365ContactSyncPropertyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "M365ContactSyncProperty", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncProperty" } } } } } } }, "/company/m365contactsync/property": { "post": { "tags": [ "M365ContactSyncProperties" ], "summary": "Create M365ContactSyncProperty", "operationId": "postCompanyM365contactsyncProperty", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "country", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/M365ContactSyncProperty" } } }, "required": true }, "responses": { "201": { "description": "Country", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncProperty" } } } } } } }, "/company/m365contactsync/property/": { "delete": { "tags": [ "M365ContactSyncProperties" ], "summary": "Delete M365ContactSyncProperty", "operationId": "deleteCompanyM365contactsyncProperty", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/m365contactsync/property/count": { "get": { "tags": [ "M365ContactSyncProperties" ], "summary": "Get Count of M365ContactSyncProperty", "operationId": "getCompanyM365contactsyncPropertyCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/m365contactsync/property/excluded": { "get": { "tags": [ "M365ContactSyncProperties" ], "summary": "Get List of M365ContactSyncPropertiesExcluded", "operationId": "getCompanyM365contactsyncPropertyExcluded", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "companyRecId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "List of m365ContactSyncProperties", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/M365ContactSyncProperty" } } } } } } } }, "/company/m365contactsync/property/included": { "get": { "tags": [ "M365ContactSyncProperties" ], "summary": "Get List of M365ContactSyncPropertiesIncluded", "operationId": "getCompanyM365contactsyncPropertyIncluded", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "companyRecId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "List of m365ContactSyncProperties", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/M365ContactSyncProperty" } } } } } } } }, "/company/managedDevicesIntegrations": { "get": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Get List of ManagedDevicesIntegration", "operationId": "getCompanyManagedDevicesIntegrations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagedDevicesIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } } } } } }, "post": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Post ManagedDevicesIntegration", "operationId": "postCompanyManagedDevicesIntegrations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managedDevicesIntegration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } }, "required": true }, "responses": { "201": { "description": "ManagedDevicesIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } } } } } }, "/company/managedDevicesIntegrations/{id}": { "get": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Get ManagedDevicesIntegration", "operationId": "getCompanyManagedDevicesIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } } } } }, "delete": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Delete ManagedDevicesIntegration", "operationId": "deleteCompanyManagedDevicesIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Put ManagedDevicesIntegration", "operationId": "putCompanyManagedDevicesIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managedDevicesIntegration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } } } } }, "patch": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Patch ManagedDevicesIntegration", "operationId": "patchCompanyManagedDevicesIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegration" } } } } } } }, "/company/managedDevicesIntegrations/{id}/info": { "get": { "tags": [ "ManagedDevicesIntegrationInfos" ], "summary": "Get ManagedDevicesIntegrationInfos", "operationId": "getCompanyManagedDevicesIntegrationsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ManagedDevicesIntegrationInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationInfo" } } } } } } }, "/company/managedDevicesIntegrations/{id}/usages": { "get": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Get List of Usage Count", "operationId": "getCompanyManagedDevicesIntegrationsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/managedDevicesIntegrations/{id}/usages/list": { "get": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Get List of Usage", "operationId": "getCompanyManagedDevicesIntegrationsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/crossReferences": { "get": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Get List of ManagedDevicesIntegrationCrossReference", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdCrossReferences", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagedDevicesIntegrationCrossReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } } } } } }, "post": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Post ManagedDevicesIntegrationCrossReference", "operationId": "postCompanyManagedDevicesIntegrationsByParentIdCrossReferences", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "crossReference", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationCrossReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/crossReferences/{id}": { "get": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Get ManagedDevicesIntegrationCrossReference", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById", "parameters": [ { "name": "id", "in": "path", "description": "crossReferenceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationCrossReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } } } } }, "put": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Put ManagedDevicesIntegrationCrossReference", "operationId": "putCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById", "parameters": [ { "name": "id", "in": "path", "description": "crossReferenceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "crossReference", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationCrossReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } } } } }, "patch": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Patch ManagedDevicesIntegrationCrossReference", "operationId": "patchCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById", "parameters": [ { "name": "id", "in": "path", "description": "crossReferenceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationCrossReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } } } } }, "delete": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Delete ManagedDevicesIntegrationCrossReference", "operationId": "deleteCompanyManagedDevicesIntegrationsByParentIdCrossReferencesById", "parameters": [ { "name": "id", "in": "path", "description": "crossReferenceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationCrossReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationCrossReference" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/crossReferences/count": { "get": { "tags": [ "ManagedDevicesIntegrationCrossReferences" ], "summary": "Get Count of ManagedDevicesIntegrationCrossReference", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdCrossReferencesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/logins": { "get": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Get List of ManagedDevicesIntegrationLogin", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdLogins", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagedDevicesIntegrationLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } } } } } }, "post": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Post ManagedDevicesIntegrationLogin", "operationId": "postCompanyManagedDevicesIntegrationsByParentIdLogins", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "login", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/logins/{id}": { "get": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Get ManagedDevicesIntegrationLogin", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdLoginsById", "parameters": [ { "name": "id", "in": "path", "description": "loginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } } } } }, "put": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Put ManagedDevicesIntegrationLogin", "operationId": "putCompanyManagedDevicesIntegrationsByParentIdLoginsById", "parameters": [ { "name": "id", "in": "path", "description": "loginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "login", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } } } } }, "patch": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Patch ManagedDevicesIntegrationLogin", "operationId": "patchCompanyManagedDevicesIntegrationsByParentIdLoginsById", "parameters": [ { "name": "id", "in": "path", "description": "loginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } } } } }, "delete": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Delete ManagedDevicesIntegrationLogin", "operationId": "deleteCompanyManagedDevicesIntegrationsByParentIdLoginsById", "parameters": [ { "name": "id", "in": "path", "description": "loginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationLogin" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/logins/count": { "get": { "tags": [ "ManagedDevicesIntegrationLogins" ], "summary": "Get Count of ManagedDevicesIntegrationLogin", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdLoginsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/notifications": { "get": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Get List of ManagedDevicesIntegrationNotification", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagedDevicesIntegrationNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } } } } } }, "post": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Post ManagedDevicesIntegrationNotification", "operationId": "postCompanyManagedDevicesIntegrationsByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "notification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/notifications/{id}": { "get": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Get ManagedDevicesIntegrationNotification", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } } } } }, "put": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Put ManagedDevicesIntegrationNotification", "operationId": "putCompanyManagedDevicesIntegrationsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "notification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } } } } }, "patch": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Patch ManagedDevicesIntegrationNotification", "operationId": "patchCompanyManagedDevicesIntegrationsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagedDevicesIntegrationNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } } } } }, "delete": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Delete ManagedDevicesIntegrationNotification", "operationId": "deleteCompanyManagedDevicesIntegrationsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagedDevicesIntegrationNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagedDevicesIntegrationNotification" } } } } } } }, "/company/managedDevicesIntegrations/{parentId}/notifications/count": { "get": { "tags": [ "ManagedDevicesIntegrationNotifications" ], "summary": "Get Count of ManagedDevicesIntegrationNotification", "operationId": "getCompanyManagedDevicesIntegrationsByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "managedDevicesIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managedDevicesIntegrations/count": { "get": { "tags": [ "ManagedDevicesIntegrations" ], "summary": "Get Count of Usage", "operationId": "getCompanyManagedDevicesIntegrationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managedDevicesIntegrations/info": { "get": { "tags": [ "ManagedDevicesIntegrationInfos" ], "summary": "Get List of ManagedDevicesIntegrationInfos", "operationId": "getCompanyManagedDevicesIntegrationsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of managedDevicesIntegrationInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDevicesIntegrationInfo" } } } } } } } }, "/company/managedDevicesIntegrations/info/count": { "get": { "tags": [ "ManagedDevicesIntegrationInfos" ], "summary": "Get Count of ManagedDevicesIntegrationInfos", "operationId": "getCompanyManagedDevicesIntegrationsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/management": { "get": { "tags": [ "Managements" ], "summary": "Get List of Management", "operationId": "getCompanyManagement", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Management", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Management" } } } } } } } }, "/company/management/{id}": { "get": { "tags": [ "Managements" ], "summary": "Get Management", "operationId": "getCompanyManagementById", "parameters": [ { "name": "id", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Management", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Management" } } } } } }, "put": { "tags": [ "Managements" ], "summary": "Put Management", "operationId": "putCompanyManagementById", "parameters": [ { "name": "id", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "management", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Management" } } }, "required": true }, "responses": { "200": { "description": "Management", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Management" } } } } } }, "patch": { "tags": [ "Managements" ], "summary": "Patch Management", "operationId": "patchCompanyManagementById", "parameters": [ { "name": "id", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Management", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Management" } } } } } } }, "/company/management/{id}/executeManagedItSync": { "post": { "tags": [ "ManagementExecuteManagedItSyncs" ], "summary": "Post SuccessResponse", "operationId": "postCompanyManagementByIdExecuteManagedItSync", "parameters": [ { "name": "id", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/company/management/{id}/log/download": { "get": { "tags": [ "ManagementLogs" ], "summary": "Get ManagementLogDocumentInfo", "operationId": "getCompanyManagementByIdLogDownload", "parameters": [ { "name": "id", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "filePath", "in": "path", "description": "filePath", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/company/management/{id}/logs": { "get": { "tags": [ "ManagementLogs" ], "summary": "Get List of ManagementLogDocumentInfo", "operationId": "getCompanyManagementByIdLogs", "parameters": [ { "name": "id", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementLogDocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementLogDocumentInfo" } } } } } } } }, "/company/management/{parentId}/managementReportNotifications": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get List of ManagementReportNotification", "operationId": "getCompanyManagementByParentIdManagementReportNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "post": { "tags": [ "ManagementReportNotifications" ], "summary": "Post ManagementReportNotification", "operationId": "postCompanyManagementByParentIdManagementReportNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } }, "required": true }, "responses": { "201": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "/company/management/{parentId}/managementReportNotifications/{id}": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get ManagementReportNotification", "operationId": "getCompanyManagementByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } }, "delete": { "tags": [ "ManagementReportNotifications" ], "summary": "Delete ManagementReportNotification", "operationId": "deleteCompanyManagementByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagementReportNotifications" ], "summary": "Put ManagementReportNotification", "operationId": "putCompanyManagementByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } }, "required": true }, "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } }, "patch": { "tags": [ "ManagementReportNotifications" ], "summary": "Patch ManagementReportNotification", "operationId": "patchCompanyManagementByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "/company/management/{parentId}/managementReportNotifications/count": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get Count of ManagementReportNotification", "operationId": "getCompanyManagementByParentIdManagementReportNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "managementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/management/count": { "get": { "tags": [ "Managements" ], "summary": "Get Count of Management", "operationId": "getCompanyManagementCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managementBackups": { "get": { "tags": [ "ManagementBackup" ], "summary": "Get List of ManagementBackup", "operationId": "getCompanyManagementBackups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementBackup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementBackup" } } } } } } }, "post": { "tags": [ "ManagementBackup" ], "summary": "Post ManagementBackup", "operationId": "postCompanyManagementBackups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementBackup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementBackup" } } }, "required": true }, "responses": { "201": { "description": "ManagementBackup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementBackup" } } } } } } }, "/company/managementBackups/{id}": { "get": { "tags": [ "ManagementBackup" ], "summary": "Get ManagementBackup", "operationId": "getCompanyManagementBackupsById", "parameters": [ { "name": "id", "in": "path", "description": "managementBackupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementBackup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementBackup" } } } } } }, "delete": { "tags": [ "ManagementBackup" ], "summary": "Delete ManagementBackup", "operationId": "deleteCompanyManagementBackupsById", "parameters": [ { "name": "id", "in": "path", "description": "managementBackupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagementBackup" ], "summary": "Put ManagementBackup", "operationId": "putCompanyManagementBackupsById", "parameters": [ { "name": "id", "in": "path", "description": "managementBackupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementBackup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementBackup" } } }, "required": true }, "responses": { "200": { "description": "ManagementBackup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementBackup" } } } } } }, "patch": { "tags": [ "ManagementBackup" ], "summary": "Patch ManagementBackup", "operationId": "patchCompanyManagementBackupsById", "parameters": [ { "name": "id", "in": "path", "description": "managementBackupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementBackup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementBackup" } } } } } } }, "/company/managementBackups/count": { "get": { "tags": [ "ManagementBackup" ], "summary": "Get Count of ManagementBackup", "operationId": "getCompanyManagementBackupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managementItSolutions": { "get": { "tags": [ "ManagementItSolutions" ], "summary": "Get List of ManagementItSolution", "operationId": "getCompanyManagementItSolutions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementItSolution", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementItSolution" } } } } } } }, "post": { "tags": [ "ManagementItSolutions" ], "summary": "Post ManagementItSolution", "operationId": "postCompanyManagementItSolutions", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementItSolution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementItSolution" } } }, "required": true }, "responses": { "201": { "description": "ManagementItSolution", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolution" } } } } } } }, "/company/managementItSolutions/{id}": { "get": { "tags": [ "ManagementItSolutions" ], "summary": "Get ManagementItSolution", "operationId": "getCompanyManagementItSolutionsById", "parameters": [ { "name": "id", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementItSolution", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolution" } } } } } }, "delete": { "tags": [ "ManagementItSolutions" ], "summary": "Delete ManagementItSolution", "operationId": "deleteCompanyManagementItSolutionsById", "parameters": [ { "name": "id", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagementItSolutions" ], "summary": "Put ManagementItSolution", "operationId": "putCompanyManagementItSolutionsById", "parameters": [ { "name": "id", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementItSolution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementItSolution" } } }, "required": true }, "responses": { "200": { "description": "ManagementItSolution", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolution" } } } } } }, "patch": { "tags": [ "ManagementItSolutions" ], "summary": "Patch ManagementItSolution", "operationId": "patchCompanyManagementItSolutionsById", "parameters": [ { "name": "id", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementItSolution", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolution" } } } } } } }, "/company/managementItSolutions/{id}/usages": { "get": { "tags": [ "ManagementItSolutions" ], "summary": "Get List of Usage Count", "operationId": "getCompanyManagementItSolutionsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/managementItSolutions/{id}/usages/list": { "get": { "tags": [ "ManagementItSolutions" ], "summary": "Get List of Usage", "operationId": "getCompanyManagementItSolutionsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/managementItSolutions/{parentId}/managementProducts": { "get": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Get List of ManagementItSolutionAgreementInterfaceParameter", "operationId": "getCompanyManagementItSolutionsByParentIdManagementProducts", "parameters": [ { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementItSolutionAgreementInterfaceParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } } } } } }, "post": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Post ManagementItSolutionAgreementInterfaceParameter", "operationId": "postCompanyManagementItSolutionsByParentIdManagementProducts", "parameters": [ { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementProduct", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } }, "required": true }, "responses": { "200": { "description": "ManagementItSolutionAgreementInterfaceParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } } } } } }, "/company/managementItSolutions/{parentId}/managementProducts/{id}": { "get": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Get ManagementItSolutionAgreementInterfaceParameter", "operationId": "getCompanyManagementItSolutionsByParentIdManagementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "managementProductId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementItSolutionAgreementInterfaceParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } } } } }, "put": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Put ManagementItSolutionAgreementInterfaceParameter", "operationId": "putCompanyManagementItSolutionsByParentIdManagementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "managementProductId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementProduct", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } }, "required": true }, "responses": { "200": { "description": "ManagementItSolutionAgreementInterfaceParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } } } } }, "patch": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Patch ManagementItSolutionAgreementInterfaceParameter", "operationId": "patchCompanyManagementItSolutionsByParentIdManagementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "managementProductId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementItSolutionAgreementInterfaceParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } } } } }, "delete": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Delete ManagementItSolutionAgreementInterfaceParameter", "operationId": "deleteCompanyManagementItSolutionsByParentIdManagementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "managementProductId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementItSolutionAgreementInterfaceParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementItSolutionAgreementInterfaceParameter" } } } } } } }, "/company/managementItSolutions/{parentId}/managementProducts/count": { "get": { "tags": [ "ManagementItSolutionAgreementInterfaceParameters" ], "summary": "Get Count of ManagementItSolutionAgreementInterfaceParameter", "operationId": "getCompanyManagementItSolutionsByParentIdManagementProductsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "managementItSolutionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/managementItSolutions/count": { "get": { "tags": [ "ManagementItSolutions" ], "summary": "Get Count of ManagementItSolution", "operationId": "getCompanyManagementItSolutionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/marketDescriptions": { "get": { "tags": [ "CompanyMarketDescription" ], "summary": "Get List of MarketDescription", "operationId": "getCompanyMarketDescriptions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MarketDescription", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketDescription" } } } } } } }, "post": { "tags": [ "CompanyMarketDescription" ], "summary": "Post MarketDescription", "operationId": "postCompanyMarketDescriptions", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketDescription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketDescription" } } }, "required": true }, "responses": { "201": { "description": "MarketDescription", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketDescription" } } } } } } }, "/company/marketDescriptions/{id}": { "get": { "tags": [ "CompanyMarketDescription" ], "summary": "Get MarketDescription", "operationId": "getCompanyMarketDescriptionsById", "parameters": [ { "name": "id", "in": "path", "description": "marketDescriptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MarketDescription", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketDescription" } } } } } }, "delete": { "tags": [ "CompanyMarketDescription" ], "summary": "Delete MarketDescription", "operationId": "deleteCompanyMarketDescriptionsById", "parameters": [ { "name": "id", "in": "path", "description": "marketDescriptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyMarketDescription" ], "summary": "Put MarketDescription", "operationId": "putCompanyMarketDescriptionsById", "parameters": [ { "name": "id", "in": "path", "description": "marketDescriptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketDescription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketDescription" } } }, "required": true }, "responses": { "200": { "description": "MarketDescription", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketDescription" } } } } } }, "patch": { "tags": [ "CompanyMarketDescription" ], "summary": "Patch MarketDescription", "operationId": "patchCompanyMarketDescriptionsById", "parameters": [ { "name": "id", "in": "path", "description": "marketDescriptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MarketDescription", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketDescription" } } } } } } }, "/company/marketDescriptions/{id}/info": { "get": { "tags": [ "MarketDescriptionInfos" ], "summary": "Get MarketDescriptionInfos", "operationId": "getCompanyMarketDescriptionsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "MarketDescriptionInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MarketDescriptionInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketDescriptionInfo" } } } } } } }, "/company/marketDescriptions/{id}/usages": { "get": { "tags": [ "CompanyMarketDescription" ], "summary": "Get List of Usage Count", "operationId": "getCompanyMarketDescriptionsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "marketDescriptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/marketDescriptions/{id}/usages/list": { "get": { "tags": [ "CompanyMarketDescription" ], "summary": "Get List of Usage", "operationId": "getCompanyMarketDescriptionsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "marketDescriptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/marketDescriptions/count": { "get": { "tags": [ "CompanyMarketDescription" ], "summary": "Get Count of MarketDescription", "operationId": "getCompanyMarketDescriptionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/marketDescriptions/info": { "get": { "tags": [ "MarketDescriptionInfos" ], "summary": "Get List of MarketDescriptionInfos", "operationId": "getCompanyMarketDescriptionsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of marketDescriptionInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketDescriptionInfo" } } } } } } } }, "/company/marketDescriptions/info/count": { "get": { "tags": [ "MarketDescriptionInfos" ], "summary": "Get Count of MarketDescriptionInfos", "operationId": "getCompanyMarketDescriptionsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/noteTypes": { "get": { "tags": [ "CompanyNoteTypes" ], "summary": "Get List of CompanyNoteType", "operationId": "getCompanyNoteTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } } }, "post": { "tags": [ "CompanyNoteTypes" ], "summary": "Post CompanyNoteType", "operationId": "postCompanyNoteTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "noteType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } }, "required": true }, "responses": { "201": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } } }, "/company/noteTypes/{id}": { "get": { "tags": [ "CompanyNoteTypes" ], "summary": "Get CompanyNoteType", "operationId": "getCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } }, "delete": { "tags": [ "CompanyNoteTypes" ], "summary": "Delete CompanyNoteType", "operationId": "deleteCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyNoteTypes" ], "summary": "Put CompanyNoteType", "operationId": "putCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "noteType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } }, "required": true }, "responses": { "200": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } }, "patch": { "tags": [ "CompanyNoteTypes" ], "summary": "Patch CompanyNoteType", "operationId": "patchCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } } }, "/company/noteTypes/{id}/info": { "get": { "tags": [ "CompanyNoteTypeInfo" ], "summary": "Get CompanyNoteTypeInfo", "operationId": "getCompanyNoteTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyNoteTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyNoteTypeInfo" } } } } } } }, "/company/noteTypes/count": { "get": { "tags": [ "CompanyNoteTypes" ], "summary": "Get Count of CompanyNoteType", "operationId": "getCompanyNoteTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/noteTypes/count/info": { "get": { "tags": [ "CompanyNoteTypeInfo" ], "summary": "Get Count of CompanyNoteTypeInfo", "operationId": "getCompanyNoteTypesCountInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/noteTypes/info": { "get": { "tags": [ "CompanyNoteTypeInfo" ], "summary": "Get List of CompanyNoteTypeInfo", "operationId": "getCompanyNoteTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyNoteTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNoteTypeInfo" } } } } } } } }, "/company/ownershipTypes": { "get": { "tags": [ "CompanyOwnershipType" ], "summary": "Get List of OwnershipType", "operationId": "getCompanyOwnershipTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OwnershipType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OwnershipType" } } } } } } }, "post": { "tags": [ "CompanyOwnershipType" ], "summary": "Post OwnershipType", "operationId": "postCompanyOwnershipTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ownershipType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipType" } } }, "required": true }, "responses": { "201": { "description": "OwnershipType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OwnershipType" } } } } } } }, "/company/ownershipTypes/{id}": { "get": { "tags": [ "CompanyOwnershipType" ], "summary": "Get OwnershipType", "operationId": "getCompanyOwnershipTypesById", "parameters": [ { "name": "id", "in": "path", "description": "ownershipTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OwnershipType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OwnershipType" } } } } } }, "delete": { "tags": [ "CompanyOwnershipType" ], "summary": "Delete OwnershipType", "operationId": "deleteCompanyOwnershipTypesById", "parameters": [ { "name": "id", "in": "path", "description": "ownershipTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyOwnershipType" ], "summary": "Put OwnershipType", "operationId": "putCompanyOwnershipTypesById", "parameters": [ { "name": "id", "in": "path", "description": "ownershipTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ownershipType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnershipType" } } }, "required": true }, "responses": { "200": { "description": "OwnershipType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OwnershipType" } } } } } }, "patch": { "tags": [ "CompanyOwnershipType" ], "summary": "Patch OwnershipType", "operationId": "patchCompanyOwnershipTypesById", "parameters": [ { "name": "id", "in": "path", "description": "ownershipTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OwnershipType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OwnershipType" } } } } } } }, "/company/ownershipTypes/{id}/info": { "get": { "tags": [ "OwnershipTypeInfos" ], "summary": "Get OwnershipTypeInfos", "operationId": "getCompanyOwnershipTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "OwnershipTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OwnershipTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OwnershipTypeInfo" } } } } } } }, "/company/ownershipTypes/count": { "get": { "tags": [ "CompanyOwnershipType" ], "summary": "Get Count of OwnershipType", "operationId": "getCompanyOwnershipTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/ownershipTypes/info": { "get": { "tags": [ "OwnershipTypeInfos" ], "summary": "Get List of OwnershipTypeInfos", "operationId": "getCompanyOwnershipTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ownershipTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OwnershipTypeInfo" } } } } } } } }, "/company/ownershipTypes/info/count": { "get": { "tags": [ "OwnershipTypeInfos" ], "summary": "Get Count of OwnershipTypeInfos", "operationId": "getCompanyOwnershipTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/paymentTypes/info/count": { "get": { "tags": [ "PaymentTypeInfos" ], "summary": "Get Count of PaymentTypeInfos", "operationId": "getCompanyPaymentTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalConfigurations": { "get": { "tags": [ "PortalConfigurations" ], "summary": "Get List of PortalConfiguration", "operationId": "getCompanyPortalConfigurations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfiguration" } } } } } } }, "post": { "tags": [ "PortalConfigurations" ], "summary": "Post PortalConfiguration", "operationId": "postCompanyPortalConfigurations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } }, "required": true }, "responses": { "201": { "description": "PortalConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } } } } } }, "/company/portalConfigurations/{id}": { "get": { "tags": [ "PortalConfigurations" ], "summary": "Get PortalConfiguration", "operationId": "getCompanyPortalConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } } } } }, "delete": { "tags": [ "PortalConfigurations" ], "summary": "Delete PortalConfiguration", "operationId": "deleteCompanyPortalConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PortalConfigurations" ], "summary": "Put PortalConfiguration", "operationId": "putCompanyPortalConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } }, "required": true }, "responses": { "200": { "description": "PortalConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } } } } }, "patch": { "tags": [ "PortalConfigurations" ], "summary": "Patch PortalConfiguration", "operationId": "patchCompanyPortalConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } } } } } }, "/company/portalConfigurations/{parentId}/invoiceSetups": { "get": { "tags": [ "PortalConfigurationsInvoiceSetups" ], "summary": "Get List of PortalConfigurationInvoiceSetup", "operationId": "getCompanyPortalConfigurationsByParentIdInvoiceSetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfigurationInvoiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfigurationInvoiceSetup" } } } } } } } }, "/company/portalConfigurations/{parentId}/invoiceSetups/{id}": { "get": { "tags": [ "PortalConfigurationsInvoiceSetups" ], "summary": "Get PortalConfigurationInvoiceSetup", "operationId": "getCompanyPortalConfigurationsByParentIdInvoiceSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfigurationInvoiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationInvoiceSetup" } } } } } }, "put": { "tags": [ "PortalConfigurationsInvoiceSetups" ], "summary": "Put PortalConfigurationInvoiceSetup", "operationId": "putCompanyPortalConfigurationsByParentIdInvoiceSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalConfigurationInvoiceSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationInvoiceSetup" } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationInvoiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationInvoiceSetup" } } } } } }, "patch": { "tags": [ "PortalConfigurationsInvoiceSetups" ], "summary": "Patch PortalConfigurationInvoiceSetup", "operationId": "patchCompanyPortalConfigurationsByParentIdInvoiceSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationInvoiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationInvoiceSetup" } } } } } } }, "/company/portalConfigurations/{parentId}/invoiceSetups/{id}/testTransaction": { "post": { "tags": [ "PortalConfigurationsInvoiceSetups" ], "summary": "Post SuccessResponse", "operationId": "postCompanyPortalConfigurationsByParentIdInvoiceSetupsByIdTestTransaction", "parameters": [ { "name": "id", "in": "path", "description": "invoiceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalConfigurationInvoiceSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationInvoiceSetup" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/company/portalConfigurations/{parentId}/invoiceSetups/count": { "get": { "tags": [ "PortalConfigurationsInvoiceSetups" ], "summary": "Get Count of PortalConfigurationInvoiceSetup", "operationId": "getCompanyPortalConfigurationsByParentIdInvoiceSetupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalConfigurations/{parentId}/opportunitySetups": { "get": { "tags": [ "PortalConfigurationOpportunitySetups" ], "summary": "Get List of PortalConfigurationOpportunitySetup", "operationId": "getCompanyPortalConfigurationsByParentIdOpportunitySetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfigurationOpportunitySetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } } } } } }, "put": { "tags": [ "PortalConfigurationOpportunitySetups" ], "summary": "Put PortalConfigurationOpportunitySetup", "operationId": "putCompanyPortalConfigurationsByParentIdOpportunitySetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunitySetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationOpportunitySetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } } } } }, "patch": { "tags": [ "PortalConfigurationOpportunitySetups" ], "summary": "Patch PortalConfigurationOpportunitySetup", "operationId": "patchCompanyPortalConfigurationsByParentIdOpportunitySetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationOpportunitySetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } } } } } }, "/company/portalConfigurations/{parentId}/opportunitySetups/{id}": { "get": { "tags": [ "PortalConfigurationOpportunitySetups" ], "summary": "Get PortalConfigurationOpportunitySetup", "operationId": "getCompanyPortalConfigurationsByParentIdOpportunitySetupsById", "parameters": [ { "name": "id", "in": "path", "description": "opportunitySetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfigurationOpportunitySetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } } } } }, "put": { "tags": [ "PortalConfigurationOpportunitySetups" ], "summary": "Put PortalConfigurationOpportunitySetup", "operationId": "putCompanyPortalConfigurationsByParentIdOpportunitySetupsById", "parameters": [ { "name": "id", "in": "path", "description": "opportunitySetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunitySetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationOpportunitySetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } } } } }, "patch": { "tags": [ "PortalConfigurationOpportunitySetups" ], "summary": "Patch PortalConfigurationOpportunitySetup", "operationId": "patchCompanyPortalConfigurationsByParentIdOpportunitySetupsById", "parameters": [ { "name": "id", "in": "path", "description": "opportunitySetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationOpportunitySetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationOpportunitySetup" } } } } } } }, "/company/portalConfigurations/{parentId}/passwordEmailSetups": { "get": { "tags": [ "PortalConfigurationPasswordEmailSetups" ], "summary": "Get List of PortalConfigurationPasswordEmailSetup", "operationId": "getCompanyPortalConfigurationsByParentIdPasswordEmailSetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfigurationPasswordEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfigurationPasswordEmailSetup" } } } } } } } }, "/company/portalConfigurations/{parentId}/passwordEmailSetups/{id}": { "get": { "tags": [ "PortalConfigurationPasswordEmailSetups" ], "summary": "Get PortalConfigurationPasswordEmailSetup", "operationId": "getCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "passwordEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfigurationPasswordEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationPasswordEmailSetup" } } } } } }, "put": { "tags": [ "PortalConfigurationPasswordEmailSetups" ], "summary": "Put PortalConfigurationPasswordEmailSetup", "operationId": "putCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "passwordEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "passwordEmailSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationPasswordEmailSetup" } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationPasswordEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationPasswordEmailSetup" } } } } } }, "patch": { "tags": [ "PortalConfigurationPasswordEmailSetups" ], "summary": "Patch PortalConfigurationPasswordEmailSetup", "operationId": "patchCompanyPortalConfigurationsByParentIdPasswordEmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "passwordEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationPasswordEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationPasswordEmailSetup" } } } } } } }, "/company/portalConfigurations/{parentId}/projectSetups": { "get": { "tags": [ "PortalConfigurationProjectSetups" ], "summary": "Get List of PortalConfigurationProjectSetup", "operationId": "getCompanyPortalConfigurationsByParentIdProjectSetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfigurationProjectSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfigurationProjectSetup" } } } } } } } }, "/company/portalConfigurations/{parentId}/projectSetups/{id}": { "get": { "tags": [ "PortalConfigurationProjectSetups" ], "summary": "Get PortalConfigurationProjectSetup", "operationId": "getCompanyPortalConfigurationsByParentIdProjectSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "projectSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfigurationProjectSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationProjectSetup" } } } } } }, "put": { "tags": [ "PortalConfigurationProjectSetups" ], "summary": "Put PortalConfigurationProjectSetup", "operationId": "putCompanyPortalConfigurationsByParentIdProjectSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "projectSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalConfigurationProjectSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationProjectSetup" } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationProjectSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationProjectSetup" } } } } } }, "patch": { "tags": [ "PortalConfigurationProjectSetups" ], "summary": "Patch PortalConfigurationProjectSetup", "operationId": "patchCompanyPortalConfigurationsByParentIdProjectSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "projectSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationProjectSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationProjectSetup" } } } } } } }, "/company/portalConfigurations/{parentId}/projectSetups/count": { "get": { "tags": [ "PortalConfigurationProjectSetups" ], "summary": "Get Count of PortalConfigurationProjectSetup", "operationId": "getCompanyPortalConfigurationsByParentIdProjectSetupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalConfigurations/{parentId}/serviceSetups": { "get": { "tags": [ "PortalConfigurationServiceSetups" ], "summary": "Get List of PortalConfigurationServiceSetup", "operationId": "getCompanyPortalConfigurationsByParentIdServiceSetups", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfigurationServiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfigurationServiceSetup" } } } } } } } }, "/company/portalConfigurations/{parentId}/serviceSetups/{id}": { "get": { "tags": [ "PortalConfigurationServiceSetups" ], "summary": "Get PortalConfigurationServiceSetup", "operationId": "getCompanyPortalConfigurationsByParentIdServiceSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfigurationServiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationServiceSetup" } } } } } }, "put": { "tags": [ "PortalConfigurationServiceSetups" ], "summary": "Put PortalConfigurationServiceSetup", "operationId": "putCompanyPortalConfigurationsByParentIdServiceSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalConfigurationServiceSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfigurationServiceSetup" } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationServiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationServiceSetup" } } } } } }, "patch": { "tags": [ "PortalConfigurationServiceSetups" ], "summary": "Patch PortalConfigurationServiceSetup", "operationId": "patchCompanyPortalConfigurationsByParentIdServiceSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalConfigurationServiceSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationServiceSetup" } } } } } } }, "/company/portalConfigurations/{parentId}/serviceSetups/count": { "get": { "tags": [ "PortalConfigurationServiceSetups" ], "summary": "Get Count of PortalConfigurationServiceSetup", "operationId": "getCompanyPortalConfigurationsByParentIdServiceSetupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "portalConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalConfigurations/copy": { "post": { "tags": [ "PortalConfigurations" ], "summary": "Post PortalConfiguration", "operationId": "postCompanyPortalConfigurationsCopy", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "copy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } }, "required": true }, "responses": { "200": { "description": "PortalConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfiguration" } } } } } } }, "/company/portalConfigurations/count": { "get": { "tags": [ "PortalConfigurations" ], "summary": "Get Count of PortalConfiguration", "operationId": "getCompanyPortalConfigurationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalConfigurations/invoiceSetup/paymentProcessors": { "get": { "tags": [ "PortalConfigurationPaymentProcessors" ], "summary": "Get List of PortalConfigurationPaymentProcessor", "operationId": "getCompanyPortalConfigurationsInvoiceSetupPaymentProcessors", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalConfigurationPaymentProcessor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalConfigurationPaymentProcessor" } } } } } } } }, "/company/portalConfigurations/invoiceSetup/paymentProcessors/{id}": { "get": { "tags": [ "PortalConfigurationPaymentProcessors" ], "summary": "Get PortalConfigurationPaymentProcessor", "operationId": "getCompanyPortalConfigurationsInvoiceSetupPaymentProcessorsById", "parameters": [ { "name": "id", "in": "path", "description": "paymentProcessorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalConfigurationPaymentProcessor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalConfigurationPaymentProcessor" } } } } } } }, "/company/portalConfigurations/invoiceSetup/paymentProcessors/count": { "get": { "tags": [ "PortalConfigurationPaymentProcessors" ], "summary": "Get Count of PortalConfigurationPaymentProcessor", "operationId": "getCompanyPortalConfigurationsInvoiceSetupPaymentProcessorsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalSecurityLevels": { "get": { "tags": [ "PortalSecurityLevels" ], "summary": "Get List of PortalSecurityLevel", "operationId": "getCompanyPortalSecurityLevels", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalSecurityLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalSecurityLevel" } } } } } } } }, "/company/portalSecurityLevels/{id}": { "get": { "tags": [ "PortalSecurityLevels" ], "summary": "Get PortalSecurityLevel", "operationId": "getCompanyPortalSecurityLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "portalSecurityLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalSecurityLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalSecurityLevel" } } } } } }, "put": { "tags": [ "PortalSecurityLevels" ], "summary": "Put PortalSecurityLevel", "operationId": "putCompanyPortalSecurityLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "portalSecurityLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "_portalSecurityLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSecurityLevel" } } }, "required": true }, "responses": { "200": { "description": "PortalSecurityLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalSecurityLevel" } } } } } }, "patch": { "tags": [ "PortalSecurityLevels" ], "summary": "Patch PortalSecurityLevel", "operationId": "patchCompanyPortalSecurityLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "portalSecurityLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalSecurityLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalSecurityLevel" } } } } } } }, "/company/portalSecurityLevels/count": { "get": { "tags": [ "PortalSecurityLevels" ], "summary": "Get Count of PortalSecurityLevel", "operationId": "getCompanyPortalSecurityLevelsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/portalSecuritySettings": { "get": { "tags": [ "PortalSecuritySettings" ], "summary": "Get List of PortalSecuritySetting", "operationId": "getCompanyPortalSecuritySettings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalSecuritySetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalSecuritySetting" } } } } } } } }, "/company/portalSecuritySettings/{id}": { "get": { "tags": [ "PortalSecuritySettings" ], "summary": "Get PortalSecuritySetting", "operationId": "getCompanyPortalSecuritySettingsById", "parameters": [ { "name": "id", "in": "path", "description": "portalSecuritySettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalSecuritySetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalSecuritySetting" } } } } } }, "put": { "tags": [ "PortalSecuritySettings" ], "summary": "Put PortalSecuritySetting", "operationId": "putCompanyPortalSecuritySettingsById", "parameters": [ { "name": "id", "in": "path", "description": "portalSecuritySettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalSecurity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalSecuritySetting" } } }, "required": true }, "responses": { "200": { "description": "PortalSecuritySetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalSecuritySetting" } } } } } }, "patch": { "tags": [ "PortalSecuritySettings" ], "summary": "Patch PortalSecuritySetting", "operationId": "patchCompanyPortalSecuritySettingsById", "parameters": [ { "name": "id", "in": "path", "description": "portalSecuritySettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalSecuritySetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalSecuritySetting" } } } } } } }, "/company/portalSecuritySettings/count": { "get": { "tags": [ "PortalSecuritySettings" ], "summary": "Get Count of PortalSecuritySetting", "operationId": "getCompanyPortalSecuritySettingsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/states": { "get": { "tags": [ "States" ], "summary": "Get List of State", "operationId": "getCompanyStates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of State", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/State" } } } } } } }, "post": { "tags": [ "States" ], "summary": "Post State", "operationId": "postCompanyStates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/State" } } }, "required": true }, "responses": { "201": { "description": "State", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/State" } } } } } } }, "/company/states/{id}": { "get": { "tags": [ "States" ], "summary": "Get State", "operationId": "getCompanyStatesById", "parameters": [ { "name": "id", "in": "path", "description": "stateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "State", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/State" } } } } } }, "put": { "tags": [ "States" ], "summary": "Put State", "operationId": "putCompanyStatesById", "parameters": [ { "name": "id", "in": "path", "description": "stateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/State" } } }, "required": true }, "responses": { "200": { "description": "State", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/State" } } } } } }, "patch": { "tags": [ "States" ], "summary": "Patch State", "operationId": "patchCompanyStatesById", "parameters": [ { "name": "id", "in": "path", "description": "stateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "State", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/State" } } } } } }, "delete": { "tags": [ "States" ], "summary": "Delete State", "operationId": "deleteCompanyStatesById", "parameters": [ { "name": "id", "in": "path", "description": "stateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/states/{id}/info": { "get": { "tags": [ "StateInfos" ], "summary": "Get StateInfos", "operationId": "getCompanyStatesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "StateInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "StateInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StateInfo" } } } } } } }, "/company/states/{id}/usages": { "get": { "tags": [ "States" ], "summary": "Get List of Usage Count", "operationId": "getCompanyStatesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "stateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/states/{id}/usages/list": { "get": { "tags": [ "States" ], "summary": "Get List of Usage", "operationId": "getCompanyStatesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "stateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/states/count": { "get": { "tags": [ "States" ], "summary": "Get Count of Usage", "operationId": "getCompanyStatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/states/info": { "get": { "tags": [ "StateInfos" ], "summary": "Get List of StateInfos", "operationId": "getCompanyStatesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of stateInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StateInfo" } } } } } } } }, "/company/states/info/count": { "get": { "tags": [ "StateInfos" ], "summary": "Get Count of StateInfos", "operationId": "getCompanyStatesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/teamRoles": { "get": { "tags": [ "CompanyTeamRole" ], "summary": "Get List of TeamRole", "operationId": "getCompanyTeamRoles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TeamRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamRole" } } } } } } }, "post": { "tags": [ "CompanyTeamRole" ], "summary": "Post TeamRole", "operationId": "postCompanyTeamRoles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRole" } } }, "required": true }, "responses": { "201": { "description": "TeamRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TeamRole" } } } } } } }, "/company/teamRoles/{id}": { "get": { "tags": [ "CompanyTeamRole" ], "summary": "Get TeamRole", "operationId": "getCompanyTeamRolesById", "parameters": [ { "name": "id", "in": "path", "description": "teamRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TeamRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TeamRole" } } } } } }, "delete": { "tags": [ "CompanyTeamRole" ], "summary": "Delete TeamRole", "operationId": "deleteCompanyTeamRolesById", "parameters": [ { "name": "id", "in": "path", "description": "teamRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyTeamRole" ], "summary": "Put TeamRole", "operationId": "putCompanyTeamRolesById", "parameters": [ { "name": "id", "in": "path", "description": "teamRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRole" } } }, "required": true }, "responses": { "200": { "description": "TeamRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TeamRole" } } } } } }, "patch": { "tags": [ "CompanyTeamRole" ], "summary": "Patch TeamRole", "operationId": "patchCompanyTeamRolesById", "parameters": [ { "name": "id", "in": "path", "description": "teamRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TeamRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TeamRole" } } } } } } }, "/company/teamRoles/{id}/info": { "get": { "tags": [ "TeamRoleInfos" ], "summary": "Get TeamRoleInfos", "operationId": "getCompanyTeamRolesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "TeamRoleInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TeamRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TeamRoleInfo" } } } } } } }, "/company/teamRoles/{id}/usages": { "get": { "tags": [ "CompanyTeamRole" ], "summary": "Get List of Usage Count", "operationId": "getCompanyTeamRolesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "teamRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/teamRoles/{id}/usages/list": { "get": { "tags": [ "CompanyTeamRole" ], "summary": "Get List of Usage", "operationId": "getCompanyTeamRolesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "teamRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/teamRoles/count": { "get": { "tags": [ "CompanyTeamRole" ], "summary": "Get Count of Usage", "operationId": "getCompanyTeamRolesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/teamRoles/info": { "get": { "tags": [ "TeamRoleInfos" ], "summary": "Get List of TeamRoleInfos", "operationId": "getCompanyTeamRolesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of teamRoleInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TeamRoleInfo" } } } } } } } }, "/company/teamRoles/info/count": { "get": { "tags": [ "TeamRoleInfos" ], "summary": "Get Count of TeamRoleInfos", "operationId": "getCompanyTeamRolesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/tracks": { "get": { "tags": [ "Tracks" ], "summary": "Get List of Track", "operationId": "getCompanyTracks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Track", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Track" } } } } } } }, "post": { "tags": [ "Tracks" ], "summary": "Post Track", "operationId": "postCompanyTracks", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } } }, "required": true }, "responses": { "201": { "description": "Track", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Track" } } } } } } }, "/company/tracks/{id}": { "get": { "tags": [ "Tracks" ], "summary": "Get Track", "operationId": "getCompanyTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Track", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Track" } } } } } }, "delete": { "tags": [ "Tracks" ], "summary": "Delete Track", "operationId": "deleteCompanyTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Tracks" ], "summary": "Put Track", "operationId": "putCompanyTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } } }, "required": true }, "responses": { "200": { "description": "Track", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Track" } } } } } }, "patch": { "tags": [ "Tracks" ], "summary": "Patch Track", "operationId": "patchCompanyTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Track", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Track" } } } } } } }, "/company/tracks/{parentId}/actions": { "get": { "tags": [ "TrackActions" ], "summary": "Get List of TrackAction", "operationId": "getCompanyTracksByParentIdActions", "parameters": [ { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TrackAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TrackAction" } } } } } } }, "post": { "tags": [ "TrackActions" ], "summary": "Post TrackAction", "operationId": "postCompanyTracksByParentIdActions", "parameters": [ { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "trackAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackAction" } } }, "required": true }, "responses": { "201": { "description": "TrackAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TrackAction" } } } } } } }, "/company/tracks/{parentId}/actions/{id}": { "get": { "tags": [ "TrackActions" ], "summary": "Get TrackAction", "operationId": "getCompanyTracksByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TrackAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TrackAction" } } } } } }, "put": { "tags": [ "TrackActions" ], "summary": "Put TrackAction", "operationId": "putCompanyTracksByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "trackAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackAction" } } }, "required": true }, "responses": { "200": { "description": "TrackAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TrackAction" } } } } } }, "patch": { "tags": [ "TrackActions" ], "summary": "Patch TrackAction", "operationId": "patchCompanyTracksByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TrackAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TrackAction" } } } } } }, "delete": { "tags": [ "TrackActions" ], "summary": "Delete TrackAction", "operationId": "deleteCompanyTracksByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/tracks/{parentId}/actions/count": { "get": { "tags": [ "TrackActions" ], "summary": "Get Count of TrackAction", "operationId": "getCompanyTracksByParentIdActionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/tracks/count": { "get": { "tags": [ "Tracks" ], "summary": "Get Count of Track", "operationId": "getCompanyTracksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/configurations/types/{grandparentId}/questions/{parentId}/values/{id}/info": { "get": { "tags": [ "ConfigurationTypeQuestionValueInfos" ], "summary": "Get ConfigurationTypeQuestionValueInfo", "operationId": "getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdInfo", "parameters": [ { "name": "grandparentId", "in": "path", "description": "ConfigurationTypeQuestionInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ConfigurationTypeQuestionInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "ConfigurationTypeQuestionInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeQuestionInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionInfo" } } } } } } }, "/configurations/types/{grandparentId}/questions/{parentId}/values/info": { "get": { "tags": [ "ConfigurationTypeQuestionValueInfos" ], "summary": "Get ConfigurationTypeQuestionValueInfo", "operationId": "getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesInfo", "parameters": [ { "name": "grandparentId", "in": "path", "description": "ConfigurationTypeQuestionValueInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ConfigurationTypeQuestionValueInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationTypeQuestionInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValueInfo" } } } } } } } }, "/configurations/types/{grandparentId}/questions/{parentId}/values/info/count": { "get": { "tags": [ "ConfigurationTypeQuestionValueInfos" ], "summary": "Get Count of ConfigurationTypeQuestionValueInfos", "operationId": "getConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesInfoCount", "parameters": [ { "name": "grandparentId", "in": "path", "description": "ConfigurationTypeQuestionValueInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ConfigurationTypeQuestionValueInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/configurations/types/{parentId}/questions/{id}/info": { "get": { "tags": [ "ConfigurationTypeQuestionInfo" ], "summary": "Get ConfigurationTypeQuestionInfo", "operationId": "getConfigurationsTypesByParentIdQuestionsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ConfigurationTypeQuestionInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeQuestionInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionInfo" } } } } } } }, "/configurations/types/{parentId}/questions/info": { "get": { "tags": [ "ConfigurationTypeQuestionInfos" ], "summary": "Get List of ConfigurationTypeQuestionInfos", "operationId": "getConfigurationsTypesByParentIdQuestionsInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationTypeQuestionInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeQuestionInfo" } } } } } } } }, "/configurations/types/{parentId}/questions/info/count": { "get": { "tags": [ "ConfigurationTypeQuestionInfos" ], "summary": "Get Count of ConfigurationTypeQuestionInfos", "operationId": "getConfigurationsTypesByParentIdQuestionsInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/configurations/types/info": { "get": { "tags": [ "ConfigurationTypeInfos" ], "summary": "Get List of ConfigurationTypeInfos", "operationId": "getConfigurationsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of configurationTypeInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeInfo" } } } } } } } }, "/configurations/types/info/count": { "get": { "tags": [ "ConfigurationTypeInfos" ], "summary": "Get Count of AddressFormatInfos", "operationId": "getConfigurationsTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/classifications": { "get": { "tags": [ "Classifications" ], "summary": "Get List of Classification", "operationId": "getExpenseClassifications", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Classification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Classification" } } } } } } } }, "/expense/classifications/{id}": { "get": { "tags": [ "Classifications" ], "summary": "Get Classification", "operationId": "getExpenseClassificationsById", "parameters": [ { "name": "id", "in": "path", "description": "classificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Classification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Classification" } } } } } } }, "/expense/classifications/count": { "get": { "tags": [ "Classifications" ], "summary": "Get Count of Classification", "operationId": "getExpenseClassificationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/entries": { "get": { "tags": [ "ExpenseEntries" ], "summary": "Get List of ExpenseEntry", "operationId": "getExpenseEntries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseEntry" } } } } } } }, "post": { "tags": [ "ExpenseEntries" ], "summary": "Post ExpenseEntry", "operationId": "postExpenseEntries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "expenseEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseEntry" } } }, "required": true }, "responses": { "201": { "description": "ExpenseEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseEntry" } } } } } } }, "/expense/entries/{id}": { "get": { "tags": [ "ExpenseEntries" ], "summary": "Get ExpenseEntry", "operationId": "getExpenseEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseEntry" } } } } } }, "delete": { "tags": [ "ExpenseEntries" ], "summary": "Delete ExpenseEntry", "operationId": "deleteExpenseEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ExpenseEntries" ], "summary": "Put ExpenseEntry", "operationId": "putExpenseEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "expenseEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseEntry" } } }, "required": true }, "responses": { "200": { "description": "ExpenseEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseEntry" } } } } } }, "patch": { "tags": [ "ExpenseEntries" ], "summary": "Patch ExpenseEntry", "operationId": "patchExpenseEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ExpenseEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseEntry" } } } } } } }, "/expense/entries/{parentId}/audits": { "get": { "tags": [ "ExpenseEntryAudits" ], "summary": "Get List of ExpenseEntryAudit", "operationId": "getExpenseEntriesByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseEntryAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseEntryAudit" } } } } } } } }, "/expense/entries/{parentId}/audits/{id}": { "get": { "tags": [ "ExpenseEntryAudits" ], "summary": "Get ExpenseEntryAudit", "operationId": "getExpenseEntriesByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseEntryAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseEntryAudit" } } } } } } }, "/expense/entries/{parentId}/audits/count": { "get": { "tags": [ "ExpenseEntryAudits" ], "summary": "Get Count of ExpenseEntryAudit", "operationId": "getExpenseEntriesByParentIdAuditsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/entries/count": { "get": { "tags": [ "ExpenseEntries" ], "summary": "Get Count of ExpenseEntry", "operationId": "getExpenseEntriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/info/taxTypes": { "get": { "tags": [ "ExpenseTaxTypeInfos" ], "summary": "Get List of ExpenseTaxTypeInfo", "operationId": "getExpenseInfoTaxTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseTaxTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseTaxTypeInfo" } } } } } } } }, "/expense/info/taxTypes/{id}": { "get": { "tags": [ "ExpenseTaxTypeInfos" ], "summary": "Get ExpenseTaxTypeInfo", "operationId": "getExpenseInfoTaxTypesById", "parameters": [ { "name": "id", "in": "path", "description": "taxTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseTaxTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseTaxTypeInfo" } } } } } } }, "/expense/info/taxTypes/count": { "get": { "tags": [ "ExpenseTaxTypeInfos" ], "summary": "Get Count of ExpenseTaxTypeInfo", "operationId": "getExpenseInfoTaxTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/paymentTypes": { "get": { "tags": [ "PaymentTypes" ], "summary": "Get List of PaymentType", "operationId": "getExpensePaymentTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PaymentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentType" } } } } } } }, "post": { "tags": [ "PaymentTypes" ], "summary": "Post PaymentType", "operationId": "postExpensePaymentTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "paymentType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentType" } } }, "required": true }, "responses": { "201": { "description": "PaymentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PaymentType" } } } } } } }, "/expense/paymentTypes/{id}": { "get": { "tags": [ "PaymentTypes" ], "summary": "Get PaymentType", "operationId": "getExpensePaymentTypesById", "parameters": [ { "name": "id", "in": "path", "description": "paymentTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PaymentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PaymentType" } } } } } }, "delete": { "tags": [ "PaymentTypes" ], "summary": "Delete PaymentType", "operationId": "deleteExpensePaymentTypesById", "parameters": [ { "name": "id", "in": "path", "description": "paymentTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PaymentTypes" ], "summary": "Put PaymentType", "operationId": "putExpensePaymentTypesById", "parameters": [ { "name": "id", "in": "path", "description": "paymentTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "paymentType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentType" } } }, "required": true }, "responses": { "200": { "description": "PaymentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PaymentType" } } } } } }, "patch": { "tags": [ "PaymentTypes" ], "summary": "Patch PaymentType", "operationId": "patchExpensePaymentTypesById", "parameters": [ { "name": "id", "in": "path", "description": "paymentTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PaymentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PaymentType" } } } } } } }, "/expense/paymentTypes/{id}/info": { "get": { "tags": [ "PaymentTypeInfos" ], "summary": "Get PaymentTypeInfos", "operationId": "getExpensePaymentTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "PaymentTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PaymentTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PaymentTypeInfo" } } } } } } }, "/expense/paymentTypes/count": { "get": { "tags": [ "PaymentTypes" ], "summary": "Get Count of PaymentType", "operationId": "getExpensePaymentTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/paymentTypes/info": { "get": { "tags": [ "PaymentTypeInfos" ], "summary": "Get List of PaymentTypeInfos", "operationId": "getExpensePaymentTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of paymentTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentTypeInfo" } } } } } } } }, "/expense/reports": { "get": { "tags": [ "ExpenseReports" ], "summary": "Get List of ExpenseReport", "operationId": "getExpenseReports", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseReport" } } } } } } } }, "/expense/reports/{id}": { "get": { "tags": [ "ExpenseReports" ], "summary": "Get ExpenseReport", "operationId": "getExpenseReportsById", "parameters": [ { "name": "id", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseReport" } } } } } } }, "/expense/reports/{id}/approve": { "post": { "tags": [ "ExpenseReports" ], "summary": "Post SuccessResponse", "operationId": "postExpenseReportsByIdApprove", "parameters": [ { "name": "id", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "reportId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseReportTierUpdate" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/expense/reports/{id}/reject": { "post": { "tags": [ "ExpenseReports" ], "summary": "Post SuccessResponse", "operationId": "postExpenseReportsByIdReject", "parameters": [ { "name": "id", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/expense/reports/{id}/reverse": { "post": { "tags": [ "ExpenseReports" ], "summary": "Post SuccessResponse", "operationId": "postExpenseReportsByIdReverse", "parameters": [ { "name": "id", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/expense/reports/{id}/submit": { "post": { "tags": [ "ExpenseReports" ], "summary": "Post SuccessResponse", "operationId": "postExpenseReportsByIdSubmit", "parameters": [ { "name": "id", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/expense/reports/{parentId}/audits": { "get": { "tags": [ "ExpenseReportAudits" ], "summary": "Get List of ExpenseReportAudit", "operationId": "getExpenseReportsByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseReportAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseReportAudit" } } } } } } } }, "/expense/reports/{parentId}/audits/{id}": { "get": { "tags": [ "ExpenseReportAudits" ], "summary": "Get ExpenseReportAudit", "operationId": "getExpenseReportsByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseReportAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseReportAudit" } } } } } } }, "/expense/reports/{parentId}/audits/count": { "get": { "tags": [ "ExpenseReportAudits" ], "summary": "Get Count of ExpenseReportAudit", "operationId": "getExpenseReportsByParentIdAuditsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "reportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/reports/count": { "get": { "tags": [ "ExpenseReports" ], "summary": "Get Count of ExpenseReport", "operationId": "getExpenseReportsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/types": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Get List of ExpenseType", "operationId": "getExpenseTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseType" } } } } } } }, "post": { "tags": [ "ExpenseTypes" ], "summary": "Post ExpenseType", "operationId": "postExpenseTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "expenseType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseType" } } }, "required": true }, "responses": { "201": { "description": "ExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseType" } } } } } } }, "/expense/types/{id}": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Get ExpenseType", "operationId": "getExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseType" } } } } } }, "delete": { "tags": [ "ExpenseTypes" ], "summary": "Delete ExpenseType", "operationId": "deleteExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ExpenseTypes" ], "summary": "Put ExpenseType", "operationId": "putExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "expenseType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseType" } } }, "required": true }, "responses": { "200": { "description": "ExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseType" } } } } } }, "patch": { "tags": [ "ExpenseTypes" ], "summary": "Patch ExpenseType", "operationId": "patchExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseType" } } } } } } }, "/expense/types/{id}/info": { "get": { "tags": [ "ExpenseTypeInfos" ], "summary": "Get ExpenseTypeInfos", "operationId": "getExpenseTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ExpenseTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseTypeInfo" } } } } } } }, "/expense/types/count": { "get": { "tags": [ "ExpenseTypes" ], "summary": "Get Count of ExpenseType", "operationId": "getExpenseTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/expense/types/info": { "get": { "tags": [ "ExpenseTypeInfos" ], "summary": "Get List of ExpenseTypeInfos", "operationId": "getExpenseTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of expenseTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseTypeInfo" } } } } } } } }, "/finance/accounting/batches": { "get": { "tags": [ "AccountingBatches" ], "summary": "Get List of AccountingBatch", "operationId": "getFinanceAccountingBatches", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AccountingBatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingBatch" } } } } } } }, "post": { "tags": [ "AccountingBatches" ], "summary": "Post GLExport", "operationId": "postFinanceAccountingBatches", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "accountingBatchParameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountingBatchRequest" } } }, "required": true }, "responses": { "201": { "description": "GLExport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLExport" } } } } } } }, "/finance/accounting/batches/{id}": { "get": { "tags": [ "AccountingBatches" ], "summary": "Get AccountingBatch", "operationId": "getFinanceAccountingBatchesById", "parameters": [ { "name": "id", "in": "path", "description": "batcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AccountingBatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AccountingBatch" } } } } } }, "delete": { "tags": [ "AccountingBatches" ], "summary": "Delete GLExport", "operationId": "deleteFinanceAccountingBatchesById", "parameters": [ { "name": "id", "in": "path", "description": "batcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/accounting/batches/{id}/export": { "post": { "tags": [ "AccountingBatches" ], "summary": "Post GLExport", "operationId": "postFinanceAccountingBatchesByIdExport", "parameters": [ { "name": "id", "in": "path", "description": "batcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "batchExportParameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportAccountingBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "GLExport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLExport" } } } } } } }, "/finance/accounting/batches/{parentId}/entries": { "get": { "tags": [ "BatchEntries" ], "summary": "Get List of BatchEntry", "operationId": "getFinanceAccountingBatchesByParentIdEntries", "parameters": [ { "name": "parentId", "in": "path", "description": "batcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BatchEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BatchEntry" } } } } } } } }, "/finance/accounting/batches/{parentId}/entries/{id}": { "get": { "tags": [ "BatchEntries" ], "summary": "Get BatchEntry", "operationId": "getFinanceAccountingBatchesByParentIdEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "batcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BatchEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BatchEntry" } } } } } } }, "/finance/accounting/batches/{parentId}/entries/count": { "get": { "tags": [ "BatchEntries" ], "summary": "Get Count of BatchEntry", "operationId": "getFinanceAccountingBatchesByParentIdEntriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "batcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/batches/count": { "get": { "tags": [ "AccountingBatches" ], "summary": "Get Count of AccountingBatch", "operationId": "getFinanceAccountingBatchesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/export": { "post": { "tags": [ "AccountingBatches" ], "summary": "Post GLExport", "operationId": "postFinanceAccountingExport", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "batchExportParameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportAccountingBatchRequest" } } }, "required": true }, "responses": { "200": { "description": "GLExport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLExport" } } } } } } }, "/finance/accounting/unpostedexpenses": { "get": { "tags": [ "AccountingUnpostedExpenses" ], "summary": "Get List of UnpostedExpense", "operationId": "getFinanceAccountingUnpostedexpenses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedExpense", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedExpense" } } } } } } } }, "/finance/accounting/unpostedexpenses/{id}": { "get": { "tags": [ "AccountingUnpostedExpenses" ], "summary": "Get UnpostedExpense", "operationId": "getFinanceAccountingUnpostedexpensesById", "parameters": [ { "name": "id", "in": "path", "description": "unpostedexpensId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedExpense", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedExpense" } } } } } } }, "/finance/accounting/unpostedexpenses/{parentId}/taxableLevels": { "get": { "tags": [ "AccountingUnpostedExpenseTaxableLevels" ], "summary": "Get List of UnpostedExpenseTaxableLevel", "operationId": "getFinanceAccountingUnpostedexpensesByParentIdTaxableLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "unpostedexpensId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedExpenseTaxableLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedExpenseTaxableLevel" } } } } } } } }, "/finance/accounting/unpostedexpenses/{parentId}/taxableLevels/{id}": { "get": { "tags": [ "AccountingUnpostedExpenseTaxableLevels" ], "summary": "Get UnpostedExpenseTaxableLevel", "operationId": "getFinanceAccountingUnpostedexpensesByParentIdTaxableLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unpostedexpensId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedExpenseTaxableLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedExpenseTaxableLevel" } } } } } } }, "/finance/accounting/unpostedexpenses/{parentId}/taxableLevels/count": { "get": { "tags": [ "AccountingUnpostedExpenseTaxableLevels" ], "summary": "Get Count of UnpostedExpenseTaxableLevel", "operationId": "getFinanceAccountingUnpostedexpensesByParentIdTaxableLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "unpostedexpensId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/unpostedexpenses/count": { "get": { "tags": [ "AccountingUnpostedExpenses" ], "summary": "Get Count of UnpostedExpense", "operationId": "getFinanceAccountingUnpostedexpensesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/unpostedinvoices": { "get": { "tags": [ "AccountingUnpostedInvoices" ], "summary": "Get List of UnpostedInvoice", "operationId": "getFinanceAccountingUnpostedinvoices", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedInvoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedInvoice" } } } } } } } }, "/finance/accounting/unpostedinvoices/{id}": { "get": { "tags": [ "AccountingUnpostedInvoices" ], "summary": "Get UnpostedInvoice", "operationId": "getFinanceAccountingUnpostedinvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "unpostedinvoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedInvoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedInvoice" } } } } } } }, "/finance/accounting/unpostedinvoices/{parentId}/taxableLevels": { "get": { "tags": [ "AccountingUnpostedInvoiceTaxableLevels" ], "summary": "Get List of UnpostedInvoiceTaxableLevel", "operationId": "getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "unpostedinvoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedInvoiceTaxableLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedInvoiceTaxableLevel" } } } } } } } }, "/finance/accounting/unpostedinvoices/{parentId}/taxableLevels/{id}": { "get": { "tags": [ "AccountingUnpostedInvoiceTaxableLevels" ], "summary": "Get UnpostedInvoiceTaxableLevel", "operationId": "getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unpostedinvoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedInvoiceTaxableLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedInvoiceTaxableLevel" } } } } } } }, "/finance/accounting/unpostedinvoices/{parentId}/taxableLevels/count": { "get": { "tags": [ "AccountingUnpostedInvoiceTaxableLevels" ], "summary": "Get Count of UnpostedInvoiceTaxableLevel", "operationId": "getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "unpostedinvoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/unpostedinvoices/count": { "get": { "tags": [ "AccountingUnpostedInvoices" ], "summary": "Get Count of UnpostedInvoice", "operationId": "getFinanceAccountingUnpostedinvoicesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/unpostedpayments": { "get": { "tags": [ "AccountingUnpostedPayments" ], "summary": "Get List of UnpostedPayments", "operationId": "getFinanceAccountingUnpostedpayments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedPayments", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedPayments" } } } } } } } }, "/finance/accounting/unpostedPayments/{id}": { "get": { "tags": [ "AccountingUnpostedPayments" ], "summary": "Get UnpostedPayments", "operationId": "getFinanceAccountingUnpostedPaymentsById", "parameters": [ { "name": "id", "in": "path", "description": "unpostedPaymentsId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedPayments", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedPayments" } } } } } } }, "/finance/accounting/unpostedPayments/count": { "get": { "tags": [ "AccountingUnpostedPayments" ], "summary": "Get Count of UnpostedPayments", "operationId": "getFinanceAccountingUnpostedPaymentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/unpostedprocurement": { "get": { "tags": [ "AccountingUnpostedProcurements" ], "summary": "Get List of UnpostedProcurement", "operationId": "getFinanceAccountingUnpostedprocurement", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedProcurement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedProcurement" } } } } } } } }, "/finance/accounting/unpostedprocurement/{id}": { "get": { "tags": [ "AccountingUnpostedProcurements" ], "summary": "Get UnpostedProcurement", "operationId": "getFinanceAccountingUnpostedprocurementById", "parameters": [ { "name": "id", "in": "path", "description": "unpostedprocurementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedProcurement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedProcurement" } } } } } } }, "/finance/accounting/unpostedprocurement/{parentId}/taxableLevels": { "get": { "tags": [ "AccountingUnpostedProcurementTaxableLevels" ], "summary": "Get List of UnpostedProcurementTaxableLevel", "operationId": "getFinanceAccountingUnpostedprocurementByParentIdTaxableLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "unpostedprocurementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnpostedProcurementTaxableLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnpostedProcurementTaxableLevel" } } } } } } } }, "/finance/accounting/unpostedprocurement/{parentId}/taxableLevels/{id}": { "get": { "tags": [ "AccountingUnpostedProcurementTaxableLevels" ], "summary": "Get UnpostedProcurementTaxableLevel", "operationId": "getFinanceAccountingUnpostedprocurementByParentIdTaxableLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unpostedprocurementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnpostedProcurementTaxableLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnpostedProcurementTaxableLevel" } } } } } } }, "/finance/accounting/unpostedprocurement/{parentId}/taxableLevels/count": { "get": { "tags": [ "AccountingUnpostedProcurementTaxableLevels" ], "summary": "Get Count of UnpostedProcurementTaxableLevel", "operationId": "getFinanceAccountingUnpostedprocurementByParentIdTaxableLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "unpostedprocurementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accounting/unpostedprocurement/count": { "get": { "tags": [ "AccountingUnpostedProcurements" ], "summary": "Get Count of UnpostedProcurement", "operationId": "getFinanceAccountingUnpostedprocurementCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accountingPackages": { "get": { "tags": [ "AccountingPackages" ], "summary": "Get List of AccountingPackage", "operationId": "getFinanceAccountingPackages", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AccountingPackage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingPackage" } } } } } } } }, "/finance/accountingPackages/{id}": { "get": { "tags": [ "AccountingPackages" ], "summary": "Get AccountingPackage", "operationId": "getFinanceAccountingPackagesById", "parameters": [ { "name": "id", "in": "path", "description": "accountingPackageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AccountingPackage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AccountingPackage" } } } } } } }, "/finance/accountingPackages/count": { "get": { "tags": [ "AccountingPackages" ], "summary": "Get Count of AccountingPackage", "operationId": "getFinanceAccountingPackagesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/accountingPackageSetup": { "get": { "tags": [ "AccountingPackageSetups" ], "summary": "Get List of AccountingPackageSetup", "operationId": "getFinanceAccountingPackageSetup", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AccountingPackageSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingPackageSetup" } } } } } } } }, "/finance/accountingPackageSetup/{id}": { "get": { "tags": [ "AccountingPackageSetups" ], "summary": "Get AccountingPackageSetup", "operationId": "getFinanceAccountingPackageSetupById", "parameters": [ { "name": "id", "in": "path", "description": "accountingPackageSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AccountingPackageSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AccountingPackageSetup" } } } } } }, "put": { "tags": [ "AccountingPackageSetups" ], "summary": "Put AccountingPackageSetup", "operationId": "putFinanceAccountingPackageSetupById", "parameters": [ { "name": "id", "in": "path", "description": "accountingPackageSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "accountingPackageSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingPackageSetup" } } }, "required": true }, "responses": { "200": { "description": "AccountingPackageSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AccountingPackageSetup" } } } } } }, "patch": { "tags": [ "AccountingPackageSetups" ], "summary": "Patch AccountingPackageSetup", "operationId": "patchFinanceAccountingPackageSetupById", "parameters": [ { "name": "id", "in": "path", "description": "accountingPackageSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AccountingPackageSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AccountingPackageSetup" } } } } } } }, "/finance/accountingPackageSetup/count": { "get": { "tags": [ "AccountingPackageSetups" ], "summary": "Get Count of AccountingPackageSetup", "operationId": "getFinanceAccountingPackageSetupCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreementrecap/": { "get": { "tags": [ "AgreementRecaps" ], "summary": "Get List of AgreementRecaps", "operationId": "getFinanceAgreementrecap", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of agreementRecapses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementRecap" } } } } } } } }, "/finance/agreementrecap/{id}": { "get": { "tags": [ "AgreementRecaps" ], "summary": "Get AgreementRecaps", "operationId": "getFinanceAgreementrecapById", "parameters": [ { "name": "id", "in": "path", "description": "AgreementRecapId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementRecap", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementRecap" } } } } } } }, "/finance/agreements": { "get": { "tags": [ "Agreements" ], "summary": "Get List of Agreement", "operationId": "getFinanceAgreements", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "post": { "tags": [ "Agreements" ], "summary": "Post Agreement", "operationId": "postFinanceAgreements", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } }, "required": true }, "responses": { "201": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/finance/agreements/{id}": { "get": { "tags": [ "Agreements" ], "summary": "Get Agreement", "operationId": "getFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } }, "delete": { "tags": [ "Agreements" ], "summary": "Delete Agreement", "operationId": "deleteFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Agreements" ], "summary": "Put Agreement", "operationId": "putFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } }, "required": true }, "responses": { "200": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } }, "patch": { "tags": [ "Agreements" ], "summary": "Patch Agreement", "operationId": "patchFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/finance/agreements/{id}/applicationParameters/{podId}": { "get": { "tags": [ "Agreements" ], "summary": "Get AgreementApplicationParameters", "operationId": "getFinanceAgreementsByIdApplicationParametersByPodId", "parameters": [ { "name": "id", "in": "path", "description": "agreementHeaderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "podId", "in": "path", "description": "podId", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementApplicationParameters", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementApplicationParameters" } } } } } } }, "/finance/agreements/{id}/invoice": { "post": { "tags": [ "Agreements" ], "summary": "Post AgreementInvoice", "operationId": "postFinanceAgreementsByIdInvoice", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/finance/agreements/{id}/quickAccess/count": { "get": { "tags": [ "Agreements" ], "summary": "Get Agreement Tab Count", "operationId": "getFinanceAgreementsByIdQuickAccessCount", "parameters": [ { "name": "id", "in": "path", "description": "agreementHeaderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementApplicationParameters", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTabsCount" } } } } } } }, "/finance/agreements/{id}/recurringParameters/{podId}": { "get": { "tags": [ "Agreements" ], "summary": "Get AgreementRecurringParameters", "operationId": "getFinanceAgreementsByIdRecurringParametersByPodId", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "podId", "in": "path", "description": "podId", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementRecurringParameters", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementRecurringParameters" } } } } } } }, "/finance/agreements/{parentId}/additions": { "get": { "tags": [ "AgreementAdditions" ], "summary": "Get List of Addition", "operationId": "getFinanceAgreementsByParentIdAdditions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Addition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addition" } } } } } } }, "post": { "tags": [ "AgreementAdditions" ], "summary": "Post Addition", "operationId": "postFinanceAgreementsByParentIdAdditions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "addition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Addition" } } }, "required": true }, "responses": { "201": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } } }, "/finance/agreements/{parentId}/additions/{id}": { "get": { "tags": [ "AgreementAdditions" ], "summary": "Get Addition", "operationId": "getFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } }, "delete": { "tags": [ "AgreementAdditions" ], "summary": "Delete Addition", "operationId": "deleteFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementAdditions" ], "summary": "Put Addition", "operationId": "putFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "addition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Addition" } } }, "required": true }, "responses": { "200": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } }, "patch": { "tags": [ "AgreementAdditions" ], "summary": "Patch Addition", "operationId": "patchFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } } }, "/finance/agreements/{parentId}/additions/count": { "get": { "tags": [ "AgreementAdditions" ], "summary": "Get Count of Addition", "operationId": "getFinanceAgreementsByParentIdAdditionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/adjustments": { "get": { "tags": [ "AgreementAdjustments" ], "summary": "Get List of Adjustment", "operationId": "getFinanceAgreementsByParentIdAdjustments", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } } }, "post": { "tags": [ "AgreementAdjustments" ], "summary": "Post Adjustment", "operationId": "postFinanceAgreementsByParentIdAdjustments", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } }, "required": true }, "responses": { "201": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } } }, "/finance/agreements/{parentId}/adjustments/{id}": { "get": { "tags": [ "AgreementAdjustments" ], "summary": "Get Adjustment", "operationId": "getFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } }, "delete": { "tags": [ "AgreementAdjustments" ], "summary": "Delete Adjustment", "operationId": "deleteFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementAdjustments" ], "summary": "Put Adjustment", "operationId": "putFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } }, "required": true }, "responses": { "200": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } }, "patch": { "tags": [ "AgreementAdjustments" ], "summary": "Patch Adjustment", "operationId": "patchFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } } }, "/finance/agreements/{parentId}/adjustments/count": { "get": { "tags": [ "AgreementAdjustments" ], "summary": "Get Count of Adjustment", "operationId": "getFinanceAgreementsByParentIdAdjustmentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/boardDefaults": { "get": { "tags": [ "AgreementBoardDefaults" ], "summary": "Get List of BoardDefault", "operationId": "getFinanceAgreementsByParentIdBoardDefaults", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardDefault" } } } } } } }, "post": { "tags": [ "AgreementBoardDefaults" ], "summary": "Post BoardDefault", "operationId": "postFinanceAgreementsByParentIdBoardDefaults", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardDefault", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } }, "required": true }, "responses": { "201": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } } }, "/finance/agreements/{parentId}/boardDefaults/{id}": { "get": { "tags": [ "AgreementBoardDefaults" ], "summary": "Get BoardDefault", "operationId": "getFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } }, "delete": { "tags": [ "AgreementBoardDefaults" ], "summary": "Delete BoardDefault", "operationId": "deleteFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementBoardDefaults" ], "summary": "Put BoardDefault", "operationId": "putFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardDefault", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } }, "required": true }, "responses": { "200": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } }, "patch": { "tags": [ "AgreementBoardDefaults" ], "summary": "Patch BoardDefault", "operationId": "patchFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } } }, "/finance/agreements/{parentId}/boardDefaults/count": { "get": { "tags": [ "AgreementBoardDefaults" ], "summary": "Get Count of BoardDefault", "operationId": "getFinanceAgreementsByParentIdBoardDefaultsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/configurations": { "get": { "tags": [ "Agreements" ], "summary": "Get List of ConfigurationReference", "operationId": "getFinanceAgreementsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "post": { "tags": [ "Agreements" ], "summary": "Post ConfigurationReference", "operationId": "postFinanceAgreementsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "/finance/agreements/{parentId}/configurations/{id}": { "get": { "tags": [ "Agreements" ], "summary": "Get ConfigurationReference", "operationId": "getFinanceAgreementsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } }, "delete": { "tags": [ "Agreements" ], "summary": "Delete ConfigurationReference", "operationId": "deleteFinanceAgreementsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreements/{parentId}/configurations/count": { "get": { "tags": [ "Agreements" ], "summary": "Get Count of ConfigurationReference", "operationId": "getFinanceAgreementsByParentIdConfigurationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/copy": { "post": { "tags": [ "Agreements" ], "summary": "Post CopyAgreementAction", "operationId": "postFinanceAgreementsByParentIdCopy", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "CopyAgreementAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/finance/agreements/{parentId}/sites": { "get": { "tags": [ "AgreementSites" ], "summary": "Get List of AgreementSite", "operationId": "getFinanceAgreementsByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementSite" } } } } } } }, "post": { "tags": [ "AgreementSites" ], "summary": "Post AgreementSite", "operationId": "postFinanceAgreementsByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } }, "required": true }, "responses": { "201": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } } }, "/finance/agreements/{parentId}/sites/{id}": { "get": { "tags": [ "AgreementSites" ], "summary": "Get AgreementSite", "operationId": "getFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } }, "delete": { "tags": [ "AgreementSites" ], "summary": "Delete AgreementSite", "operationId": "deleteFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementSites" ], "summary": "Put AgreementSite", "operationId": "putFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } }, "required": true }, "responses": { "200": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } }, "patch": { "tags": [ "AgreementSites" ], "summary": "Patch AgreementSite", "operationId": "patchFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } } }, "/finance/agreements/{parentId}/sites/count": { "get": { "tags": [ "AgreementSites" ], "summary": "Get Count of AgreementSite", "operationId": "getFinanceAgreementsByParentIdSitesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/workRoleExclusions": { "get": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Get List of AgreementWorkRoleExclusion", "operationId": "getFinanceAgreementsByParentIdWorkRoleExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkRoleExclusion" } } } } } } }, "post": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Post AgreementWorkRoleExclusion", "operationId": "postFinanceAgreementsByParentIdWorkRoleExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkRoleExclusion" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkRoleExclusion" } } } } } } }, "/finance/agreements/{parentId}/workRoleExclusions/{id}": { "delete": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Delete AgreementWorkRoleExclusion", "operationId": "deleteFinanceAgreementsByParentIdWorkRoleExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreements/{parentId}/workRoleExclusions/count": { "get": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Get Count of AgreementWorkRoleExclusion", "operationId": "getFinanceAgreementsByParentIdWorkRoleExclusionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/workroles": { "get": { "tags": [ "AgreementWorkRoles" ], "summary": "Get List of AgreementWorkRole", "operationId": "getFinanceAgreementsByParentIdWorkroles", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } } }, "post": { "tags": [ "AgreementWorkRoles" ], "summary": "Post AgreementWorkRole", "operationId": "postFinanceAgreementsByParentIdWorkroles", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } } }, "/finance/agreements/{parentId}/workroles/{id}": { "get": { "tags": [ "AgreementWorkRoles" ], "summary": "Get AgreementWorkRole", "operationId": "getFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } }, "delete": { "tags": [ "AgreementWorkRoles" ], "summary": "Delete AgreementWorkRole", "operationId": "deleteFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementWorkRoles" ], "summary": "Put AgreementWorkRole", "operationId": "putFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } }, "patch": { "tags": [ "AgreementWorkRoles" ], "summary": "Patch AgreementWorkRole", "operationId": "patchFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } } }, "/finance/agreements/{parentId}/workroles/count": { "get": { "tags": [ "AgreementWorkRoles" ], "summary": "Get Count of AgreementWorkRole", "operationId": "getFinanceAgreementsByParentIdWorkrolesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/workTypeExclusions": { "get": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Get List of AgreementWorkTypeExclusion", "operationId": "getFinanceAgreementsByParentIdWorkTypeExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkTypeExclusion" } } } } } } }, "post": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Post AgreementWorkTypeExclusion", "operationId": "postFinanceAgreementsByParentIdWorkTypeExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workTypeExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkTypeExclusion" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkTypeExclusion" } } } } } } }, "/finance/agreements/{parentId}/workTypeExclusions/{id}": { "delete": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Delete AgreementWorkTypeExclusion", "operationId": "deleteFinanceAgreementsByParentIdWorkTypeExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreements/{parentId}/workTypeExclusions/count": { "get": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Get Count of AgreementWorkTypeExclusion", "operationId": "getFinanceAgreementsByParentIdWorkTypeExclusionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/worktypes": { "get": { "tags": [ "AgreementWorkTypes" ], "summary": "Get List of AgreementWorkType", "operationId": "getFinanceAgreementsByParentIdWorktypes", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } } }, "post": { "tags": [ "AgreementWorkTypes" ], "summary": "Post AgreementWorkType", "operationId": "postFinanceAgreementsByParentIdWorktypes", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } } }, "/finance/agreements/{parentId}/worktypes/{id}": { "get": { "tags": [ "AgreementWorkTypes" ], "summary": "Get AgreementWorkType", "operationId": "getFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } }, "delete": { "tags": [ "AgreementWorkTypes" ], "summary": "Delete AgreementWorkType", "operationId": "deleteFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementWorkTypes" ], "summary": "Put AgreementWorkType", "operationId": "putFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } }, "patch": { "tags": [ "AgreementWorkTypes" ], "summary": "Patch AgreementWorkType", "operationId": "patchFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } } }, "/finance/agreements/{parentId}/worktypes/count": { "get": { "tags": [ "AgreementWorkTypes" ], "summary": "Get Count of AgreementWorkType", "operationId": "getFinanceAgreementsByParentIdWorktypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/count": { "get": { "tags": [ "Agreements" ], "summary": "Get Count of Agreement", "operationId": "getFinanceAgreementsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/types": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of AgreementType", "operationId": "getFinanceAgreementsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "post": { "tags": [ "AgreementTypes" ], "summary": "Post AgreementType", "operationId": "postFinanceAgreementsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreementType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementType" } } }, "required": true }, "responses": { "201": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "/finance/agreements/types/{id}": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get AgreementType", "operationId": "getFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } }, "delete": { "tags": [ "AgreementTypes" ], "summary": "Delete AgreementType", "operationId": "deleteFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementTypes" ], "summary": "Put AgreementType", "operationId": "putFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreementType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementType" } } }, "required": true }, "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } }, "patch": { "tags": [ "AgreementTypes" ], "summary": "Patch AgreementType", "operationId": "patchFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "/finance/agreements/types/{id}/info": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get AgreementType", "operationId": "getFinanceAgreementsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeInfo" } } } } } } }, "/finance/agreements/types/{id}/usages": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of Usage Count", "operationId": "getFinanceAgreementsTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/agreements/types/{id}/usages/list": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of Usage", "operationId": "getFinanceAgreementsTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/agreements/types/count": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get Count of AgreementType", "operationId": "getFinanceAgreementsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/types/info": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of AgreementTypeInfo", "operationId": "getFinanceAgreementsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeInfo" } } } } } } } }, "/finance/agreements/types/info/count": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get Count of AgreementTypeInfo", "operationId": "getFinanceAgreementsTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/types{id}/copy": { "post": { "tags": [ "AgreementType" ], "summary": "Post AgreementType", "operationId": "postFinanceAgreementsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "/finance/agreementTypes/{parentId}/boardDefaults": { "get": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Get List of AgreementTypeBoardDefault", "operationId": "getFinanceAgreementTypesByParentIdBoardDefaults", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeBoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } } } } } }, "post": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Post AgreementTypeBoardDefault", "operationId": "postFinanceAgreementTypesByParentIdBoardDefaults", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardDefault", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } }, "required": true }, "responses": { "201": { "description": "AgreementTypeBoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } } } } } }, "/finance/agreementTypes/{parentId}/boardDefaults/{id}": { "get": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Get AgreementTypeBoardDefault", "operationId": "getFinanceAgreementTypesByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementTypeBoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } } } } }, "delete": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Delete AgreementTypeBoardDefault", "operationId": "deleteFinanceAgreementTypesByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Put AgreementTypeBoardDefault", "operationId": "putFinanceAgreementTypesByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardDefault", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } }, "required": true }, "responses": { "200": { "description": "AgreementTypeBoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } } } } }, "patch": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Patch AgreementTypeBoardDefault", "operationId": "patchFinanceAgreementTypesByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementTypeBoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeBoardDefault" } } } } } } }, "/finance/agreementTypes/{parentId}/boardDefaults/count": { "get": { "tags": [ "AgreementTypeBoardDefaults" ], "summary": "Get Count of AgreementTypeBoardDefault", "operationId": "getFinanceAgreementTypesByParentIdBoardDefaultsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreementTypes/{parentId}/workRoleExclusions": { "get": { "tags": [ "AgreementTypeWorkRoleExclusions" ], "summary": "Get List of AgreementTypeWorkRoleExclusion", "operationId": "getFinanceAgreementTypesByParentIdWorkRoleExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeWorkRoleExclusion" } } } } } } }, "post": { "tags": [ "AgreementTypeWorkRoleExclusions" ], "summary": "Post AgreementTypeWorkRoleExclusion", "operationId": "postFinanceAgreementTypesByParentIdWorkRoleExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRoleExclusion" } } }, "required": true }, "responses": { "201": { "description": "AgreementTypeWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRoleExclusion" } } } } } } }, "/finance/agreementTypes/{parentId}/workRoleExclusions/{id}": { "get": { "tags": [ "AgreementTypeWorkRoleExclusions" ], "summary": "Get AgreementTypeWorkRoleExclusion", "operationId": "getFinanceAgreementTypesByParentIdWorkRoleExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementTypeWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRoleExclusion" } } } } } }, "delete": { "tags": [ "AgreementTypeWorkRoleExclusions" ], "summary": "Delete AgreementTypeWorkRoleExclusion", "operationId": "deleteFinanceAgreementTypesByParentIdWorkRoleExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreementTypes/{parentId}/workRoleExclusions/count": { "get": { "tags": [ "AgreementTypeWorkRoleExclusions" ], "summary": "Get Count of AgreementTypeWorkRoleExclusion", "operationId": "getFinanceAgreementTypesByParentIdWorkRoleExclusionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreementTypes/{parentId}/workroles": { "get": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Get List of AgreementTypeWorkRole", "operationId": "getFinanceAgreementTypesByParentIdWorkroles", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } } } } } }, "post": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Post AgreementTypeWorkRole", "operationId": "postFinanceAgreementTypesByParentIdWorkroles", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } }, "required": true }, "responses": { "201": { "description": "AgreementTypeWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } } } } } }, "/finance/agreementTypes/{parentId}/workroles/{id}": { "get": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Get AgreementTypeWorkRole", "operationId": "getFinanceAgreementTypesByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementTypeWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } } } } }, "delete": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Delete AgreementTypeWorkRole", "operationId": "deleteFinanceAgreementTypesByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Put AgreementTypeWorkRole", "operationId": "putFinanceAgreementTypesByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } }, "required": true }, "responses": { "200": { "description": "AgreementTypeWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } } } } }, "patch": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Patch AgreementTypeWorkRole", "operationId": "patchFinanceAgreementTypesByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementTypeWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRole" } } } } } } }, "/finance/agreementTypes/{parentId}/workroles/count": { "get": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Get Count of AgreementTypeWorkRole", "operationId": "getFinanceAgreementTypesByParentIdWorkrolesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreementTypes/{parentId}/workroles/info": { "get": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Get List of AgreementTypeWorkRole", "operationId": "getFinanceAgreementTypesByParentIdWorkrolesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeWorkRoleInfo" } } } } } } } }, "/finance/agreementTypes/{parentId}/workroles/info/{id}": { "get": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Get AgreementTypeWorkRoleInfo", "operationId": "getFinanceAgreementTypesByParentIdWorkrolesInfoById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementTypeWorkRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkRoleInfo" } } } } } } }, "/finance/agreementTypes/{parentId}/workroles/info/count": { "get": { "tags": [ "AgreementTypeWorkRoles" ], "summary": "Get Count of AgreementTypeWorkRoleInfo", "operationId": "getFinanceAgreementTypesByParentIdWorkrolesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreementTypes/{parentId}/workTypeExclusions": { "get": { "tags": [ "AgreementTypeWorkTypeExclusions" ], "summary": "Get List of AgreementTypeWorkTypeExclusion", "operationId": "getFinanceAgreementTypesByParentIdWorkTypeExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeWorkTypeExclusion" } } } } } } }, "post": { "tags": [ "AgreementTypeWorkTypeExclusions" ], "summary": "Post AgreementTypeWorkTypeExclusion", "operationId": "postFinanceAgreementTypesByParentIdWorkTypeExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workTypeExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkTypeExclusion" } } }, "required": true }, "responses": { "201": { "description": "AgreementTypeWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkTypeExclusion" } } } } } } }, "/finance/agreementTypes/{parentId}/workTypeExclusions/{id}": { "get": { "tags": [ "AgreementTypeWorkTypeExclusions" ], "summary": "Get AgreementTypeWorkTypeExclusion", "operationId": "getFinanceAgreementTypesByParentIdWorkTypeExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementTypeWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkTypeExclusion" } } } } } }, "delete": { "tags": [ "AgreementTypeWorkTypeExclusions" ], "summary": "Delete AgreementTypeWorkTypeExclusion", "operationId": "deleteFinanceAgreementTypesByParentIdWorkTypeExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreementTypes/{parentId}/workTypeExclusions/count": { "get": { "tags": [ "AgreementTypeWorkTypeExclusions" ], "summary": "Get Count of AgreementTypeWorkTypeExclusion", "operationId": "getFinanceAgreementTypesByParentIdWorkTypeExclusionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreementTypes/{parentId}/worktypes": { "get": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Get List of AgreementTypeWorkType", "operationId": "getFinanceAgreementTypesByParentIdWorktypes", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } } } } } }, "post": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Post AgreementTypeWorkType", "operationId": "postFinanceAgreementTypesByParentIdWorktypes", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } }, "required": true }, "responses": { "201": { "description": "AgreementTypeWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } } } } } }, "/finance/agreementTypes/{parentId}/worktypes/{id}": { "get": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Get AgreementTypeWorkType", "operationId": "getFinanceAgreementTypesByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementTypeWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } } } } }, "delete": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Delete AgreementTypeWorkType", "operationId": "deleteFinanceAgreementTypesByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Put AgreementTypeWorkType", "operationId": "putFinanceAgreementTypesByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } }, "required": true }, "responses": { "200": { "description": "AgreementTypeWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } } } } }, "patch": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Patch AgreementTypeWorkType", "operationId": "patchFinanceAgreementTypesByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementTypeWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementTypeWorkType" } } } } } } }, "/finance/agreementTypes/{parentId}/worktypes/count": { "get": { "tags": [ "AgreementTypeWorkTypes" ], "summary": "Get Count of AgreementTypeWorkType", "operationId": "getFinanceAgreementTypesByParentIdWorktypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/batchSetups": { "get": { "tags": [ "AgreementBatchSetup" ], "summary": "Get List of AgreementBatchSetup", "operationId": "getFinanceBatchSetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementBatchSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementBatchSetup" } } } } } } } }, "/finance/batchSetups/{id}": { "get": { "tags": [ "AgreementBatchSetup" ], "summary": "Get AgreementBatchSetup", "operationId": "getFinanceBatchSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "batchSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementBatchSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementBatchSetup" } } } } } }, "put": { "tags": [ "AgreementBatchSetup" ], "summary": "Put AgreementBatchSetup", "operationId": "putFinanceBatchSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "batchSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "batchSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementBatchSetup" } } }, "required": true }, "responses": { "200": { "description": "AgreementBatchSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementBatchSetup" } } } } } }, "patch": { "tags": [ "AgreementBatchSetup" ], "summary": "Patch AgreementBatchSetup", "operationId": "patchFinanceBatchSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "batchSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementBatchSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AgreementBatchSetup" } } } } } } }, "/finance/batchSetups/count": { "get": { "tags": [ "AgreementBatchSetup" ], "summary": "Get Count of AgreementBatchSetup", "operationId": "getFinanceBatchSetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingCycles": { "get": { "tags": [ "BillingCycles" ], "summary": "Get List of BillingCycle", "operationId": "getFinanceBillingCycles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingCycle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycle" } } } } } } }, "post": { "tags": [ "BillingCycles" ], "summary": "Post BillingCycle", "operationId": "postFinanceBillingCycles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingCycle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } }, "required": true }, "responses": { "201": { "description": "BillingCycle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } } } } } }, "/finance/billingCycles/{id}": { "get": { "tags": [ "BillingCycles" ], "summary": "Get BillingCycle", "operationId": "getFinanceBillingCyclesById", "parameters": [ { "name": "id", "in": "path", "description": "billingCycleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingCycle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } } } } }, "delete": { "tags": [ "BillingCycles" ], "summary": "Delete BillingCycle", "operationId": "deleteFinanceBillingCyclesById", "parameters": [ { "name": "id", "in": "path", "description": "billingCycleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BillingCycles" ], "summary": "Put BillingCycle", "operationId": "putFinanceBillingCyclesById", "parameters": [ { "name": "id", "in": "path", "description": "billingCycleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingCycle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } }, "required": true }, "responses": { "200": { "description": "BillingCycle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } } } } }, "patch": { "tags": [ "BillingCycles" ], "summary": "Patch BillingCycle", "operationId": "patchFinanceBillingCyclesById", "parameters": [ { "name": "id", "in": "path", "description": "billingCycleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BillingCycle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } } } } } }, "/finance/billingCycles/{id}/info": { "get": { "tags": [ "BillingCycleInfos" ], "summary": "Get BillingCycleInfos", "operationId": "getFinanceBillingCyclesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "BillingCycleInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingCycleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingCycleInfo" } } } } } } }, "/finance/billingCycles/{id}/usages": { "get": { "tags": [ "BillingCycles" ], "summary": "Get List of Usage Count", "operationId": "getFinanceBillingCyclesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "billingCycleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/billingCycles/{id}/usages/list": { "get": { "tags": [ "BillingCycles" ], "summary": "Get List of Usage", "operationId": "getFinanceBillingCyclesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "billingCycleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/billingCycles/count": { "get": { "tags": [ "BillingCycles" ], "summary": "Get Count of BillingCycle", "operationId": "getFinanceBillingCyclesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingCycles/info": { "get": { "tags": [ "BillingCycleInfos" ], "summary": "Get List of BillingCycleInfos", "operationId": "getFinanceBillingCyclesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of billingCycleInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingCycleInfo" } } } } } } } }, "/finance/billingCycles/info/count": { "get": { "tags": [ "BillingCycleInfos" ], "summary": "Get Count of BillingCycleInfos", "operationId": "getFinanceBillingCyclesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingSetups": { "get": { "tags": [ "BillingSetups" ], "summary": "Get List of BillingSetup", "operationId": "getFinanceBillingSetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingSetup" } } } } } } }, "post": { "tags": [ "BillingSetups" ], "summary": "Post BillingSetup", "operationId": "postFinanceBillingSetups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSetup" } } }, "required": true }, "responses": { "201": { "description": "BillingSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetup" } } } } } } }, "/finance/billingSetups/{id}": { "get": { "tags": [ "BillingSetups" ], "summary": "Get BillingSetup", "operationId": "getFinanceBillingSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetup" } } } } } }, "delete": { "tags": [ "BillingSetups" ], "summary": "Delete BillingSetup", "operationId": "deleteFinanceBillingSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BillingSetups" ], "summary": "Put BillingSetup", "operationId": "putFinanceBillingSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSetup" } } }, "required": true }, "responses": { "200": { "description": "BillingSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetup" } } } } } }, "patch": { "tags": [ "BillingSetups" ], "summary": "Patch BillingSetup", "operationId": "patchFinanceBillingSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BillingSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetup" } } } } } } }, "/finance/billingSetups/{id}/info": { "get": { "tags": [ "BillingSetupInfos" ], "summary": "Get BillingSetupInfos", "operationId": "getFinanceBillingSetupsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "BillingSetupInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingSetupInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetupInfo" } } } } } } }, "/finance/billingSetups/{parentId}/routings": { "get": { "tags": [ "BillingSetupRoutings" ], "summary": "Get List of BillingSetupRouting", "operationId": "getFinanceBillingSetupsByParentIdRoutings", "parameters": [ { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingSetupRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingSetupRouting" } } } } } } }, "post": { "tags": [ "BillingSetupRoutings" ], "summary": "Post BillingSetupRouting", "operationId": "postFinanceBillingSetupsByParentIdRoutings", "parameters": [ { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingSetupRouting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSetupRouting" } } }, "required": true }, "responses": { "201": { "description": "BillingSetupRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetupRouting" } } } } } } }, "/finance/billingSetups/{parentId}/routings/{id}": { "get": { "tags": [ "BillingSetupRoutings" ], "summary": "Get BillingSetupRouting", "operationId": "getFinanceBillingSetupsByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "routingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingSetupRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetupRouting" } } } } } }, "delete": { "tags": [ "BillingSetupRoutings" ], "summary": "Delete BillingSetupRouting", "operationId": "deleteFinanceBillingSetupsByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "routingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BillingSetupRoutings" ], "summary": "Put BillingSetupRouting", "operationId": "putFinanceBillingSetupsByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "routingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingSetupRouting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSetupRouting" } } }, "required": true }, "responses": { "200": { "description": "BillingSetupRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetupRouting" } } } } } }, "patch": { "tags": [ "BillingSetupRoutings" ], "summary": "Patch BillingSetupRouting", "operationId": "patchFinanceBillingSetupsByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "routingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BillingSetupRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingSetupRouting" } } } } } } }, "/finance/billingSetups/{parentId}/routings/count": { "get": { "tags": [ "BillingSetupRoutings" ], "summary": "Get Count of BillingSetupRouting", "operationId": "getFinanceBillingSetupsByParentIdRoutingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "billingSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingSetups/count": { "get": { "tags": [ "BillingSetups" ], "summary": "Get Count of BillingSetup", "operationId": "getFinanceBillingSetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingSetups/info": { "get": { "tags": [ "BillingSetupInfos" ], "summary": "Get List of BillingSetupInfos", "operationId": "getFinanceBillingSetupsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of billingSetupInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingSetupInfo" } } } } } } } }, "/finance/billingSetups/info/count": { "get": { "tags": [ "BillingSetupInfos" ], "summary": "Get Count of BillingSetupInfos", "operationId": "getFinanceBillingSetupsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingStatuses": { "get": { "tags": [ "BillingStatuses" ], "summary": "Get List of BillingStatus", "operationId": "getFinanceBillingStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingStatus" } } } } } } }, "post": { "tags": [ "BillingStatuses" ], "summary": "Post BillingStatus", "operationId": "postFinanceBillingStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatus" } } }, "required": true }, "responses": { "201": { "description": "BillingStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingStatus" } } } } } } }, "/finance/billingStatuses/{id}": { "get": { "tags": [ "BillingStatuses" ], "summary": "Get BillingStatus", "operationId": "getFinanceBillingStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingStatus" } } } } } }, "delete": { "tags": [ "BillingStatuses" ], "summary": "Delete BillingStatus", "operationId": "deleteFinanceBillingStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BillingStatuses" ], "summary": "Put BillingStatus", "operationId": "putFinanceBillingStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatus" } } }, "required": true }, "responses": { "200": { "description": "BillingStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingStatus" } } } } } }, "patch": { "tags": [ "BillingStatuses" ], "summary": "Patch BillingStatus", "operationId": "patchFinanceBillingStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BillingStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingStatus" } } } } } } }, "/finance/billingStatuses/{id}/info": { "get": { "tags": [ "BillingStatusInfos" ], "summary": "Get BillingStatusInfo", "operationId": "getFinanceBillingStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingStatusInfo" } } } } } } }, "/finance/billingStatuses/{id}/usages": { "get": { "tags": [ "BillingStatuses" ], "summary": "Get List of Usage Count", "operationId": "getFinanceBillingStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/billingStatuses/{id}/usages/list": { "get": { "tags": [ "BillingStatuses" ], "summary": "Get List of Usage", "operationId": "getFinanceBillingStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "billingStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/billingStatuses/count": { "get": { "tags": [ "BillingStatuses" ], "summary": "Get Count of BillingStatus", "operationId": "getFinanceBillingStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingStatuses/info": { "get": { "tags": [ "BillingStatusInfos" ], "summary": "Get List of BillingStatusInfo", "operationId": "getFinanceBillingStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingStatusInfo" } } } } } } } }, "/finance/billingStatuses/info/count": { "get": { "tags": [ "BillingStatusInfos" ], "summary": "Get Count of BillingStatusInfo", "operationId": "getFinanceBillingStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingTerms": { "get": { "tags": [ "BillingTerms" ], "summary": "Get List of BillingTerm", "operationId": "getFinanceBillingTerms", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingTerm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingTerm" } } } } } } }, "post": { "tags": [ "BillingTerms" ], "summary": "Post BillingTerm", "operationId": "postFinanceBillingTerms", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingTerms", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingTerm" } } }, "required": true }, "responses": { "201": { "description": "BillingTerm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingTerm" } } } } } } }, "/finance/billingTerms/{id}": { "get": { "tags": [ "BillingTerms" ], "summary": "Get BillingTerm", "operationId": "getFinanceBillingTermsById", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingTerm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingTerm" } } } } } }, "delete": { "tags": [ "BillingTerms" ], "summary": "Delete BillingTerm", "operationId": "deleteFinanceBillingTermsById", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BillingTerms" ], "summary": "Put BillingTerm", "operationId": "putFinanceBillingTermsById", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingTerms", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingTerm" } } }, "required": true }, "responses": { "200": { "description": "BillingTerm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingTerm" } } } } } }, "patch": { "tags": [ "BillingTerms" ], "summary": "Patch BillingTerm", "operationId": "patchFinanceBillingTermsById", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BillingTerm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingTerm" } } } } } } }, "/finance/billingTerms/{id}/info": { "get": { "tags": [ "BillingTermInfos" ], "summary": "Get BillingTermInfo", "operationId": "getFinanceBillingTermsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BillingTermInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingTermInfo" } } } } } } }, "/finance/billingTerms/{id}/usages": { "get": { "tags": [ "BillingTerms" ], "summary": "Get List of Usage Count", "operationId": "getFinanceBillingTermsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/billingTerms/{id}/usages/list": { "get": { "tags": [ "BillingTerms" ], "summary": "Get List of Usage", "operationId": "getFinanceBillingTermsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "billingTermId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/billingTerms/count": { "get": { "tags": [ "BillingTerms" ], "summary": "Get Count of BillingTerm", "operationId": "getFinanceBillingTermsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/billingTerms/info": { "get": { "tags": [ "BillingTermInfos" ], "summary": "Get List of BillingTermInfo", "operationId": "getFinanceBillingTermsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BillingTermInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingTermInfo" } } } } } } } }, "/finance/billingTerms/info/count": { "get": { "tags": [ "BillingTermInfos" ], "summary": "Get Count of BillingTermInfo", "operationId": "getFinanceBillingTermsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/closedInvoices/{id}": { "put": { "tags": [ "ClosedInvoices" ], "summary": "Put ClosedInvoice", "operationId": "putFinanceClosedInvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "closedInvoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "closedInvoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosedInvoice" } } }, "required": true }, "responses": { "200": { "description": "ClosedInvoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ClosedInvoice" } } } } } }, "patch": { "tags": [ "ClosedInvoices" ], "summary": "Patch ClosedInvoice", "operationId": "patchFinanceClosedInvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "closedInvoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ClosedInvoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ClosedInvoice" } } } } } } }, "/finance/companyFinance/": { "get": { "tags": [ "CompanyFinances" ], "summary": "Get List of CompanyFinances", "operationId": "getFinanceCompanyFinance", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of companyFinances", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFinance" } } } } } } } }, "/finance/companyFinance/{id}": { "get": { "tags": [ "CompanyFinances" ], "summary": "Get CompanyFinances", "operationId": "getFinanceCompanyFinanceById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyFinance", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyFinance" } } } } } }, "put": { "tags": [ "CompanyFinances" ], "summary": "Put CompanyFinance", "operationId": "putFinanceCompanyFinanceById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "CompanyFinance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyFinance" } } }, "required": true }, "responses": { "200": { "description": "CompanyFinance", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyFinance" } } } } } }, "patch": { "tags": [ "CompanyFinances" ], "summary": "Patch CompanyFinances", "operationId": "patchFinanceCompanyFinanceById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyFinance", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CompanyFinance" } } } } } } }, "/finance/companyFinance/count": { "get": { "tags": [ "CompanyFinances" ], "summary": "Get Count of CompanyFinances", "operationId": "getFinanceCompanyFinanceCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/currencies": { "get": { "tags": [ "Currencies" ], "summary": "Get List of Currency", "operationId": "getFinanceCurrencies", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Currency", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Finance.Currency" } } } } } } }, "post": { "tags": [ "Currencies" ], "summary": "Post Currency", "operationId": "postFinanceCurrencies", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "currency", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Finance.Currency" } } }, "required": true }, "responses": { "201": { "description": "Currency", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Finance.Currency" } } } } } } }, "/finance/currencies/{id}": { "get": { "tags": [ "Currencies" ], "summary": "Get Currency", "operationId": "getFinanceCurrenciesById", "parameters": [ { "name": "id", "in": "path", "description": "currencyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Currency", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Finance.Currency" } } } } } }, "put": { "tags": [ "Currencies" ], "summary": "Put Currency", "operationId": "putFinanceCurrenciesById", "parameters": [ { "name": "id", "in": "path", "description": "currencyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "currency", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Finance.Currency" } } }, "required": true }, "responses": { "200": { "description": "Currency", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Finance.Currency" } } } } } }, "patch": { "tags": [ "Currencies" ], "summary": "Patch Currency", "operationId": "patchFinanceCurrenciesById", "parameters": [ { "name": "id", "in": "path", "description": "currencyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Currency", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Finance.Currency" } } } } } }, "delete": { "tags": [ "Currencies" ], "summary": "Delete Currency", "operationId": "deleteFinanceCurrenciesById", "parameters": [ { "name": "id", "in": "path", "description": "currencyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/currencies/{id}/info": { "get": { "tags": [ "CurrencyInfos" ], "summary": "Get CurrencyInfos", "operationId": "getFinanceCurrenciesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "CurrencyInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CurrencyInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CurrencyInfo" } } } } } } }, "/finance/currencies/{id}/usages": { "get": { "tags": [ "Currencies" ], "summary": "Get List of Usage Count", "operationId": "getFinanceCurrenciesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "currencyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/currencies/{id}/usages/list": { "get": { "tags": [ "Currencies" ], "summary": "Get List of Usage", "operationId": "getFinanceCurrenciesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "currencyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/currencies/count": { "get": { "tags": [ "Currencies" ], "summary": "Get Count of Currency", "operationId": "getFinanceCurrenciesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/currencies/info": { "get": { "tags": [ "CurrencyInfos" ], "summary": "Get List of CurrencyInfos", "operationId": "getFinanceCurrenciesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of currencyInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyInfo" } } } } } } } }, "/finance/currencies/info/count": { "get": { "tags": [ "CurrencyInfos" ], "summary": "Get Count of Currency", "operationId": "getFinanceCurrenciesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/deliveryMethods": { "get": { "tags": [ "DeliveryMethod" ], "summary": "Get List of DeliveryMethod", "operationId": "getFinanceDeliveryMethods", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DeliveryMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryMethod" } } } } } } }, "post": { "tags": [ "DeliveryMethod" ], "summary": "Post DeliveryMethod", "operationId": "postFinanceDeliveryMethods", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "deliveryMethod", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryMethod" } } }, "required": true }, "responses": { "201": { "description": "DeliveryMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DeliveryMethod" } } } } } } }, "/finance/deliveryMethods/{id}": { "get": { "tags": [ "DeliveryMethod" ], "summary": "Get DeliveryMethod", "operationId": "getFinanceDeliveryMethodsById", "parameters": [ { "name": "id", "in": "path", "description": "deliveryMethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DeliveryMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DeliveryMethod" } } } } } }, "delete": { "tags": [ "DeliveryMethod" ], "summary": "Delete DeliveryMethod", "operationId": "deleteFinanceDeliveryMethodsById", "parameters": [ { "name": "id", "in": "path", "description": "deliveryMethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "DeliveryMethod" ], "summary": "Put DeliveryMethod", "operationId": "putFinanceDeliveryMethodsById", "parameters": [ { "name": "id", "in": "path", "description": "deliveryMethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "deliveryMethod", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryMethod" } } }, "required": true }, "responses": { "200": { "description": "DeliveryMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DeliveryMethod" } } } } } }, "patch": { "tags": [ "DeliveryMethod" ], "summary": "Patch DeliveryMethod", "operationId": "patchFinanceDeliveryMethodsById", "parameters": [ { "name": "id", "in": "path", "description": "deliveryMethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "DeliveryMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DeliveryMethod" } } } } } } }, "/finance/deliveryMethods/count": { "get": { "tags": [ "DeliveryMethod" ], "summary": "Get Count of DeliveryMethod", "operationId": "getFinanceDeliveryMethodsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/glAccounts": { "get": { "tags": [ "GLAccounts" ], "summary": "Get List of GLAccount", "operationId": "getFinanceGlAccounts", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of GLAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GLAccount" } } } } } } }, "post": { "tags": [ "GLAccounts" ], "summary": "Post GLAccount", "operationId": "postFinanceGlAccounts", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "glAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLAccount" } } }, "required": true }, "responses": { "201": { "description": "GLAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLAccount" } } } } } } }, "/finance/glAccounts/{id}": { "get": { "tags": [ "GLAccounts" ], "summary": "Get GLAccount", "operationId": "getFinanceGlAccountsById", "parameters": [ { "name": "id", "in": "path", "description": "glAccountId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "GLAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLAccount" } } } } } }, "put": { "tags": [ "GLAccounts" ], "summary": "Put GLAccount", "operationId": "putFinanceGlAccountsById", "parameters": [ { "name": "id", "in": "path", "description": "glAccountId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "glAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLAccount" } } }, "required": true }, "responses": { "200": { "description": "GLAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLAccount" } } } } } }, "patch": { "tags": [ "GLAccounts" ], "summary": "Patch GLAccount", "operationId": "patchFinanceGlAccountsById", "parameters": [ { "name": "id", "in": "path", "description": "glAccountId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "GLAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLAccount" } } } } } }, "delete": { "tags": [ "GLAccounts" ], "summary": "Delete GLAccount", "operationId": "deleteFinanceGlAccountsById", "parameters": [ { "name": "id", "in": "path", "description": "glAccountId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/glAccounts/count": { "get": { "tags": [ "GLAccounts" ], "summary": "Get Count of GLAccount", "operationId": "getFinanceGlAccountsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/glAccounts/mappedTypes": { "get": { "tags": [ "MappedTypes" ], "summary": "Get List of MappedType", "operationId": "getFinanceGlAccountsMappedTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MappedType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MappedType" } } } } } } } }, "/finance/glAccounts/mappedTypes/count": { "get": { "tags": [ "MappedTypes" ], "summary": "Get Count of MappedType", "operationId": "getFinanceGlAccountsMappedTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/glCaptions": { "get": { "tags": [ "GLCaptions" ], "summary": "Get List of GLCaption", "operationId": "getFinanceGlCaptions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of GLCaption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GLCaption" } } } } } } } }, "/finance/glCaptions/{id}": { "get": { "tags": [ "GLCaptions" ], "summary": "Get GLCaption", "operationId": "getFinanceGlCaptionsById", "parameters": [ { "name": "id", "in": "path", "description": "glCaptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "GLCaption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLCaption" } } } } } }, "put": { "tags": [ "GLCaptions" ], "summary": "Put GLCaption", "operationId": "putFinanceGlCaptionsById", "parameters": [ { "name": "id", "in": "path", "description": "glCaptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "glCaption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLCaption" } } }, "required": true }, "responses": { "200": { "description": "GLCaption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLCaption" } } } } } }, "patch": { "tags": [ "GLCaptions" ], "summary": "Patch GLCaption", "operationId": "patchFinanceGlCaptionsById", "parameters": [ { "name": "id", "in": "path", "description": "glCaptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "GLCaption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLCaption" } } } } } } }, "/finance/glCaptions/count": { "get": { "tags": [ "GLCaptions" ], "summary": "Get Count of GLCaption", "operationId": "getFinanceGlCaptionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/glpaths": { "get": { "tags": [ "GLPaths" ], "summary": "Get List of GLPath", "operationId": "getFinanceGlpaths", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of GLPath", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GLPath" } } } } } } }, "post": { "tags": [ "GLPaths" ], "summary": "Post GLPath", "operationId": "postFinanceGlpaths", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "gLPath", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLPath" } } }, "required": true }, "responses": { "201": { "description": "GLPath", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLPath" } } } } } } }, "/finance/glpaths/{id}": { "get": { "tags": [ "GLPaths" ], "summary": "Get GLPath", "operationId": "getFinanceGlpathsById", "parameters": [ { "name": "id", "in": "path", "description": "glpathId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "GLPath", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLPath" } } } } } }, "delete": { "tags": [ "GLPaths" ], "summary": "Delete GLPath", "operationId": "deleteFinanceGlpathsById", "parameters": [ { "name": "id", "in": "path", "description": "glpathId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "GLPaths" ], "summary": "Put GLPath", "operationId": "putFinanceGlpathsById", "parameters": [ { "name": "id", "in": "path", "description": "glpathId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "gLPath", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLPath" } } }, "required": true }, "responses": { "200": { "description": "GLPath", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLPath" } } } } } }, "patch": { "tags": [ "GLPaths" ], "summary": "Patch GLPath", "operationId": "patchFinanceGlpathsById", "parameters": [ { "name": "id", "in": "path", "description": "glpathId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "GLPath", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLPath" } } } } } } }, "/finance/glpaths/count": { "get": { "tags": [ "GLPaths" ], "summary": "Get Count of GLPath", "operationId": "getFinanceGlpathsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/info/currencyCodes": { "get": { "tags": [ "CurrencyCodes" ], "summary": "Get List of CurrencyCode", "operationId": "getFinanceInfoCurrencyCodes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CurrencyCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyCode" } } } } } } } }, "/finance/info/currencyCodes/{id}": { "get": { "tags": [ "CurrencyCodes" ], "summary": "Get CurrencyCode", "operationId": "getFinanceInfoCurrencyCodesById", "parameters": [ { "name": "id", "in": "path", "description": "currencyCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CurrencyCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CurrencyCode" } } } } } } }, "/finance/info/currencyCodes/count": { "get": { "tags": [ "CurrencyCodes" ], "summary": "Get Count of CurrencyCode", "operationId": "getFinanceInfoCurrencyCodesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/info/invoice/{id}": { "get": { "tags": [ "InvoiceInfos" ], "summary": "Get InvoiceInfo", "operationId": "getFinanceInfoInvoiceById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceInfo" } } } } } } }, "/finance/info/taxIntegrations": { "get": { "tags": [ "TaxIntegrationInfos" ], "summary": "Get List of TaxIntegrationInfo", "operationId": "getFinanceInfoTaxIntegrations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxIntegrationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxIntegrationInfo" } } } } } } } }, "/finance/info/taxIntegrations/{id}": { "get": { "tags": [ "TaxIntegrationInfos" ], "summary": "Get TaxIntegrationInfo", "operationId": "getFinanceInfoTaxIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "taxIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxIntegrationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxIntegrationInfo" } } } } } } }, "/finance/info/taxIntegrations/count": { "get": { "tags": [ "TaxIntegrationInfos" ], "summary": "Get Count of TaxIntegrationInfo", "operationId": "getFinanceInfoTaxIntegrationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/invoiceEmailTemplates": { "get": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Get List of InvoiceEmailTemplate", "operationId": "getFinanceInvoiceEmailTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InvoiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } } } } } }, "post": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Post InvoiceEmailTemplate", "operationId": "postFinanceInvoiceEmailTemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoiceEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } }, "required": true }, "responses": { "201": { "description": "InvoiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } } } } } }, "/finance/invoiceEmailTemplates/{id}": { "get": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Get InvoiceEmailTemplate", "operationId": "getFinanceInvoiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceEmailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } } } } }, "delete": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Delete InvoiceEmailTemplate", "operationId": "deleteFinanceInvoiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceEmailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Put InvoiceEmailTemplate", "operationId": "putFinanceInvoiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceEmailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoiceEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } }, "required": true }, "responses": { "200": { "description": "InvoiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } } } } }, "patch": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Patch InvoiceEmailTemplate", "operationId": "patchFinanceInvoiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceEmailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InvoiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplate" } } } } } } }, "/finance/invoiceEmailTemplates/{id}/info": { "get": { "tags": [ "InvoiceEmailTemplateInfos" ], "summary": "Get InvoiceEmailTemplateInfos", "operationId": "getFinanceInvoiceEmailTemplatesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "InvoiceEmailTemplateInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceEmailTemplateInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceEmailTemplateInfo" } } } } } } }, "/finance/invoiceEmailTemplates/{id}/usages": { "get": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Get List of Usage Count", "operationId": "getFinanceInvoiceEmailTemplatesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "invoiceEmailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/invoiceEmailTemplates/{id}/usages/list": { "get": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Get List of Usage", "operationId": "getFinanceInvoiceEmailTemplatesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "invoiceEmailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/invoiceEmailTemplates/count": { "get": { "tags": [ "InvoiceEmailTemplates" ], "summary": "Get Count of InvoiceEmailTemplate", "operationId": "getFinanceInvoiceEmailTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/invoiceEmailTemplates/info": { "get": { "tags": [ "InvoiceEmailTemplateInfos" ], "summary": "Get List of InvoiceEmailTemplateInfos", "operationId": "getFinanceInvoiceEmailTemplatesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of invoiceEmailTemplateInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceEmailTemplateInfo" } } } } } } } }, "/finance/invoiceEmailTemplates/info/count": { "get": { "tags": [ "InvoiceEmailTemplateInfos" ], "summary": "Get Count of InvoiceEmailTemplateInfos", "operationId": "getFinanceInvoiceEmailTemplatesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/invoices": { "get": { "tags": [ "Invoices" ], "summary": "Get List of Invoice", "operationId": "getFinanceInvoices", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Invoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } } } } } }, "post": { "tags": [ "Invoices" ], "summary": "Post Invoice", "operationId": "postFinanceInvoices", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "required": true }, "responses": { "201": { "description": "Invoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } } } }, "/finance/invoices/{id}": { "get": { "tags": [ "Invoices" ], "summary": "Get Invoice", "operationId": "getFinanceInvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } } }, "delete": { "tags": [ "Invoices" ], "summary": "Delete Invoice", "operationId": "deleteFinanceInvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Invoices" ], "summary": "Put Invoice", "operationId": "putFinanceInvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "required": true }, "responses": { "200": { "description": "Invoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } } }, "patch": { "tags": [ "Invoices" ], "summary": "Patch Invoice", "operationId": "patchFinanceInvoicesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Invoice", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } } } }, "/finance/invoices/{id}/pdf": { "get": { "tags": [ "Invoices" ], "summary": "Get Invoice", "operationId": "getFinanceInvoicesByIdPdf", "parameters": [ { "name": "id", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/pdf", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/finance/invoices/{parentId}/commissions": { "get": { "tags": [ "InvoiceCommissions" ], "summary": "Get List of InvoiceCommissions", "operationId": "getFinanceInvoicesByParentIdCommissions", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of invoiceCommissionses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceCommission" } } } } } } } }, "/finance/invoices/{parentId}/commissions/{id}": { "get": { "tags": [ "InvoiceCommissions" ], "summary": "Get InvoiceCommissions", "operationId": "getFinanceInvoicesByParentIdCommissionsById", "parameters": [ { "name": "id", "in": "path", "description": "paymentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceCommission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceCommission" } } } } } }, "patch": { "tags": [ "InvoiceCommissions" ], "summary": "Patch InvoiceCommissions", "operationId": "patchFinanceInvoicesByParentIdCommissionsById", "parameters": [ { "name": "id", "in": "path", "description": "InvoiceCommissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InvoiceCommission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceCommission" } } } } } } }, "/finance/invoices/{parentId}/commissions/recalculate": { "post": { "tags": [ "InvoiceCommissions" ], "summary": "Recalculate InvoiceCommissions", "operationId": "postFinanceInvoicesByParentIdCommissionsRecalculate", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } } } }, "/finance/invoices/{parentId}/glEntries/": { "get": { "tags": [ "GLEntries" ], "summary": "Get List of GLEntries", "operationId": "getFinanceInvoicesByParentIdGlEntries", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of gLEntrieses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GLEntry" } } } } } } } }, "/finance/invoices/{parentId}/glEntries/{id}": { "get": { "tags": [ "GLEntries" ], "summary": "Get GLEntries", "operationId": "getFinanceInvoicesByParentIdGlEntriesById", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "gLEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "gLEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLEntry" } } } } } }, "put": { "tags": [ "GLEntries" ], "summary": "Put GLEntries", "operationId": "putFinanceInvoicesByParentIdGlEntriesById", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "gLEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "gLEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GLEntry" } } }, "required": true }, "responses": { "200": { "description": "gLEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLEntry" } } } } } }, "patch": { "tags": [ "GLEntries" ], "summary": "Patch GLEntries", "operationId": "patchFinanceInvoicesByParentIdGlEntriesById", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "GLEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "gLEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GLEntry" } } } } } } }, "/finance/invoices/{parentId}/payments": { "get": { "tags": [ "InvoicePayments" ], "summary": "Get List of Payment", "operationId": "getFinanceInvoicesByParentIdPayments", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Payment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePayment" } } } } } } }, "post": { "tags": [ "InvoicePayments" ], "summary": "Post Payment", "operationId": "postFinanceInvoicesByParentIdPayments", "parameters": [ { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } }, "required": true }, "responses": { "201": { "description": "Payment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } } } } } }, "/finance/invoices/{parentId}/payments/{id}": { "get": { "tags": [ "InvoicePayments" ], "summary": "Get Payment", "operationId": "getFinanceInvoicesByParentIdPaymentsById", "parameters": [ { "name": "id", "in": "path", "description": "paymentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } } } } }, "patch": { "tags": [ "InvoicePayments" ], "summary": "Patch Payment", "operationId": "patchFinanceInvoicesByParentIdPaymentsById", "parameters": [ { "name": "id", "in": "path", "description": "paymentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Payment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } } } } }, "put": { "tags": [ "InvoicePayments" ], "summary": "Put Payment", "operationId": "putFinanceInvoicesByParentIdPaymentsById", "parameters": [ { "name": "id", "in": "path", "description": "paymentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } }, "required": true }, "responses": { "200": { "description": "Payment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } } } } }, "delete": { "tags": [ "InvoicePayments" ], "summary": "Delete Payment", "operationId": "deleteFinanceInvoicesByParentIdPaymentsById", "parameters": [ { "name": "id", "in": "path", "description": "paymentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "invoiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/invoices/{parentId}/routings": { "get": { "tags": [ "Invoice Routings" ], "summary": "Get List of Invoice Routings", "operationId": "getFinanceInvoicesByParentIdRoutings", "parameters": [ { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of invoiceRoutings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRouting" } } } } } } }, "post": { "tags": [ "Invoice Routings" ], "summary": "Post Invoice Routings", "operationId": "postFinanceInvoicesByParentIdRoutings", "parameters": [ { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "InvoiceRouting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRouting" } } }, "required": true }, "responses": { "201": { "description": "InvoiceRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceRouting" } } } } } } }, "/finance/invoices/{parentId}/routings/{id}": { "get": { "tags": [ "Invoice Routings" ], "summary": "Get Invoice Routings", "operationId": "getFinanceInvoicesByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "InvoiceRoutingsId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceRouting" } } } } } }, "delete": { "tags": [ "Invoice Routings" ], "summary": "Delete Invoice Routings", "operationId": "deleteFinanceInvoicesByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "InvoiceRoutingsId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Invoice Routings" ], "summary": "Put Invoice Routings", "operationId": "putFinanceInvoicesByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "InvoiceRoutingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRouting" } } }, "required": true }, "responses": { "200": { "description": "InvoiceRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceRouting" } } } } } }, "patch": { "tags": [ "Invoice Routings" ], "summary": "Patch Invoice Routings", "operationId": "patchFinanceInvoicesByParentIdRoutingsById", "parameters": [ { "name": "id", "in": "path", "description": "InvoiceRoutingsId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InvoiceRouting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceRouting" } } } } } } }, "/finance/invoices/{parentId}/routings/count": { "get": { "tags": [ "Invoice Routings" ], "summary": "Get Count of Invoice Routings", "operationId": "getFinanceInvoicesByParentIdRoutingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "Invoice", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/invoices/count": { "get": { "tags": [ "Invoices" ], "summary": "Get Count of Invoice", "operationId": "getFinanceInvoicesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/invoiceTemplates": { "get": { "tags": [ "InvoiceTemplates" ], "summary": "Get List of InvoiceTemplate", "operationId": "getFinanceInvoiceTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InvoiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTemplate" } } } } } } }, "post": { "tags": [ "InvoiceTemplates" ], "summary": "Post InvoiceTemplate", "operationId": "postFinanceInvoiceTemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoiceTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceTemplate" } } }, "required": true }, "responses": { "201": { "description": "InvoiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceTemplate" } } } } } } }, "/finance/invoiceTemplates/{id}": { "get": { "tags": [ "InvoiceTemplates" ], "summary": "Get InvoiceTemplate", "operationId": "getFinanceInvoiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceTemplate" } } } } } }, "patch": { "tags": [ "InvoiceTemplates" ], "summary": "Patch InvoiceTemplate", "operationId": "patchFinanceInvoiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InvoiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceTemplate" } } } } } }, "put": { "tags": [ "InvoiceTemplates" ], "summary": "Put InvoiceTemplate", "operationId": "putFinanceInvoiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoiceTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceTemplate" } } }, "required": true }, "responses": { "200": { "description": "InvoiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceTemplate" } } } } } }, "delete": { "tags": [ "InvoiceTemplates" ], "summary": "Delete Usage", "operationId": "deleteFinanceInvoiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/invoiceTemplates/{id}/usages": { "get": { "tags": [ "InvoiceTemplates" ], "summary": "Get List of Usage Count", "operationId": "getFinanceInvoiceTemplatesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/invoiceTemplates/{id}/usages/list": { "get": { "tags": [ "InvoiceTemplates" ], "summary": "Get List of Usage", "operationId": "getFinanceInvoiceTemplatesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/invoiceTemplates/count": { "get": { "tags": [ "InvoiceTemplates" ], "summary": "Get Count of InvoiceTemplate", "operationId": "getFinanceInvoiceTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/invoiceTemplateSetups": { "get": { "tags": [ "InvoiceTemplateSetups" ], "summary": "Get List of InvoiceTemplateSetup\r\n Retrieves a list of standard and custom invoice templates", "operationId": "getFinanceInvoiceTemplateSetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InvoiceTemplateSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceTemplateSetup" } } } } } } } }, "/finance/invoiceTemplateSetups/{id}": { "get": { "tags": [ "InvoiceTemplateSetups" ], "summary": "Get InvoiceTemplateSetup", "operationId": "getFinanceInvoiceTemplateSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceTemplateSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceTemplateSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceTemplateSetup" } } } } } } }, "/finance/invoiceTemplateSetups/count": { "get": { "tags": [ "InvoiceTemplateSetups" ], "summary": "Get Count of InvoiceTemplateSetup", "operationId": "getFinanceInvoiceTemplateSetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes": { "get": { "tags": [ "TaxCodes" ], "summary": "Get List of TaxCode", "operationId": "getFinanceTaxCodes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxCode" } } } } } } }, "post": { "tags": [ "TaxCodes" ], "summary": "Post TaxCode", "operationId": "postFinanceTaxCodes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxCode", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCode" } } }, "required": true }, "responses": { "201": { "description": "TaxCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCode" } } } } } } }, "/finance/taxCodes/{grandparentId}/expenseTypeExemptions/{parentId}/taxableExpenseTypeLevels": { "get": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Get List of TaxableExpenseTypeLevel", "operationId": "getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxableExpenseTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } } } } } }, "post": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Post TaxableExpenseTypeLevel", "operationId": "postFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableExpenseTypeLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } }, "required": true }, "responses": { "201": { "description": "TaxableExpenseTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/expenseTypeExemptions/{parentId}/taxableExpenseTypeLevels/{id}": { "get": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Get TaxableExpenseTypeLevel", "operationId": "getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableExpenseTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxableExpenseTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } } } } }, "delete": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Delete TaxableExpenseTypeLevel", "operationId": "deleteFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableExpenseTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Put TaxableExpenseTypeLevel", "operationId": "putFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableExpenseTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableExpenseTypeLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } }, "required": true }, "responses": { "200": { "description": "TaxableExpenseTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } } } } }, "patch": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Patch TaxableExpenseTypeLevel", "operationId": "patchFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableExpenseTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxableExpenseTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableExpenseTypeLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/expenseTypeExemptions/{parentId}/taxableExpenseTypeLevels/count": { "get": { "tags": [ "TaxableExpenseTypeLevels" ], "summary": "Get Count of TaxableExpenseTypeLevel", "operationId": "getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{grandparentId}/productTypeExemptions/{parentId}/taxableProductTypeLevels": { "get": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Get List of TaxableProductTypeLevel", "operationId": "getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxableProductTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } } } } } }, "post": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Post TaxableProductTypeLevel", "operationId": "postFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableProductTypeLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } }, "required": true }, "responses": { "201": { "description": "TaxableProductTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/productTypeExemptions/{parentId}/taxableProductTypeLevels/{id}": { "get": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Get TaxableProductTypeLevel", "operationId": "getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableProductTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxableProductTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } } } } }, "delete": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Delete TaxableProductTypeLevel", "operationId": "deleteFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableProductTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Put TaxableProductTypeLevel", "operationId": "putFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableProductTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableProductTypeLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } }, "required": true }, "responses": { "200": { "description": "TaxableProductTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } } } } }, "patch": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Patch TaxableProductTypeLevel", "operationId": "patchFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableProductTypeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxableProductTypeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableProductTypeLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/productTypeExemptions/{parentId}/taxableProductTypeLevels/count": { "get": { "tags": [ "TaxableProductTypeLevels" ], "summary": "Get Count of TaxableProductTypeLevel", "operationId": "getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{grandparentId}/taxCodeXRefs/{parentId}/taxableXRefLevels": { "get": { "tags": [ "TaxableXRefLevels" ], "summary": "Get List of TaxableXRefLevel", "operationId": "getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxableXRefLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxableXRefLevel" } } } } } } }, "post": { "tags": [ "TaxableXRefLevels" ], "summary": "Post TaxableXRefLevel", "operationId": "postFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableXRefLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableXRefLevel" } } }, "required": true }, "responses": { "201": { "description": "TaxableXRefLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableXRefLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/taxCodeXRefs/{parentId}/taxableXRefLevels/{id}": { "get": { "tags": [ "TaxableXRefLevels" ], "summary": "Get TaxableXRefLevel", "operationId": "getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableXRefLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxableXRefLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableXRefLevel" } } } } } }, "delete": { "tags": [ "TaxableXRefLevels" ], "summary": "Delete TaxableXRefLevel", "operationId": "deleteFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableXRefLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxableXRefLevels" ], "summary": "Put TaxableXRefLevel", "operationId": "putFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableXRefLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableXRefLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableXRefLevel" } } }, "required": true }, "responses": { "200": { "description": "TaxableXRefLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableXRefLevel" } } } } } }, "patch": { "tags": [ "TaxableXRefLevels" ], "summary": "Patch TaxableXRefLevel", "operationId": "patchFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableXRefLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxableXRefLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableXRefLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/taxCodeXRefs/{parentId}/taxableXRefLevels/count": { "get": { "tags": [ "TaxableXRefLevels" ], "summary": "Get Count of TaxableXRefLevel", "operationId": "getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{grandparentId}/workRoleExemptions/{parentId}/taxableWorkRoleLevels": { "get": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Get List of TaxableWorkRoleLevel", "operationId": "getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxableWorkRoleLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } } } } } }, "post": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Post TaxableWorkRoleLevel", "operationId": "postFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableWorkRoleLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } }, "required": true }, "responses": { "201": { "description": "TaxableWorkRoleLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/workRoleExemptions/{parentId}/taxableWorkRoleLevels/{id}": { "get": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Get TaxableWorkRoleLevel", "operationId": "getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableWorkRoleLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxableWorkRoleLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } } } } }, "delete": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Delete TaxableWorkRoleLevel", "operationId": "deleteFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableWorkRoleLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Put TaxableWorkRoleLevel", "operationId": "putFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableWorkRoleLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxableWorkRoleLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } }, "required": true }, "responses": { "200": { "description": "TaxableWorkRoleLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } } } } }, "patch": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Patch TaxableWorkRoleLevel", "operationId": "patchFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxableWorkRoleLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxableWorkRoleLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxableWorkRoleLevel" } } } } } } }, "/finance/taxCodes/{grandparentId}/workRoleExemptions/{parentId}/taxableWorkRoleLevels/count": { "get": { "tags": [ "TaxableWorkRoleLevels" ], "summary": "Get Count of TaxableWorkRoleLevel", "operationId": "getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{id}": { "get": { "tags": [ "TaxCodes" ], "summary": "Get TaxCode", "operationId": "getFinanceTaxCodesById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCode" } } } } } }, "delete": { "tags": [ "TaxCodes" ], "summary": "Delete Usage", "operationId": "deleteFinanceTaxCodesById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxCodes" ], "summary": "Put TaxCode", "operationId": "putFinanceTaxCodesById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxCode", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCode" } } }, "required": true }, "responses": { "200": { "description": "TaxCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCode" } } } } } }, "patch": { "tags": [ "TaxCodes" ], "summary": "Patch TaxCode", "operationId": "patchFinanceTaxCodesById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCode" } } } } } } }, "/finance/taxCodes/{id}/copy": { "post": { "tags": [ "TaxCodes" ], "summary": "Post TaxCode", "operationId": "postFinanceTaxCodesByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCode" } } } } } } }, "/finance/taxCodes/{id}/info": { "get": { "tags": [ "TaxCodeInfos" ], "summary": "Get TaxCodeInfos", "operationId": "getFinanceTaxCodesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "TaxCodeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxCodeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeInfo" } } } } } } }, "/finance/taxCodes/{id}/usages": { "get": { "tags": [ "TaxCodes" ], "summary": "Get List of Usage Count", "operationId": "getFinanceTaxCodesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/taxCodes/{id}/usages/list": { "get": { "tags": [ "TaxCodes" ], "summary": "Get List of Usage", "operationId": "getFinanceTaxCodesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/taxCodes/{parentId}/expenseTypeExemptions": { "get": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Get List of ExpenseTypeExemption", "operationId": "getFinanceTaxCodesByParentIdExpenseTypeExemptions", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ExpenseTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } } } } } }, "post": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Post ExpenseTypeExemption", "operationId": "postFinanceTaxCodesByParentIdExpenseTypeExemptions", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "expenseTypeExemption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } }, "required": true }, "responses": { "201": { "description": "ExpenseTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } } } } } }, "/finance/taxCodes/{parentId}/expenseTypeExemptions/{id}": { "get": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Get ExpenseTypeExemption", "operationId": "getFinanceTaxCodesByParentIdExpenseTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ExpenseTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } } } } }, "delete": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Delete ExpenseTypeExemption", "operationId": "deleteFinanceTaxCodesByParentIdExpenseTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Put ExpenseTypeExemption", "operationId": "putFinanceTaxCodesByParentIdExpenseTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "expenseTypeExemption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } }, "required": true }, "responses": { "200": { "description": "ExpenseTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } } } } }, "patch": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Patch ExpenseTypeExemption", "operationId": "patchFinanceTaxCodesByParentIdExpenseTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ExpenseTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ExpenseTypeExemption" } } } } } } }, "/finance/taxCodes/{parentId}/expenseTypeExemptions/count": { "get": { "tags": [ "TaxCodeExpenseTypeExemptions" ], "summary": "Get Count of ExpenseTypeExemption", "operationId": "getFinanceTaxCodesByParentIdExpenseTypeExemptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{parentId}/productTypeExemptions": { "get": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Get List of ProductTypeExemption", "operationId": "getFinanceTaxCodesByParentIdProductTypeExemptions", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeExemption" } } } } } } }, "post": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Post ProductTypeExemption", "operationId": "postFinanceTaxCodesByParentIdProductTypeExemptions", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productTypeExemption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTypeExemption" } } }, "required": true }, "responses": { "201": { "description": "ProductTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductTypeExemption" } } } } } } }, "/finance/taxCodes/{parentId}/productTypeExemptions/{id}": { "get": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Get ProductTypeExemption", "operationId": "getFinanceTaxCodesByParentIdProductTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProductTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductTypeExemption" } } } } } }, "delete": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Delete ProductTypeExemption", "operationId": "deleteFinanceTaxCodesByParentIdProductTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Put ProductTypeExemption", "operationId": "putFinanceTaxCodesByParentIdProductTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productTypeExemption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTypeExemption" } } }, "required": true }, "responses": { "200": { "description": "ProductTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductTypeExemption" } } } } } }, "patch": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Patch ProductTypeExemption", "operationId": "patchFinanceTaxCodesByParentIdProductTypeExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "productTypeExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProductTypeExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductTypeExemption" } } } } } } }, "/finance/taxCodes/{parentId}/productTypeExemptions/count": { "get": { "tags": [ "TaxCodeProductTypeExemptions" ], "summary": "Get Count of ProductTypeExemption", "operationId": "getFinanceTaxCodesByParentIdProductTypeExemptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{parentId}/taxCodeLevels": { "get": { "tags": [ "TaxCodeLevels" ], "summary": "Get List of TaxCodeLevel", "operationId": "getFinanceTaxCodesByParentIdTaxCodeLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxCodeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxCodeLevel" } } } } } } }, "post": { "tags": [ "TaxCodeLevels" ], "summary": "Post TaxCodeLevel", "operationId": "postFinanceTaxCodesByParentIdTaxCodeLevels", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxCodeLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCodeLevel" } } }, "required": true }, "responses": { "201": { "description": "TaxCodeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeLevel" } } } } } } }, "/finance/taxCodes/{parentId}/taxCodeLevels/{id}": { "get": { "tags": [ "TaxCodeLevels" ], "summary": "Get TaxCodeLevel", "operationId": "getFinanceTaxCodesByParentIdTaxCodeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxCodeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeLevel" } } } } } }, "delete": { "tags": [ "TaxCodeLevels" ], "summary": "Delete TaxCodeLevel", "operationId": "deleteFinanceTaxCodesByParentIdTaxCodeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxCodeLevels" ], "summary": "Put TaxCodeLevel", "operationId": "putFinanceTaxCodesByParentIdTaxCodeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxCodeLevel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCodeLevel" } } }, "required": true }, "responses": { "200": { "description": "TaxCodeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeLevel" } } } } } }, "patch": { "tags": [ "TaxCodeLevels" ], "summary": "Patch TaxCodeLevel", "operationId": "patchFinanceTaxCodesByParentIdTaxCodeLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxCodeLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeLevel" } } } } } } }, "/finance/taxCodes/{parentId}/taxCodeLevels/count": { "get": { "tags": [ "TaxCodeLevels" ], "summary": "Get Count of TaxCodeLevel", "operationId": "getFinanceTaxCodesByParentIdTaxCodeLevelsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{parentId}/taxCodeXRefs": { "get": { "tags": [ "TaxCodeXRefs" ], "summary": "Get List of TaxCodeXRef", "operationId": "getFinanceTaxCodesByParentIdTaxCodeXRefs", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxCodeXRef", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxCodeXRef" } } } } } } }, "post": { "tags": [ "TaxCodeXRefs" ], "summary": "Post TaxCodeXRef", "operationId": "postFinanceTaxCodesByParentIdTaxCodeXRefs", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxCodeXRef", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCodeXRef" } } }, "required": true }, "responses": { "201": { "description": "TaxCodeXRef", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeXRef" } } } } } } }, "/finance/taxCodes/{parentId}/taxCodeXRefs/{id}": { "get": { "tags": [ "TaxCodeXRefs" ], "summary": "Get TaxCodeXRef", "operationId": "getFinanceTaxCodesByParentIdTaxCodeXRefsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxCodeXRef", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeXRef" } } } } } }, "delete": { "tags": [ "TaxCodeXRefs" ], "summary": "Delete TaxCodeXRef", "operationId": "deleteFinanceTaxCodesByParentIdTaxCodeXRefsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxCodeXRefs" ], "summary": "Put TaxCodeXRef", "operationId": "putFinanceTaxCodesByParentIdTaxCodeXRefsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxCodeXRef", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxCodeXRef" } } }, "required": true }, "responses": { "200": { "description": "TaxCodeXRef", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeXRef" } } } } } }, "patch": { "tags": [ "TaxCodeXRefs" ], "summary": "Patch TaxCodeXRef", "operationId": "patchFinanceTaxCodesByParentIdTaxCodeXRefsById", "parameters": [ { "name": "id", "in": "path", "description": "taxCodeXRefId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxCodeXRef", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxCodeXRef" } } } } } } }, "/finance/taxCodes/{parentId}/taxCodeXRefs/count": { "get": { "tags": [ "TaxCodeXRefs" ], "summary": "Get Count of TaxCodeXRef", "operationId": "getFinanceTaxCodesByParentIdTaxCodeXRefsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/{parentId}/workRoleExemptions": { "get": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Get List of WorkRoleExemption", "operationId": "getFinanceTaxCodesByParentIdWorkRoleExemptions", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRoleExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRoleExemption" } } } } } } }, "post": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Post WorkRoleExemption", "operationId": "postFinanceTaxCodesByParentIdWorkRoleExemptions", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleExemption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRoleExemption" } } }, "required": true }, "responses": { "201": { "description": "WorkRoleExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleExemption" } } } } } } }, "/finance/taxCodes/{parentId}/workRoleExemptions/{id}": { "get": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Get WorkRoleExemption", "operationId": "getFinanceTaxCodesByParentIdWorkRoleExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRoleExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleExemption" } } } } } }, "delete": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Delete WorkRoleExemption", "operationId": "deleteFinanceTaxCodesByParentIdWorkRoleExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Put WorkRoleExemption", "operationId": "putFinanceTaxCodesByParentIdWorkRoleExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleExemption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRoleExemption" } } }, "required": true }, "responses": { "200": { "description": "WorkRoleExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleExemption" } } } } } }, "patch": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Patch WorkRoleExemption", "operationId": "patchFinanceTaxCodesByParentIdWorkRoleExemptionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExemptionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkRoleExemption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleExemption" } } } } } } }, "/finance/taxCodes/{parentId}/workRoleExemptions/count": { "get": { "tags": [ "TaxCodeWorkRoleExemptions" ], "summary": "Get Count of WorkRoleExemption", "operationId": "getFinanceTaxCodesByParentIdWorkRoleExemptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "taxCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/count": { "get": { "tags": [ "TaxCodes" ], "summary": "Get Count of TaxCode", "operationId": "getFinanceTaxCodesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxCodes/info": { "get": { "tags": [ "TaxCodeInfos" ], "summary": "Get List of TaxCodeInfos", "operationId": "getFinanceTaxCodesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of taxCodeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxCodeInfo" } } } } } } } }, "/finance/taxCodes/info/count": { "get": { "tags": [ "TaxCodeInfos" ], "summary": "Get Count of TaxCodeInfos", "operationId": "getFinanceTaxCodesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/taxIntegrations": { "get": { "tags": [ "TaxIntegrations" ], "summary": "Get List of TaxIntegration", "operationId": "getFinanceTaxIntegrations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TaxIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxIntegration" } } } } } } } }, "/finance/taxIntegrations/{id}": { "get": { "tags": [ "TaxIntegrations" ], "summary": "Get TaxIntegration", "operationId": "getFinanceTaxIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "taxIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TaxIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxIntegration" } } } } } }, "put": { "tags": [ "TaxIntegrations" ], "summary": "Put TaxIntegration", "operationId": "putFinanceTaxIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "taxIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "taxIntegration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxIntegration" } } }, "required": true }, "responses": { "200": { "description": "TaxIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxIntegration" } } } } } }, "patch": { "tags": [ "TaxIntegrations" ], "summary": "Patch TaxIntegration", "operationId": "patchFinanceTaxIntegrationsById", "parameters": [ { "name": "id", "in": "path", "description": "taxIntegrationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TaxIntegration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TaxIntegration" } } } } } } }, "/finance/taxIntegrations/count": { "get": { "tags": [ "TaxIntegrations" ], "summary": "Get Count of TaxIntegration", "operationId": "getFinanceTaxIntegrationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns": { "get": { "tags": [ "Campaigns" ], "summary": "Get List of Campaign", "operationId": "getMarketingCampaigns", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Campaign", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign" } } } } } } }, "post": { "tags": [ "Campaigns" ], "summary": "Post Campaign", "operationId": "postMarketingCampaigns", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "required": true }, "responses": { "201": { "description": "Campaign", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } } } }, "/marketing/campaigns/{id}": { "get": { "tags": [ "Campaigns" ], "summary": "Get Campaign", "operationId": "getMarketingCampaignsById", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Campaign", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } } }, "delete": { "tags": [ "Campaigns" ], "summary": "Delete Campaign", "operationId": "deleteMarketingCampaignsById", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Campaigns" ], "summary": "Put Campaign", "operationId": "putMarketingCampaignsById", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "required": true }, "responses": { "200": { "description": "Campaign", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } } }, "patch": { "tags": [ "Campaigns" ], "summary": "Patch Campaign", "operationId": "patchMarketingCampaignsById", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Campaign", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign" } } } } } } }, "/marketing/campaigns/{id}/activities": { "get": { "tags": [ "Campaigns" ], "summary": "Get List of ActivityReference", "operationId": "getMarketingCampaignsByIdActivities", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityReference" } } } } } } } }, "/marketing/campaigns/{id}/activities/count": { "get": { "tags": [ "Campaigns" ], "summary": "Get Count of ActivityReference", "operationId": "getMarketingCampaignsByIdActivitiesCount", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/{id}/opportunities": { "get": { "tags": [ "Campaigns" ], "summary": "Get List of OpportunityReference", "operationId": "getMarketingCampaignsByIdOpportunities", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityReference" } } } } } } } }, "/marketing/campaigns/{id}/opportunities/count": { "get": { "tags": [ "Campaigns" ], "summary": "Get Count of OpportunityReference", "operationId": "getMarketingCampaignsByIdOpportunitiesCount", "parameters": [ { "name": "id", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/{parentId}/audits": { "get": { "tags": [ "CampaignAudits" ], "summary": "Get List of CampaignAudit", "operationId": "getMarketingCampaignsByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CampaignAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignAudit" } } } } } } }, "post": { "tags": [ "CampaignAudits" ], "summary": "Post CampaignAudit", "operationId": "postMarketingCampaignsByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignAudit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAudit" } } }, "required": true }, "responses": { "201": { "description": "CampaignAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignAudit" } } } } } } }, "/marketing/campaigns/{parentId}/audits/{id}": { "get": { "tags": [ "CampaignAudits" ], "summary": "Get CampaignAudit", "operationId": "getMarketingCampaignsByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CampaignAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignAudit" } } } } } }, "delete": { "tags": [ "CampaignAudits" ], "summary": "Delete CampaignAudit", "operationId": "deleteMarketingCampaignsByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignAudits" ], "summary": "Put CampaignAudit", "operationId": "putMarketingCampaignsByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignAudit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignAudit" } } }, "required": true }, "responses": { "200": { "description": "CampaignAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignAudit" } } } } } }, "patch": { "tags": [ "CampaignAudits" ], "summary": "Patch CampaignAudit", "operationId": "patchMarketingCampaignsByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CampaignAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignAudit" } } } } } } }, "/marketing/campaigns/{parentId}/audits/count": { "get": { "tags": [ "CampaignAudits" ], "summary": "Get Count of CampaignAudit", "operationId": "getMarketingCampaignsByParentIdAuditsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/{parentId}/emailsOpened": { "get": { "tags": [ "CampaignEmailsOpened" ], "summary": "Get List of EmailOpened", "operationId": "getMarketingCampaignsByParentIdEmailsOpened", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EmailOpened", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailOpened" } } } } } } }, "post": { "tags": [ "CampaignEmailsOpened" ], "summary": "Post EmailOpened", "operationId": "postMarketingCampaignsByParentIdEmailsOpened", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailOpened", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailOpened" } } }, "required": true }, "responses": { "201": { "description": "EmailOpened", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailOpened" } } } } } } }, "/marketing/campaigns/{parentId}/emailsOpened/{id}": { "get": { "tags": [ "CampaignEmailsOpened" ], "summary": "Get EmailOpened", "operationId": "getMarketingCampaignsByParentIdEmailsOpenedById", "parameters": [ { "name": "id", "in": "path", "description": "emailsOpenedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailOpened", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailOpened" } } } } } }, "delete": { "tags": [ "CampaignEmailsOpened" ], "summary": "Delete EmailOpened", "operationId": "deleteMarketingCampaignsByParentIdEmailsOpenedById", "parameters": [ { "name": "id", "in": "path", "description": "emailsOpenedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignEmailsOpened" ], "summary": "Put EmailOpened", "operationId": "putMarketingCampaignsByParentIdEmailsOpenedById", "parameters": [ { "name": "id", "in": "path", "description": "emailsOpenedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailOpened", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailOpened" } } }, "required": true }, "responses": { "200": { "description": "EmailOpened", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailOpened" } } } } } }, "patch": { "tags": [ "CampaignEmailsOpened" ], "summary": "Patch EmailOpened", "operationId": "patchMarketingCampaignsByParentIdEmailsOpenedById", "parameters": [ { "name": "id", "in": "path", "description": "emailsOpenedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "EmailOpened", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailOpened" } } } } } } }, "/marketing/campaigns/{parentId}/emailsOpened/count": { "get": { "tags": [ "CampaignEmailsOpened" ], "summary": "Get Count of EmailOpened", "operationId": "getMarketingCampaignsByParentIdEmailsOpenedCount", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/{parentId}/formsSubmitted": { "get": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Get List of FormSubmitted", "operationId": "getMarketingCampaignsByParentIdFormsSubmitted", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of FormSubmitted", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormSubmitted" } } } } } } }, "post": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Post FormSubmitted", "operationId": "postMarketingCampaignsByParentIdFormsSubmitted", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "formSubmitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmitted" } } }, "required": true }, "responses": { "201": { "description": "FormSubmitted", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FormSubmitted" } } } } } } }, "/marketing/campaigns/{parentId}/formsSubmitted/{id}": { "get": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Get FormSubmitted", "operationId": "getMarketingCampaignsByParentIdFormsSubmittedById", "parameters": [ { "name": "id", "in": "path", "description": "formsSubmittedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "FormSubmitted", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FormSubmitted" } } } } } }, "delete": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Delete FormSubmitted", "operationId": "deleteMarketingCampaignsByParentIdFormsSubmittedById", "parameters": [ { "name": "id", "in": "path", "description": "formsSubmittedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Put FormSubmitted", "operationId": "putMarketingCampaignsByParentIdFormsSubmittedById", "parameters": [ { "name": "id", "in": "path", "description": "formsSubmittedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "formSubmitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmitted" } } }, "required": true }, "responses": { "200": { "description": "FormSubmitted", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FormSubmitted" } } } } } }, "patch": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Patch FormSubmitted", "operationId": "patchMarketingCampaignsByParentIdFormsSubmittedById", "parameters": [ { "name": "id", "in": "path", "description": "formsSubmittedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "FormSubmitted", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FormSubmitted" } } } } } } }, "/marketing/campaigns/{parentId}/formsSubmitted/count": { "get": { "tags": [ "CampaignFormsSubmitted" ], "summary": "Get Count of FormSubmitted", "operationId": "getMarketingCampaignsByParentIdFormsSubmittedCount", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/{parentId}/linksClicked": { "get": { "tags": [ "CampaignLinksClicked" ], "summary": "Get List of LinkClicked", "operationId": "getMarketingCampaignsByParentIdLinksClicked", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LinkClicked", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkClicked" } } } } } } }, "post": { "tags": [ "CampaignLinksClicked" ], "summary": "Post LinkClicked", "operationId": "postMarketingCampaignsByParentIdLinksClicked", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "linkClicked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkClicked" } } }, "required": true }, "responses": { "201": { "description": "LinkClicked", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LinkClicked" } } } } } } }, "/marketing/campaigns/{parentId}/linksClicked/{id}": { "get": { "tags": [ "CampaignLinksClicked" ], "summary": "Get LinkClicked", "operationId": "getMarketingCampaignsByParentIdLinksClickedById", "parameters": [ { "name": "id", "in": "path", "description": "linksClickedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LinkClicked", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LinkClicked" } } } } } }, "delete": { "tags": [ "CampaignLinksClicked" ], "summary": "Delete LinkClicked", "operationId": "deleteMarketingCampaignsByParentIdLinksClickedById", "parameters": [ { "name": "id", "in": "path", "description": "linksClickedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignLinksClicked" ], "summary": "Put LinkClicked", "operationId": "putMarketingCampaignsByParentIdLinksClickedById", "parameters": [ { "name": "id", "in": "path", "description": "linksClickedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "linkClicked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkClicked" } } }, "required": true }, "responses": { "200": { "description": "LinkClicked", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LinkClicked" } } } } } }, "patch": { "tags": [ "CampaignLinksClicked" ], "summary": "Patch LinkClicked", "operationId": "patchMarketingCampaignsByParentIdLinksClickedById", "parameters": [ { "name": "id", "in": "path", "description": "linksClickedId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "LinkClicked", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LinkClicked" } } } } } } }, "/marketing/campaigns/{parentId}/linksClicked/count": { "get": { "tags": [ "CampaignLinksClicked" ], "summary": "Get Count of LinkClicked", "operationId": "getMarketingCampaignsByParentIdLinksClickedCount", "parameters": [ { "name": "parentId", "in": "path", "description": "campaignId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/count": { "get": { "tags": [ "Campaigns" ], "summary": "Get Count of Campaign", "operationId": "getMarketingCampaignsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/statuses": { "get": { "tags": [ "CampaignStatuses" ], "summary": "Get List of CampaignStatus", "operationId": "getMarketingCampaignsStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CampaignStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignStatus" } } } } } } }, "post": { "tags": [ "CampaignStatuses" ], "summary": "Post CampaignStatus", "operationId": "postMarketingCampaignsStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } }, "required": true }, "responses": { "201": { "description": "CampaignStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } } } } } }, "/marketing/campaigns/statuses/{id}": { "get": { "tags": [ "CampaignStatuses" ], "summary": "Get CampaignStatus", "operationId": "getMarketingCampaignsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CampaignStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } } } } }, "delete": { "tags": [ "CampaignStatuses" ], "summary": "Delete CampaignStatus", "operationId": "deleteMarketingCampaignsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignStatuses" ], "summary": "Put CampaignStatus", "operationId": "putMarketingCampaignsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } }, "required": true }, "responses": { "200": { "description": "CampaignStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } } } } }, "patch": { "tags": [ "CampaignStatuses" ], "summary": "Patch CampaignStatus", "operationId": "patchMarketingCampaignsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CampaignStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignStatus" } } } } } } }, "/marketing/campaigns/statuses/count": { "get": { "tags": [ "CampaignStatuses" ], "summary": "Get Count of CampaignStatus", "operationId": "getMarketingCampaignsStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/subTypes": { "get": { "tags": [ "CampaignSubTypes" ], "summary": "Get List of CampaignSubType", "operationId": "getMarketingCampaignsSubTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } } } } } }, "post": { "tags": [ "CampaignSubTypes" ], "summary": "Post CampaignSubType", "operationId": "postMarketingCampaignsSubTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignSubType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } }, "required": true }, "responses": { "201": { "description": "CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } } } } } }, "/marketing/campaigns/subTypes/{id}": { "get": { "tags": [ "CampaignSubTypes" ], "summary": "Get CampaignSubType", "operationId": "getMarketingCampaignsSubTypesById", "parameters": [ { "name": "id", "in": "path", "description": "subTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } } } } }, "delete": { "tags": [ "CampaignSubTypes" ], "summary": "Delete CampaignSubType", "operationId": "deleteMarketingCampaignsSubTypesById", "parameters": [ { "name": "id", "in": "path", "description": "subTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignSubTypes" ], "summary": "Put CampaignSubType", "operationId": "putMarketingCampaignsSubTypesById", "parameters": [ { "name": "id", "in": "path", "description": "subTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignSubType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } }, "required": true }, "responses": { "200": { "description": "CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } } } } }, "patch": { "tags": [ "CampaignSubTypes" ], "summary": "Patch CampaignSubType", "operationId": "patchMarketingCampaignsSubTypesById", "parameters": [ { "name": "id", "in": "path", "description": "subTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Campaign.SubType.CampaignSubType" } } } } } } }, "/marketing/campaigns/subTypes/count": { "get": { "tags": [ "CampaignSubTypes" ], "summary": "Get Count of CampaignSubType", "operationId": "getMarketingCampaignsSubTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/types": { "get": { "tags": [ "CampaignTypes" ], "summary": "Get List of CampaignType", "operationId": "getMarketingCampaignsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CampaignType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignType" } } } } } } }, "post": { "tags": [ "CampaignTypes" ], "summary": "Post CampaignType", "operationId": "postMarketingCampaignsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignType" } } }, "required": true }, "responses": { "201": { "description": "CampaignType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignType" } } } } } } }, "/marketing/campaigns/types/{id}": { "get": { "tags": [ "CampaignTypes" ], "summary": "Get CampaignType", "operationId": "getMarketingCampaignsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CampaignType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignType" } } } } } }, "delete": { "tags": [ "CampaignTypes" ], "summary": "Delete CampaignType", "operationId": "deleteMarketingCampaignsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CampaignTypes" ], "summary": "Put CampaignType", "operationId": "putMarketingCampaignsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "campaignType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignType" } } }, "required": true }, "responses": { "200": { "description": "CampaignType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignType" } } } } } }, "patch": { "tags": [ "CampaignTypes" ], "summary": "Patch CampaignType", "operationId": "patchMarketingCampaignsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CampaignType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignType" } } } } } } }, "/marketing/campaigns/types/{id}/info": { "get": { "tags": [ "CampaignTypeInfos" ], "summary": "Get CampaignTypeInfo", "operationId": "getMarketingCampaignsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CampaignTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CampaignTypeInfo" } } } } } } }, "/marketing/campaigns/types/{parentId}/subTypes": { "get": { "tags": [ "LegacyCampaignSubTypes" ], "summary": "Get List of CampaignSubType", "operationId": "getMarketingCampaignsTypesByParentIdSubTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Type.SubType.CampaignSubType" } } } } } } } }, "/marketing/campaigns/types/{parentId}/subTypes/{id}": { "get": { "tags": [ "LegacyCampaignSubTypes" ], "summary": "Get CampaignSubType", "operationId": "getMarketingCampaignsTypesByParentIdSubTypesById", "parameters": [ { "name": "id", "in": "path", "description": "subTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CampaignSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Type.SubType.CampaignSubType" } } } } } } }, "/marketing/campaigns/types/{parentId}/subTypes/count": { "get": { "tags": [ "LegacyCampaignSubTypes" ], "summary": "Get Count of CampaignSubType", "operationId": "getMarketingCampaignsTypesByParentIdSubTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/types/count": { "get": { "tags": [ "CampaignTypes" ], "summary": "Get Count of CampaignType", "operationId": "getMarketingCampaignsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/campaigns/types/info": { "get": { "tags": [ "CampaignTypeInfos" ], "summary": "Get List of CampaignTypeInfos", "operationId": "getMarketingCampaignsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CampaignTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignTypeInfo" } } } } } } } }, "/marketing/campaigns/types/info/count": { "get": { "tags": [ "CampaignTypeInfos" ], "summary": "Get Count of CampaignTypeInfos", "operationId": "getMarketingCampaignsTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/groups": { "get": { "tags": [ "Groups" ], "summary": "Get List of Group", "operationId": "getMarketingGroups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Group", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } } } } }, "post": { "tags": [ "Groups" ], "summary": "Post Group", "operationId": "postMarketingGroups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "required": true }, "responses": { "201": { "description": "Group", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Group" } } } } } } }, "/marketing/groups/{id}": { "get": { "tags": [ "Groups" ], "summary": "Get Group", "operationId": "getMarketingGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Group", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Group" } } } } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete Group", "operationId": "deleteMarketingGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Groups" ], "summary": "Put Group", "operationId": "putMarketingGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "required": true }, "responses": { "200": { "description": "Group", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Group" } } } } } }, "patch": { "tags": [ "Groups" ], "summary": "Patch Group", "operationId": "patchMarketingGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Group", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Group" } } } } } } }, "/marketing/groups/{id}/info": { "get": { "tags": [ "GroupInfos" ], "summary": "Get Group Info", "operationId": "getMarketingGroupsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "GroupInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GroupInfo" } } } } } } }, "/marketing/groups/{id}/usages": { "get": { "tags": [ "Groups" ], "summary": "Get List of Usage", "operationId": "getMarketingGroupsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/marketing/groups/{id}/usages/list": { "get": { "tags": [ "Groups" ], "summary": "Get List of Usage", "operationId": "getMarketingGroupsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/marketing/groups/{parentId}/companies": { "get": { "tags": [ "MarketingCompanies" ], "summary": "Get List of MarketingCompany", "operationId": "getMarketingGroupsByParentIdCompanies", "parameters": [ { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MarketingCompany", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketingCompany" } } } } } } }, "post": { "tags": [ "MarketingCompanies" ], "summary": "Post MarketingCompany", "operationId": "postMarketingGroupsByParentIdCompanies", "parameters": [ { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketingCompany", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingCompany" } } }, "required": true }, "responses": { "201": { "description": "MarketingCompany", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingCompany" } } } } } } }, "/marketing/groups/{parentId}/companies/{id}": { "get": { "tags": [ "MarketingCompanies" ], "summary": "Get MarketingCompany", "operationId": "getMarketingGroupsByParentIdCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MarketingCompany", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingCompany" } } } } } }, "delete": { "tags": [ "MarketingCompanies" ], "summary": "Delete MarketingCompany", "operationId": "deleteMarketingGroupsByParentIdCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MarketingCompanies" ], "summary": "Put MarketingCompany", "operationId": "putMarketingGroupsByParentIdCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketingCompany", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingCompany" } } }, "required": true }, "responses": { "200": { "description": "MarketingCompany", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingCompany" } } } } } }, "patch": { "tags": [ "MarketingCompanies" ], "summary": "Patch MarketingCompany", "operationId": "patchMarketingGroupsByParentIdCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MarketingCompany", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingCompany" } } } } } } }, "/marketing/groups/{parentId}/companies/count": { "get": { "tags": [ "MarketingCompanies" ], "summary": "Get Count of MarketingCompany", "operationId": "getMarketingGroupsByParentIdCompaniesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/groups/{parentId}/contacts": { "get": { "tags": [ "MarketingContacts" ], "summary": "Get List of MarketingContact", "operationId": "getMarketingGroupsByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MarketingContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketingContact" } } } } } } }, "post": { "tags": [ "MarketingContacts" ], "summary": "Post MarketingContact", "operationId": "postMarketingGroupsByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketingContact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingContact" } } }, "required": true }, "responses": { "201": { "description": "MarketingContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingContact" } } } } } } }, "/marketing/groups/{parentId}/contacts/{id}": { "get": { "tags": [ "MarketingContacts" ], "summary": "Get MarketingContact", "operationId": "getMarketingGroupsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MarketingContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingContact" } } } } } }, "delete": { "tags": [ "MarketingContacts" ], "summary": "Delete MarketingContact", "operationId": "deleteMarketingGroupsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MarketingContacts" ], "summary": "Put MarketingContact", "operationId": "putMarketingGroupsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketingContact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingContact" } } }, "required": true }, "responses": { "200": { "description": "MarketingContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingContact" } } } } } }, "patch": { "tags": [ "MarketingContacts" ], "summary": "Patch MarketingContact", "operationId": "patchMarketingGroupsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MarketingContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketingContact" } } } } } } }, "/marketing/groups/{parentId}/contacts/count": { "get": { "tags": [ "MarketingContacts" ], "summary": "Get Count of MarketingContact", "operationId": "getMarketingGroupsByParentIdContactsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/groups/count": { "get": { "tags": [ "Groups" ], "summary": "Get Count of Group", "operationId": "getMarketingGroupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/marketing/groups/info": { "get": { "tags": [ "GroupInfos" ], "summary": "Get List of GroupInfo", "operationId": "getMarketingGroupsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of GroupInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" } } } } } } } }, "/marketing/groups/info/count": { "get": { "tags": [ "GroupInfos" ], "summary": "Get Count of Group Info", "operationId": "getMarketingGroupsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/adjustments": { "get": { "tags": [ "ProcurementAdjustments" ], "summary": "Get List of ProcurementAdjustment", "operationId": "getProcurementAdjustments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProcurementAdjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcurementAdjustment" } } } } } } }, "post": { "tags": [ "ProcurementAdjustments" ], "summary": "Post ProcurementAdjustment", "operationId": "postProcurementAdjustments", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcurementAdjustment" } } }, "required": true }, "responses": { "201": { "description": "ProcurementAdjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementAdjustment" } } } } } } }, "/procurement/adjustments/{id}": { "get": { "tags": [ "ProcurementAdjustments" ], "summary": "Get ProcurementAdjustment", "operationId": "getProcurementAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProcurementAdjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementAdjustment" } } } } } }, "delete": { "tags": [ "ProcurementAdjustments" ], "summary": "Delete ProcurementAdjustment", "operationId": "deleteProcurementAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProcurementAdjustments" ], "summary": "Put ProcurementAdjustment", "operationId": "putProcurementAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcurementAdjustment" } } }, "required": true }, "responses": { "200": { "description": "ProcurementAdjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementAdjustment" } } } } } }, "patch": { "tags": [ "ProcurementAdjustments" ], "summary": "Patch ProcurementAdjustment", "operationId": "patchProcurementAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProcurementAdjustment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementAdjustment" } } } } } } }, "/procurement/adjustments/{parentId}/details": { "get": { "tags": [ "AdjustmentDetails" ], "summary": "Get List of AdjustmentDetail", "operationId": "getProcurementAdjustmentsByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AdjustmentDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdjustmentDetail" } } } } } } }, "post": { "tags": [ "AdjustmentDetails" ], "summary": "Post AdjustmentDetail", "operationId": "postProcurementAdjustmentsByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustmentDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustmentDetail" } } }, "required": true }, "responses": { "201": { "description": "AdjustmentDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentDetail" } } } } } } }, "/procurement/adjustments/{parentId}/details/{id}": { "get": { "tags": [ "AdjustmentDetails" ], "summary": "Get AdjustmentDetail", "operationId": "getProcurementAdjustmentsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AdjustmentDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentDetail" } } } } } }, "delete": { "tags": [ "AdjustmentDetails" ], "summary": "Delete AdjustmentDetail", "operationId": "deleteProcurementAdjustmentsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/procurement/adjustments/{parentId}/details/count": { "get": { "tags": [ "AdjustmentDetails" ], "summary": "Get Count of AdjustmentDetail", "operationId": "getProcurementAdjustmentsByParentIdDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/adjustments/count": { "get": { "tags": [ "ProcurementAdjustments" ], "summary": "Get Count of ProcurementAdjustment", "operationId": "getProcurementAdjustmentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/adjustments/types": { "get": { "tags": [ "AdjustmentTypes" ], "summary": "Get List of AdjustmentType", "operationId": "getProcurementAdjustmentsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AdjustmentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdjustmentType" } } } } } } }, "post": { "tags": [ "AdjustmentTypes" ], "summary": "Post AdjustmentType", "operationId": "postProcurementAdjustmentsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustmentTypes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustmentType" } } }, "required": true }, "responses": { "201": { "description": "AdjustmentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentType" } } } } } } }, "/procurement/adjustments/types/{id}": { "get": { "tags": [ "AdjustmentTypes" ], "summary": "Get AdjustmentType", "operationId": "getProcurementAdjustmentsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AdjustmentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentType" } } } } } }, "delete": { "tags": [ "AdjustmentTypes" ], "summary": "Delete AdjustmentType", "operationId": "deleteProcurementAdjustmentsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AdjustmentTypes" ], "summary": "Put AdjustmentType", "operationId": "putProcurementAdjustmentsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustmentTypes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdjustmentType" } } }, "required": true }, "responses": { "200": { "description": "AdjustmentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentType" } } } } } }, "patch": { "tags": [ "AdjustmentTypes" ], "summary": "Patch AdjustmentType", "operationId": "patchProcurementAdjustmentsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AdjustmentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentType" } } } } } } }, "/procurement/adjustments/types/{id}/info": { "get": { "tags": [ "AdjustmentTypeInfos" ], "summary": "Get AdjustmentTypeInfos", "operationId": "getProcurementAdjustmentsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "AdjustmentTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AdjustmentTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AdjustmentTypeInfo" } } } } } } }, "/procurement/adjustments/types/{id}/usages": { "get": { "tags": [ "AdjustmentTypes" ], "summary": "Get List of Usage", "operationId": "getProcurementAdjustmentsTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/adjustments/types/{id}/usages/list": { "get": { "tags": [ "AdjustmentTypes" ], "summary": "Get List of Usage", "operationId": "getProcurementAdjustmentsTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/adjustments/types/count": { "get": { "tags": [ "AdjustmentTypes" ], "summary": "Get Count of Usage", "operationId": "getProcurementAdjustmentsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/adjustments/types/info": { "get": { "tags": [ "AdjustmentTypeInfos" ], "summary": "Get List of AdjustmentTypeInfos", "operationId": "getProcurementAdjustmentsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of adjustmentTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AdjustmentTypeInfo" } } } } } } } }, "/procurement/adjustments/types/info/count": { "get": { "tags": [ "AdjustmentTypeInfos" ], "summary": "Get Count of AdjustmentTypeInfos", "operationId": "getProcurementAdjustmentsTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get List of CatalogItem", "operationId": "getProcurementCatalog", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CatalogItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogItem" } } } } } } }, "post": { "tags": [ "CatalogsItem" ], "summary": "Post CatalogItem", "operationId": "postProcurementCatalog", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } }, "required": true }, "responses": { "201": { "description": "CatalogItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } } } } }, "/procurement/catalog/{catalogItemIdentifier}/quantityOnHand": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get Count of CatalogItem", "operationId": "getProcurementCatalogByCatalogItemIdentifierQuantityOnHand", "parameters": [ { "name": "catalogItemIdentifier", "in": "path", "description": "catalogItemIdentifier", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "warehouseBinId", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog/{id}": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get CatalogItem", "operationId": "getProcurementCatalogById", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CatalogItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } } } }, "delete": { "tags": [ "CatalogsItem" ], "summary": "Delete CatalogItem", "operationId": "deleteProcurementCatalogById", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CatalogsItem" ], "summary": "Put CatalogItem", "operationId": "putProcurementCatalogById", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } }, "required": true }, "responses": { "200": { "description": "CatalogItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } } } }, "patch": { "tags": [ "CatalogsItem" ], "summary": "Patch CatalogItem", "operationId": "patchProcurementCatalogById", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CatalogItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } } } } }, "/procurement/catalog/{id}/copy": { "post": { "tags": [ "CatalogsItem" ], "summary": "Post Copy CatalogItem", "operationId": "postProcurementCatalogByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CatalogItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } } } } } }, "/procurement/catalog/{id}/info": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get CatalogItemInfo", "operationId": "getProcurementCatalogByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CatalogItemInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogItemInfo" } } } } } } }, "/procurement/catalog/{id}/pricing": { "post": { "tags": [ "CatalogsItem" ], "summary": "Post CatalogPricing", "operationId": "postProcurementCatalogByIdPricing", "parameters": [ { "name": "id", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogPricing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPricing" } } }, "required": true }, "responses": { "200": { "description": "CatalogPricing", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogPricing" } } } } } } }, "/procurement/catalog/{parentId}/components": { "get": { "tags": [ "CatalogComponents" ], "summary": "Get List of CatalogComponent", "operationId": "getProcurementCatalogByParentIdComponents", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CatalogComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogComponent" } } } } } } }, "post": { "tags": [ "CatalogComponents" ], "summary": "Post CatalogComponent", "operationId": "postProcurementCatalogByParentIdComponents", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogComponent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogComponent" } } }, "required": true }, "responses": { "201": { "description": "CatalogComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogComponent" } } } } } } }, "/procurement/catalog/{parentId}/components/{id}": { "get": { "tags": [ "CatalogComponents" ], "summary": "Get CatalogComponent", "operationId": "getProcurementCatalogByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CatalogComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogComponent" } } } } } }, "delete": { "tags": [ "CatalogComponents" ], "summary": "Delete CatalogComponent", "operationId": "deleteProcurementCatalogByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CatalogComponents" ], "summary": "Put CatalogComponent", "operationId": "putProcurementCatalogByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogComponent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogComponent" } } }, "required": true }, "responses": { "200": { "description": "CatalogComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogComponent" } } } } } }, "patch": { "tags": [ "CatalogComponents" ], "summary": "Patch CatalogComponent", "operationId": "patchProcurementCatalogByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CatalogComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogComponent" } } } } } } }, "/procurement/catalog/{parentId}/components/count": { "get": { "tags": [ "CatalogComponents" ], "summary": "Get Count of CatalogComponent", "operationId": "getProcurementCatalogByParentIdComponentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog/{parentId}/inventory": { "get": { "tags": [ "CatalogInventories" ], "summary": "Get List of CatalogInventory", "operationId": "getProcurementCatalogByParentIdInventory", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CatalogInventory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogInventory" } } } } } } } }, "/procurement/catalog/{parentId}/inventory/{id}": { "get": { "tags": [ "CatalogInventories" ], "summary": "Get CatalogInventory", "operationId": "getProcurementCatalogByParentIdInventoryById", "parameters": [ { "name": "id", "in": "path", "description": "inventoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CatalogInventory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogInventory" } } } } } } }, "/procurement/catalog/{parentId}/inventory/count": { "get": { "tags": [ "CatalogInventories" ], "summary": "Get Count of CatalogInventory", "operationId": "getProcurementCatalogByParentIdInventoryCount", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog/{parentId}/minimumStockByWarehouse": { "get": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Get List of MinimumStockByWarehouse", "operationId": "getProcurementCatalogByParentIdMinimumStockByWarehouse", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MinimumStockByWarehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } } } } } }, "post": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Post MinimumStockByWarehouse", "operationId": "postProcurementCatalogByParentIdMinimumStockByWarehouse", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "minimumStockByWarehouse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } }, "required": true }, "responses": { "201": { "description": "MinimumStockByWarehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } } } } } }, "/procurement/catalog/{parentId}/minimumStockByWarehouse/{id}": { "get": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Get MinimumStockByWarehouse", "operationId": "getProcurementCatalogByParentIdMinimumStockByWarehouseById", "parameters": [ { "name": "id", "in": "path", "description": "minimumStockByWarehouseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MinimumStockByWarehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } } } } }, "delete": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Delete MinimumStockByWarehouse", "operationId": "deleteProcurementCatalogByParentIdMinimumStockByWarehouseById", "parameters": [ { "name": "id", "in": "path", "description": "minimumStockByWarehouseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Put MinimumStockByWarehouse", "operationId": "putProcurementCatalogByParentIdMinimumStockByWarehouseById", "parameters": [ { "name": "id", "in": "path", "description": "minimumStockByWarehouseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "minimumStockByWarehouse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } }, "required": true }, "responses": { "200": { "description": "MinimumStockByWarehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } } } } }, "patch": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Patch MinimumStockByWarehouse", "operationId": "patchProcurementCatalogByParentIdMinimumStockByWarehouseById", "parameters": [ { "name": "id", "in": "path", "description": "minimumStockByWarehouseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MinimumStockByWarehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MinimumStockByWarehouse" } } } } } } }, "/procurement/catalog/{parentId}/minimumStockByWarehouse/count": { "get": { "tags": [ "MinimumStockByWarehouses" ], "summary": "Get Count of MinimumStockByWarehouse", "operationId": "getProcurementCatalogByParentIdMinimumStockByWarehouseCount", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog/{parentId}/vendors/{id}": { "delete": { "tags": [ "CatalogsItem" ], "summary": "Delete CatalogItem", "operationId": "deleteProcurementCatalogByParentIdVendorsById", "parameters": [ { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "vendorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CatalogsItem" ], "summary": "Put CatalogItem", "operationId": "putProcurementCatalogByParentIdVendorsById", "parameters": [ { "name": "id", "in": "path", "description": "vendorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItem" } } }, "required": true }, "responses": { "200": { "description": "CatalogVendor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogVendors" } } } } } } }, "/procurement/catalog/{parentId}/vendors/{id}{id}": { "patch": { "tags": [ "BillingCycles" ], "summary": "Patch BillingCycle", "operationId": "patchProcurementCatalogByParentIdVendorsByIdById", "parameters": [ { "name": "id", "in": "path", "description": "vendorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "catalogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BillingCycle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } } } } } }, "/procurement/catalog/count": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get Count of CatalogItem", "operationId": "getProcurementCatalogCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog/info": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get List of CatalogItemInfo", "operationId": "getProcurementCatalogInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CatalogItemInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogItemInfo" } } } } } } } }, "/procurement/catalog/info/count": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get Count of CatalogItemInfo", "operationId": "getProcurementCatalogInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/catalog/vendors": { "post": { "tags": [ "CatalogsItem" ], "summary": "Post CatalogItem", "operationId": "postProcurementCatalogVendors", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "catalogVendors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogVendors" } } }, "required": true }, "responses": { "201": { "description": "CatalogVendors", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CatalogVendors" } } } } } } }, "/procurement/catalog/vendors/{parentId}": { "get": { "tags": [ "CatalogsItem" ], "summary": "Get List of CatalogItem", "operationId": "getProcurementCatalogVendorsByParentId", "parameters": [ { "name": "parentId", "in": "path", "description": "vendorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CatalogVendors", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogVendors" } } } } } } } }, "/procurement/categories": { "get": { "tags": [ "Categories" ], "summary": "Get List of Category", "operationId": "getProcurementCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } }, "post": { "tags": [ "Categories" ], "summary": "Post Category", "operationId": "postProcurementCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "category", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } }, "required": true }, "responses": { "201": { "description": "Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Category" } } } } } } }, "/procurement/categories/{id}": { "get": { "tags": [ "Categories" ], "summary": "Get Category", "operationId": "getProcurementCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Category" } } } } } }, "delete": { "tags": [ "Categories" ], "summary": "Delete Category", "operationId": "deleteProcurementCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Categories" ], "summary": "Put Category", "operationId": "putProcurementCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "category", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } }, "required": true }, "responses": { "200": { "description": "Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Category" } } } } } }, "patch": { "tags": [ "Categories" ], "summary": "Patch Category", "operationId": "patchProcurementCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Category" } } } } } } }, "/procurement/categories/{id}/info": { "get": { "tags": [ "Categories" ], "summary": "Get CategoryInfo", "operationId": "getProcurementCategoriesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CategoryInfo" } } } } } } }, "/procurement/categories/{parentId}/subcategories/": { "get": { "tags": [ "LegacySubCategories" ], "summary": "Get List of LegacySubCategory", "operationId": "getProcurementCategoriesByParentIdSubcategories", "parameters": [ { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LegacySubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacySubCategory" } } } } } } }, "post": { "tags": [ "LegacySubCategories" ], "summary": "Post LegacySubCategory", "operationId": "postProcurementCategoriesByParentIdSubcategories", "parameters": [ { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "subCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacySubCategory" } } }, "required": true }, "responses": { "201": { "description": "LegacySubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LegacySubCategory" } } } } } } }, "/procurement/categories/{parentId}/subcategories/{id}": { "get": { "tags": [ "LegacySubCategories" ], "summary": "Get LegacySubCategory", "operationId": "getProcurementCategoriesByParentIdSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LegacySubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LegacySubCategory" } } } } } }, "delete": { "tags": [ "LegacySubCategories" ], "summary": "Delete LegacySubCategory", "operationId": "deleteProcurementCategoriesByParentIdSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "LegacySubCategories" ], "summary": "Put LegacySubCategory", "operationId": "putProcurementCategoriesByParentIdSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "subCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacySubCategory" } } }, "required": true }, "responses": { "200": { "description": "LegacySubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LegacySubCategory" } } } } } }, "patch": { "tags": [ "LegacySubCategories" ], "summary": "Patch LegacySubCategory", "operationId": "patchProcurementCategoriesByParentIdSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "LegacySubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LegacySubCategory" } } } } } } }, "/procurement/categories/{parentId}/subcategories/{id}/info": { "get": { "tags": [ "LegacySubCategoryInfos" ], "summary": "Get LegacySubCategoryInfos", "operationId": "getProcurementCategoriesByParentIdSubcategoriesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LegacySubCategoryInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LegacySubCategoryInfo" } } } } } } }, "/procurement/categories/{parentId}/subcategories/count": { "get": { "tags": [ "LegacySubCategories" ], "summary": "Get Count of LegacySubCategory", "operationId": "getProcurementCategoriesByParentIdSubcategoriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/categories/{parentId}/subcategories/info": { "get": { "tags": [ "LegacySubCategoryInfos" ], "summary": "Get List of LegacySubCategoryInfos", "operationId": "getProcurementCategoriesByParentIdSubcategoriesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of legacySubCategoryInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacySubCategoryInfo" } } } } } } } }, "/procurement/categories/{parentId}/subcategories/info/count": { "get": { "tags": [ "LegacySubCategoryInfos" ], "summary": "Get Count of LegacySubCategoryInfos", "operationId": "getProcurementCategoriesByParentIdSubcategoriesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "categoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/categories/count": { "get": { "tags": [ "Categories" ], "summary": "Get Count of Category", "operationId": "getProcurementCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/categories/info": { "get": { "tags": [ "Categories" ], "summary": "Get List of CategoryInfo", "operationId": "getProcurementCategoriesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Category", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryInfo" } } } } } } } }, "/procurement/categories/info/count": { "get": { "tags": [ "Categories" ], "summary": "Get Count of CategoryInfo", "operationId": "getProcurementCategoriesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/changeorder": { "get": { "tags": [ "ChangeOrder" ], "summary": "Get List of ChangeOrders", "operationId": "getProcurementChangeorder", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of changeOrders", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeOrder" } } } } } } }, "post": { "tags": [ "ChangeOrder" ], "summary": "Post ChangeOrder", "operationId": "postProcurementChangeorder", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "changeOrder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOrder" } } }, "required": true }, "responses": { "201": { "description": "ChangeOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChangeOrder" } } } } } } }, "/procurement/changeorder/{id}": { "delete": { "tags": [ "ChangeOrder" ], "summary": "Deletes ChangeOrder By Id", "operationId": "deleteProcurementChangeorderById", "parameters": [ { "name": "id", "in": "path", "description": "ChangeOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "ChangeOrder" ], "summary": "Patch ChangeOrder", "operationId": "patchProcurementChangeorderById", "parameters": [ { "name": "id", "in": "path", "description": "ChangeOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ChangeOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChangeOrder" } } } } } } }, "/procurement/changeorders/count": { "get": { "tags": [ "ChangeOrder" ], "summary": "Get Count of changeOrders", "operationId": "getProcurementChangeordersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/directionalSyncs": { "get": { "tags": [ "DirectionalSyncs" ], "summary": "Get List of DirectionalSync", "operationId": "getProcurementDirectionalSyncs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DirectionalSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DirectionalSync" } } } } } } }, "post": { "tags": [ "DirectionalSyncs" ], "summary": "Post DirectionalSync", "operationId": "postProcurementDirectionalSyncs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "directionalSync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalSync" } } }, "required": true }, "responses": { "201": { "description": "DirectionalSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DirectionalSync" } } } } } } }, "/procurement/directionalSyncs/{id}": { "get": { "tags": [ "DirectionalSyncs" ], "summary": "Get DirectionalSync", "operationId": "getProcurementDirectionalSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DirectionalSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DirectionalSync" } } } } } }, "delete": { "tags": [ "DirectionalSyncs" ], "summary": "Delete DirectionalSync", "operationId": "deleteProcurementDirectionalSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "DirectionalSyncs" ], "summary": "Put DirectionalSync", "operationId": "putProcurementDirectionalSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "directionalSync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectionalSync" } } }, "required": true }, "responses": { "200": { "description": "DirectionalSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DirectionalSync" } } } } } }, "patch": { "tags": [ "DirectionalSyncs" ], "summary": "Patch DirectionalSync", "operationId": "patchProcurementDirectionalSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "DirectionalSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DirectionalSync" } } } } } } }, "/procurement/directionalSyncs/count": { "get": { "tags": [ "DirectionalSyncs" ], "summary": "Get Count of DirectionalSync", "operationId": "getProcurementDirectionalSyncsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/invoicegrouping": { "get": { "tags": [ "InvoiceGroupings" ], "summary": "Get List of InvoiceGrouping", "operationId": "getProcurementInvoicegrouping", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InvoiceGrouping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceGrouping" } } } } } } } }, "/procurement/invoicegrouping/{id}": { "get": { "tags": [ "InvoiceGroupings" ], "summary": "Get InvoiceGrouping", "operationId": "getProcurementInvoicegroupingById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceGroupingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvoiceGrouping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceGrouping" } } } } } }, "delete": { "tags": [ "InvoiceGroupings" ], "summary": "Delete InvoiceGrouping", "operationId": "deleteProcurementInvoicegroupingById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceGroupingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "InvoiceGroupings" ], "summary": "Put InvoiceGrouping", "operationId": "putProcurementInvoicegroupingById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceGroupingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoiceGrouping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceGrouping" } } }, "required": true }, "responses": { "200": { "description": "InvoiceGrouping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceGrouping" } } } } } }, "patch": { "tags": [ "InvoiceGroupings" ], "summary": "Patch InvoiceGrouping", "operationId": "patchProcurementInvoicegroupingById", "parameters": [ { "name": "id", "in": "path", "description": "invoiceGroupingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InvoiceGrouping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceGrouping" } } } } } } }, "/procurement/invoicegrouping/{id}/usages": { "get": { "tags": [ "InvoiceGroupings" ], "summary": "Get List of Usage Count", "operationId": "getProcurementInvoicegroupingByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "invoiceGroupingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/invoicegrouping/{id}/usages/list": { "get": { "tags": [ "InvoiceGroupings" ], "summary": "Get List of Usage", "operationId": "getProcurementInvoicegroupingByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "invoiceGroupingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/invoicegrouping/count": { "get": { "tags": [ "InvoiceGroupings" ], "summary": "Get Count of InvoiceGrouping", "operationId": "getProcurementInvoicegroupingCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } }, "post": { "tags": [ "InvoiceGroupings" ], "summary": "Post InvoiceGrouping", "operationId": "postProcurementInvoicegroupingCount", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "invoiceGrouping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceGrouping" } } }, "required": true }, "responses": { "201": { "description": "InvoiceGrouping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InvoiceGrouping" } } } } } } }, "/procurement/manufacturers": { "get": { "tags": [ "Manufacturers" ], "summary": "Get List of Manufacturer", "operationId": "getProcurementManufacturers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Manufacturer", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Manufacturer" } } } } } } }, "post": { "tags": [ "Manufacturers" ], "summary": "Post Manufacturer", "operationId": "postProcurementManufacturers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "manufacturer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Manufacturer" } } }, "required": true }, "responses": { "201": { "description": "Manufacturer", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Manufacturer" } } } } } } }, "/procurement/manufacturers/{id}": { "get": { "tags": [ "Manufacturers" ], "summary": "Get Manufacturer", "operationId": "getProcurementManufacturersById", "parameters": [ { "name": "id", "in": "path", "description": "manufacturerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Manufacturer", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Manufacturer" } } } } } }, "delete": { "tags": [ "Manufacturers" ], "summary": "Delete Manufacturer", "operationId": "deleteProcurementManufacturersById", "parameters": [ { "name": "id", "in": "path", "description": "manufacturerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Manufacturers" ], "summary": "Put Manufacturer", "operationId": "putProcurementManufacturersById", "parameters": [ { "name": "id", "in": "path", "description": "manufacturerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "manufacturer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Manufacturer" } } }, "required": true }, "responses": { "200": { "description": "Manufacturer", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Manufacturer" } } } } } }, "patch": { "tags": [ "Manufacturers" ], "summary": "Patch Manufacturer", "operationId": "patchProcurementManufacturersById", "parameters": [ { "name": "id", "in": "path", "description": "manufacturerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Manufacturer", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Manufacturer" } } } } } } }, "/procurement/manufacturers/{id}/info": { "get": { "tags": [ "ManufacturersInfo" ], "summary": "Get ManufacturerInfo", "operationId": "getProcurementManufacturersByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "manufacturerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManufacturerInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManufacturerInfo" } } } } } } }, "/procurement/manufacturers/count": { "get": { "tags": [ "Manufacturers" ], "summary": "Get Count of Manufacturer", "operationId": "getProcurementManufacturersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/manufacturers/count/info": { "get": { "tags": [ "ManufacturersInfo" ], "summary": "Get Count of ManufacturerInfos", "operationId": "getProcurementManufacturersCountInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/manufacturers/info": { "get": { "tags": [ "ManufacturersInfo" ], "summary": "Get List of ManufacturerInfo", "operationId": "getProcurementManufacturersInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Manufacturer", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManufacturerInfo" } } } } } } } }, "/procurement/onhandserialnumbers": { "get": { "tags": [ "OnHandSerialNumberses" ], "summary": "Get List of OnHandSerialNumber", "operationId": "getProcurementOnhandserialnumbers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OnHandSerialNumber", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnHandSerialNumber" } } } } } } } }, "/procurement/onhandserialnumbers/{id}": { "get": { "tags": [ "OnHandSerialNumberses" ], "summary": "Get OnHandSerialNumber", "operationId": "getProcurementOnhandserialnumbersById", "parameters": [ { "name": "id", "in": "path", "description": "onhandserialnumberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OnHandSerialNumber", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OnHandSerialNumber" } } } } } } }, "/procurement/onhandserialnumbers/count": { "get": { "tags": [ "OnHandSerialNumberses" ], "summary": "Get Count of OnHandSerialNumber", "operationId": "getProcurementOnhandserialnumbersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/pricingschedules": { "get": { "tags": [ "PricingSchedules" ], "summary": "Get List of PricingSchedule", "operationId": "getProcurementPricingschedules", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PricingSchedule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PricingSchedule" } } } } } } }, "post": { "tags": [ "PricingSchedules" ], "summary": "Post PricingSchedule", "operationId": "postProcurementPricingschedules", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "pricingSchedule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingSchedule" } } }, "required": true }, "responses": { "201": { "description": "PricingSchedule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingSchedule" } } } } } } }, "/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks": { "get": { "tags": [ "PricingBreaks" ], "summary": "Get List of PricingBreak", "operationId": "getProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaks", "parameters": [ { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PricingBreak", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PricingBreak" } } } } } } }, "post": { "tags": [ "PricingBreaks" ], "summary": "Post PricingBreak", "operationId": "postProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaks", "parameters": [ { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "pricingBreak", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingBreak" } } }, "required": true }, "responses": { "201": { "description": "PricingBreak", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingBreak" } } } } } } }, "/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/{id}": { "get": { "tags": [ "PricingBreaks" ], "summary": "Get PricingBreak", "operationId": "getProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaksById", "parameters": [ { "name": "id", "in": "path", "description": "breakId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PricingBreak", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingBreak" } } } } } }, "delete": { "tags": [ "PricingBreaks" ], "summary": "Delete PricingBreak", "operationId": "deleteProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaksById", "parameters": [ { "name": "id", "in": "path", "description": "breakId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PricingBreaks" ], "summary": "Put PricingBreak", "operationId": "putProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaksById", "parameters": [ { "name": "id", "in": "path", "description": "breakId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "pricingBreak", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingBreak" } } }, "required": true }, "responses": { "200": { "description": "PricingBreak", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingBreak" } } } } } }, "patch": { "tags": [ "PricingBreaks" ], "summary": "Patch PricingBreak", "operationId": "patchProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaksById", "parameters": [ { "name": "id", "in": "path", "description": "breakId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PricingBreak", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingBreak" } } } } } } }, "/procurement/pricingschedules/{grandparentId}/details/{parentId}/breaks/count": { "get": { "tags": [ "PricingBreaks" ], "summary": "Get Count of PricingBreak", "operationId": "getProcurementPricingschedulesByGrandparentIdDetailsByParentIdBreaksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/pricingschedules/{id}": { "get": { "tags": [ "PricingSchedules" ], "summary": "Get PricingSchedule", "operationId": "getProcurementPricingschedulesById", "parameters": [ { "name": "id", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PricingSchedule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingSchedule" } } } } } }, "delete": { "tags": [ "PricingSchedules" ], "summary": "Delete PricingSchedule", "operationId": "deleteProcurementPricingschedulesById", "parameters": [ { "name": "id", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PricingSchedules" ], "summary": "Put PricingSchedule", "operationId": "putProcurementPricingschedulesById", "parameters": [ { "name": "id", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "pricingSchedule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingSchedule" } } }, "required": true }, "responses": { "200": { "description": "PricingSchedule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingSchedule" } } } } } }, "patch": { "tags": [ "PricingSchedules" ], "summary": "Patch PricingSchedule", "operationId": "patchProcurementPricingschedulesById", "parameters": [ { "name": "id", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PricingSchedule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingSchedule" } } } } } } }, "/procurement/pricingschedules/{parentId}/details": { "get": { "tags": [ "PricingDetails" ], "summary": "Get List of PricingDetail", "operationId": "getProcurementPricingschedulesByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PricingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PricingDetail" } } } } } } }, "post": { "tags": [ "PricingDetails" ], "summary": "Post PricingDetail", "operationId": "postProcurementPricingschedulesByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "pricingDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingDetail" } } }, "required": true }, "responses": { "201": { "description": "PricingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingDetail" } } } } } } }, "/procurement/pricingschedules/{parentId}/details/{id}": { "get": { "tags": [ "PricingDetails" ], "summary": "Get PricingDetail", "operationId": "getProcurementPricingschedulesByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PricingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingDetail" } } } } } }, "delete": { "tags": [ "PricingDetails" ], "summary": "Delete PricingDetail", "operationId": "deleteProcurementPricingschedulesByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PricingDetails" ], "summary": "Put PricingDetail", "operationId": "putProcurementPricingschedulesByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "pricingDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricingDetail" } } }, "required": true }, "responses": { "200": { "description": "PricingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingDetail" } } } } } }, "patch": { "tags": [ "PricingDetails" ], "summary": "Patch PricingDetail", "operationId": "patchProcurementPricingschedulesByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PricingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PricingDetail" } } } } } } }, "/procurement/pricingschedules/{parentId}/details/count": { "get": { "tags": [ "PricingDetails" ], "summary": "Get Count of PricingDetail", "operationId": "getProcurementPricingschedulesByParentIdDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "pricingscheduleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/pricingschedules/count": { "get": { "tags": [ "PricingSchedules" ], "summary": "Get Count of PricingSchedule", "operationId": "getProcurementPricingschedulesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/products": { "get": { "tags": [ "ProductsItem" ], "summary": "Get List of ProductItem", "operationId": "getProcurementProducts", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItem" } } } } } } }, "post": { "tags": [ "ProductsItem" ], "summary": "Post ProductItem", "operationId": "postProcurementProducts", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } }, "required": true }, "responses": { "201": { "description": "ProductItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } } } } }, "/procurement/products/{id}": { "get": { "tags": [ "ProductsItem" ], "summary": "Get ProductItem", "operationId": "getProcurementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProductItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } } } }, "delete": { "tags": [ "ProductsItem" ], "summary": "Delete ProductItem", "operationId": "deleteProcurementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProductsItem" ], "summary": "Put ProductItem", "operationId": "putProcurementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductItem" } } }, "required": true }, "responses": { "200": { "description": "ProductItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } } } }, "patch": { "tags": [ "ProductsItem" ], "summary": "Patch ProductItem", "operationId": "patchProcurementProductsById", "parameters": [ { "name": "id", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProductItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductItem" } } } } } } }, "/procurement/products/{id}/detach": { "post": { "tags": [ "ProductsItem" ], "summary": "Post ProductDetach", "operationId": "postProcurementProductsByIdDetach", "parameters": [ { "name": "id", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "detach", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetach" } } }, "required": true }, "responses": { "204": { "description": "ProductDetach", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductDetach" } } } } } } }, "/procurement/products/{parentId}/components": { "get": { "tags": [ "ProductComponents" ], "summary": "Get List of ProductComponent", "operationId": "getProcurementProductsByParentIdComponents", "parameters": [ { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductComponent" } } } } } } }, "post": { "tags": [ "ProductComponents" ], "summary": "Post List of ProductComponent", "operationId": "postProcurementProductsByParentIdComponents", "parameters": [ { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productComponent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductComponent" } } }, "required": true }, "responses": { "200": { "description": "List of ProductComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductComponent" } } } } } } } }, "/procurement/products/{parentId}/components/{id}": { "get": { "tags": [ "ProductComponents" ], "summary": "Get List of ProductComponent", "operationId": "getProcurementProductsByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductComponent" } } } } } } }, "delete": { "tags": [ "ProductComponents" ], "summary": "Delete ProductComponent", "operationId": "deleteProcurementProductsByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProductComponents" ], "summary": "Put List of ProductComponent", "operationId": "putProcurementProductsByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productComponent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductComponent" } } }, "required": true }, "responses": { "200": { "description": "List of ProductComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductComponent" } } } } } } }, "patch": { "tags": [ "ProductComponents" ], "summary": "Patch List of ProductComponent", "operationId": "patchProcurementProductsByParentIdComponentsById", "parameters": [ { "name": "id", "in": "path", "description": "componentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "List of ProductComponent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductComponent" } } } } } } } }, "/procurement/products/{parentId}/components/count": { "get": { "tags": [ "ProductComponents" ], "summary": "Get Count of ProductComponent", "operationId": "getProcurementProductsByParentIdComponentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/products/{parentId}/pickingShippingDetails": { "get": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Get List of ProductPickingShippingDetail", "operationId": "getProcurementProductsByParentIdPickingShippingDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductPickingShippingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } } } } } }, "post": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Post List of ProductPickingShippingDetail", "operationId": "postProcurementProductsByParentIdPickingShippingDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productPickingShippingDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } }, "required": true }, "responses": { "200": { "description": "List of ProductPickingShippingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } } } } } } }, "/procurement/products/{parentId}/pickingShippingDetails/{id}": { "get": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Get List of ProductPickingShippingDetail", "operationId": "getProcurementProductsByParentIdPickingShippingDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "pickingShippingDetailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductPickingShippingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } } } } } }, "delete": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Delete ProductPickingShippingDetail", "operationId": "deleteProcurementProductsByParentIdPickingShippingDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "pickingShippingDetailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Put List of ProductPickingShippingDetail", "operationId": "putProcurementProductsByParentIdPickingShippingDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "pickingShippingDetailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productPickingShippingDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } }, "required": true }, "responses": { "200": { "description": "List of ProductPickingShippingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } } } } } }, "patch": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Patch List of ProductPickingShippingDetail", "operationId": "patchProcurementProductsByParentIdPickingShippingDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "pickingShippingDetailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "List of ProductPickingShippingDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPickingShippingDetail" } } } } } } } }, "/procurement/products/{parentId}/pickingShippingDetails/count": { "get": { "tags": [ "ProductPickingShippingDetails" ], "summary": "Get Count of ProductPickingShippingDetail", "operationId": "getProcurementProductsByParentIdPickingShippingDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/products/count": { "get": { "tags": [ "ProductsItem" ], "summary": "Get Count of ProductItem", "operationId": "getProcurementProductsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorders": { "get": { "tags": [ "PurchaseOrders" ], "summary": "Get List of PurchaseOrder", "operationId": "getProcurementPurchaseorders", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } } }, "post": { "tags": [ "PurchaseOrders" ], "summary": "Post PurchaseOrder", "operationId": "postProcurementPurchaseorders", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "required": true }, "responses": { "201": { "description": "PurchaseOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } } }, "/procurement/purchaseorders/{id}": { "get": { "tags": [ "PurchaseOrders" ], "summary": "Get PurchaseOrder", "operationId": "getProcurementPurchaseordersById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } }, "delete": { "tags": [ "PurchaseOrders" ], "summary": "Delete PurchaseOrder", "operationId": "deleteProcurementPurchaseordersById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PurchaseOrders" ], "summary": "Put PurchaseOrder", "operationId": "putProcurementPurchaseordersById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrder", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } }, "patch": { "tags": [ "PurchaseOrders" ], "summary": "Patch PurchaseOrder", "operationId": "patchProcurementPurchaseordersById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } } }, "/procurement/purchaseorders/{id}/copy": { "post": { "tags": [ "PurchaseOrders" ], "summary": "Post PurchaseOrderCopy", "operationId": "postProcurementPurchaseordersByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } } }, "/procurement/purchaseorders/{id}/info": { "get": { "tags": [ "PurchaseOrdersInfo" ], "summary": "Get PurchaseOrderInfo", "operationId": "getProcurementPurchaseordersByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "purchaseOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderInfo" } } } } } } }, "/procurement/purchaseorders/{id}/quickAccess/count": { "get": { "tags": [ "PurchaseOrders" ], "summary": "Get Count of PurchaseOrder Quick Access Links", "operationId": "getProcurementPurchaseordersByIdQuickAccessCount", "parameters": [ { "name": "id", "in": "path", "description": "purchaseOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count of PurchaseOrder Quick Access Links", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HttpResponseMessage" } } } } } } }, "/procurement/purchaseorders/{id}/rebatch": { "post": { "tags": [ "PurchaseOrders" ], "summary": "Post RebatchPurchaseOrder", "operationId": "postProcurementPurchaseordersByIdRebatch", "parameters": [ { "name": "id", "in": "path", "description": "purchaseOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/procurement/purchaseorders/{id}/unbatch": { "post": { "tags": [ "PurchaseOrders" ], "summary": "Post UnbatchPurchaseOrder", "operationId": "postProcurementPurchaseordersByIdUnbatch", "parameters": [ { "name": "id", "in": "path", "description": "purchaseOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/procurement/purchaseorders/{parentId}/lineitems": { "get": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Get List of PurchaseOrderLineItem", "operationId": "getProcurementPurchaseordersByParentIdLineitems", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrderLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } } } } }, "post": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Post PurchaseOrderLineItem", "operationId": "postProcurementPurchaseordersByParentIdLineitems", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderLineItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } }, "required": true }, "responses": { "201": { "description": "PurchaseOrderLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } } } }, "delete": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Delete PurchaseOrderLineItem", "operationId": "deleteProcurementPurchaseordersByParentIdLineitems", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "lineitemId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" } } } }, "/procurement/purchaseorders/{parentId}/lineitems/{id}": { "get": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Get PurchaseOrderLineItem", "operationId": "getProcurementPurchaseordersByParentIdLineitemsById", "parameters": [ { "name": "id", "in": "path", "description": "lineitemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } } } }, "put": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Put PurchaseOrderLineItem", "operationId": "putProcurementPurchaseordersByParentIdLineitemsById", "parameters": [ { "name": "id", "in": "path", "description": "lineitemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderLineItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } } } }, "patch": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Patch PurchaseOrderLineItem", "operationId": "patchProcurementPurchaseordersByParentIdLineitemsById", "parameters": [ { "name": "id", "in": "path", "description": "lineitemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } } } } }, "/procurement/purchaseorders/{parentId}/lineitems/bulk": { "post": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Post BulkResult", "operationId": "postProcurementPurchaseordersByParentIdLineitemsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PurchaseOrderLineItem", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } }, "delete": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Delete BulkResult", "operationId": "deleteProcurementPurchaseordersByParentIdLineitemsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderLineItems", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdCollection" } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } }, "put": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Put BulkResult", "operationId": "putProcurementPurchaseordersByParentIdLineitemsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PurchaseOrderLineItem", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineItem" } } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } } }, "/procurement/purchaseorders/{parentId}/lineitems/count": { "get": { "tags": [ "PurchaseOrderLineItems" ], "summary": "Get Count of PurchaseOrderLineItem", "operationId": "getProcurementPurchaseordersByParentIdLineitemsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorders/{parentId}/notes": { "get": { "tags": [ "PurchaseOrders" ], "summary": "Get List of PurchaseOrder", "operationId": "getProcurementPurchaseordersByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrder Notes", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderNote" } } } } } } }, "post": { "tags": [ "PurchaseOrdersNote" ], "summary": "Post PurchaseOrderNote", "operationId": "postProcurementPurchaseordersByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "PurchaseOrderNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderNote" } } }, "required": true }, "responses": { "201": { "description": "PurchaseOrderNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderNote" } } } } } } }, "/procurement/purchaseorders/{parentId}/notes/{id}": { "get": { "tags": [ "PurchaseOrdersNote" ], "summary": "Get PurchaseOrderNote", "operationId": "getProcurementPurchaseordersByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderNote" } } } } } }, "delete": { "tags": [ "PurchaseOrdersNote" ], "summary": "Delete PurchaseOrderNote", "operationId": "deleteProcurementPurchaseordersByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PurchaseOrdersNote" ], "summary": "Put PurchaseOrderNote", "operationId": "putProcurementPurchaseordersByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "PurchaseOrderNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderNote" } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderNote" } } } } } }, "patch": { "tags": [ "PurchaseOrdersNote" ], "summary": "Patch PurchaseOrderNote", "operationId": "patchProcurementPurchaseordersByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderNote" } } } } } } }, "/procurement/purchaseorders/{parentId}/notes/count": { "get": { "tags": [ "PurchaseOrdersNote" ], "summary": "Get Count of PurchaseOrdersNote", "operationId": "getProcurementPurchaseordersByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "PurchaseHeaderRecID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorders/count": { "get": { "tags": [ "PurchaseOrders" ], "summary": "Get Count of PurchaseOrder", "operationId": "getProcurementPurchaseordersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorders/info": { "get": { "tags": [ "PurchaseOrdersInfo" ], "summary": "Get List of PurchaseOrderInfo", "operationId": "getProcurementPurchaseordersInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrderInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderInfo" } } } } } } } }, "/procurement/purchaseorders/info/count": { "get": { "tags": [ "PurchaseOrdersInfo" ], "summary": "Get Count of PurchaseOrderInfo", "operationId": "getProcurementPurchaseordersInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorderstatuses": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get List of PurchaseOrderStatus", "operationId": "getProcurementPurchaseorderstatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } } } } } }, "post": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Post PurchaseOrderStatus", "operationId": "postProcurementPurchaseorderstatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "poStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } }, "required": true }, "responses": { "201": { "description": "PurchaseOrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } } } } } }, "/procurement/purchaseorderstatuses/{id}": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get PurchaseOrderStatus", "operationId": "getProcurementPurchaseorderstatusesById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } } } } }, "delete": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Delete PurchaseOrderStatus", "operationId": "deleteProcurementPurchaseorderstatusesById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Patch PurchaseOrderStatus", "operationId": "patchProcurementPurchaseorderstatusesById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } } } } }, "put": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Put PurchaseOrderStatus", "operationId": "putProcurementPurchaseorderstatusesById", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } } } } } }, "/procurement/purchaseorderstatuses/{id}/info": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get PurchaseOrderStatusInfo", "operationId": "getProcurementPurchaseorderstatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusInfo" } } } } } } }, "/procurement/purchaseorderstatuses/{id}/usages": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get List of Usage Count", "operationId": "getProcurementPurchaseorderstatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/purchaseorderstatuses/{id}/usages/list": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get List of Usage", "operationId": "getProcurementPurchaseorderstatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/purchaseorderstatuses/{parentId}/emailtemplates/": { "get": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Get List of PurchaseOrderStatusEmailTemplate", "operationId": "getProcurementPurchaseorderstatusesByParentIdEmailtemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } } } } } }, "post": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Post PurchaseOrderStatusEmailTemplate", "operationId": "postProcurementPurchaseorderstatusesByParentIdEmailtemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderStatusEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } }, "required": true }, "responses": { "201": { "description": "PurchaseOrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } } } } } }, "/procurement/purchaseorderstatuses/{parentId}/emailtemplates/{id}": { "get": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Get PurchaseOrderStatusEmailTemplate", "operationId": "getProcurementPurchaseorderstatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } } } } }, "delete": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Delete PurchaseOrderStatusEmailTemplate", "operationId": "deleteProcurementPurchaseorderstatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Put PurchaseOrderStatusEmailTemplate", "operationId": "putProcurementPurchaseorderstatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderStatusEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } } } } }, "patch": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Patch PurchaseOrderStatusEmailTemplate", "operationId": "patchProcurementPurchaseorderstatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplate" } } } } } } }, "/procurement/purchaseorderstatuses/{parentId}/emailtemplates/count": { "get": { "tags": [ "PurchaseOrderStatusEmailTemplates" ], "summary": "Get Count of PurchaseOrderStatusEmailTemplate", "operationId": "getProcurementPurchaseorderstatusesByParentIdEmailtemplatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorderstatuses/{parentId}/notifications": { "get": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Get List of PurchaseOrderStatusNotification", "operationId": "getProcurementPurchaseorderstatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } } } } } }, "post": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Post PurchaseOrderStatusNotification", "operationId": "postProcurementPurchaseorderstatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } }, "required": true }, "responses": { "201": { "description": "PurchaseOrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } } } } } }, "/procurement/purchaseorderstatuses/{parentId}/notifications/{id}": { "get": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Get PurchaseOrderStatusNotification", "operationId": "getProcurementPurchaseorderstatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PurchaseOrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } } } } }, "delete": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Delete PurchaseOrderStatusNotification", "operationId": "deleteProcurementPurchaseorderstatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Put PurchaseOrderStatusNotification", "operationId": "putProcurementPurchaseorderstatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchaseOrderStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } } } } }, "patch": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Patch PurchaseOrderStatusNotification", "operationId": "patchProcurementPurchaseorderstatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PurchaseOrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchaseOrderStatusNotification" } } } } } } }, "/procurement/purchaseorderstatuses/{parentId}/notifications/count": { "get": { "tags": [ "PurchaseOrderStatusNotifications" ], "summary": "Get Count of PurchaseOrderStatusNotification", "operationId": "getProcurementPurchaseorderstatusesByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "purchaseorderstatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorderstatuses/count": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get Count of PurchaseOrderStatus", "operationId": "getProcurementPurchaseorderstatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchaseorderstatuses/info": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get List of PurchaseOrderStatusInfo", "operationId": "getProcurementPurchaseorderstatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PurchaseOrderStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderStatusInfo" } } } } } } } }, "/procurement/purchaseorderstatuses/Info/count": { "get": { "tags": [ "PurchaseOrderStatuses" ], "summary": "Get Count of PurchaseOrderStatusInfo", "operationId": "getProcurementPurchaseorderstatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/purchasingDemands": { "post": { "tags": [ "PurchasingDemands" ], "summary": "Post PurchasingDemand", "operationId": "postProcurementPurchasingDemands", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "purchasingDemand", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchasingDemand" } } }, "required": true }, "responses": { "201": { "description": "PurchasingDemand", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PurchasingDemand" } } } } } } }, "/procurement/rmaActions": { "get": { "tags": [ "RMAActions" ], "summary": "Get List of RmaAction", "operationId": "getProcurementRmaActions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of RmaAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaAction" } } } } } } }, "post": { "tags": [ "RMAActions" ], "summary": "Post RmaAction", "operationId": "postProcurementRmaActions", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaAction" } } }, "required": true }, "responses": { "201": { "description": "RmaAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaAction" } } } } } } }, "/procurement/rmaActions/{id}": { "get": { "tags": [ "RMAActions" ], "summary": "Get RmaAction", "operationId": "getProcurementRmaActionsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaAction" } } } } } }, "delete": { "tags": [ "RMAActions" ], "summary": "Delete RmaAction", "operationId": "deleteProcurementRmaActionsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "RMAActions" ], "summary": "Put RmaAction", "operationId": "putProcurementRmaActionsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaAction" } } }, "required": true }, "responses": { "200": { "description": "RmaAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaAction" } } } } } }, "patch": { "tags": [ "RMAActions" ], "summary": "Patch RmaAction", "operationId": "patchProcurementRmaActionsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "RmaAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaAction" } } } } } } }, "/procurement/rmaActions/{id}/info": { "get": { "tags": [ "RmaActionInfos" ], "summary": "Get RmaActionInfos", "operationId": "getProcurementRmaActionsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "RmaActionInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaActionInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaActionInfo" } } } } } } }, "/procurement/rmaActions/count": { "get": { "tags": [ "RMAActions" ], "summary": "Get Count of RmaAction", "operationId": "getProcurementRmaActionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaActions/info": { "get": { "tags": [ "RmaActionInfos" ], "summary": "Get List of RmaActionInfos", "operationId": "getProcurementRmaActionsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of rmaActionInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaActionInfo" } } } } } } } }, "/procurement/rmaActions/info/count": { "get": { "tags": [ "RmaActionInfos" ], "summary": "Get Count of RmaActionInfos", "operationId": "getProcurementRmaActionsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/RMADispositions": { "get": { "tags": [ "RMADispositions" ], "summary": "Get List of RmaDisposition", "operationId": "getProcurementRMADispositions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of RmaDisposition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaDisposition" } } } } } } }, "post": { "tags": [ "RMADispositions" ], "summary": "Post RmaDisposition", "operationId": "postProcurementRMADispositions", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaDisposition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaDisposition" } } }, "required": true }, "responses": { "201": { "description": "RmaDisposition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaDisposition" } } } } } } }, "/procurement/RMADispositions/{id}": { "get": { "tags": [ "RMADispositions" ], "summary": "Get RmaDisposition", "operationId": "getProcurementRMADispositionsById", "parameters": [ { "name": "id", "in": "path", "description": "RMADispositionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaDisposition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaDisposition" } } } } } }, "delete": { "tags": [ "RMADispositions" ], "summary": "Delete RmaDisposition", "operationId": "deleteProcurementRMADispositionsById", "parameters": [ { "name": "id", "in": "path", "description": "RMADispositionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "RMADispositions" ], "summary": "Put RmaDisposition", "operationId": "putProcurementRMADispositionsById", "parameters": [ { "name": "id", "in": "path", "description": "RMADispositionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaDisposition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaDisposition" } } }, "required": true }, "responses": { "200": { "description": "RmaDisposition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaDisposition" } } } } } }, "patch": { "tags": [ "RMADispositions" ], "summary": "Patch RmaDisposition", "operationId": "patchProcurementRMADispositionsById", "parameters": [ { "name": "id", "in": "path", "description": "RMADispositionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "RmaDisposition", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaDisposition" } } } } } } }, "/procurement/RMADispositions/{id}/info": { "get": { "tags": [ "RmaDispositionInfos" ], "summary": "Get RmaDispositionInfos", "operationId": "getProcurementRMADispositionsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "RmaDispositionInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaDispositionInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaDispositionInfo" } } } } } } }, "/procurement/RMADispositions/count": { "get": { "tags": [ "RMADispositions" ], "summary": "Get Count of RmaDisposition", "operationId": "getProcurementRMADispositionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/RMADispositions/info": { "get": { "tags": [ "RmaDispositionInfos" ], "summary": "Get List of RmaDispositionInfos", "operationId": "getProcurementRMADispositionsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of rmaDispositionInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaDispositionInfo" } } } } } } } }, "/procurement/RMADispositions/info/count": { "get": { "tags": [ "RmaDispositionInfos" ], "summary": "Get Count of RmaDispositionInfos", "operationId": "getProcurementRMADispositionsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaStatuses": { "get": { "tags": [ "RmaStatuses" ], "summary": "Get List of RmaStatus", "operationId": "getProcurementRmaStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of RmaStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaStatus" } } } } } } }, "post": { "tags": [ "RmaStatuses" ], "summary": "Post RmaStatus", "operationId": "postProcurementRmaStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaStatus" } } }, "required": true }, "responses": { "201": { "description": "RmaStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatus" } } } } } } }, "/procurement/rmaStatuses/{id}": { "get": { "tags": [ "RmaStatuses" ], "summary": "Get RmaStatus", "operationId": "getProcurementRmaStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatus" } } } } } }, "delete": { "tags": [ "RmaStatuses" ], "summary": "Delete RmaStatus", "operationId": "deleteProcurementRmaStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "RmaStatuses" ], "summary": "Put RmaStatus", "operationId": "putProcurementRmaStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaStatus" } } }, "required": true }, "responses": { "200": { "description": "RmaStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatus" } } } } } }, "patch": { "tags": [ "RmaStatuses" ], "summary": "Patch RmaStatus", "operationId": "patchProcurementRmaStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "RmaStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatus" } } } } } } }, "/procurement/rmaStatuses/{id}/info": { "get": { "tags": [ "RmaStatusInfos" ], "summary": "Get RmaStatusInfos", "operationId": "getProcurementRmaStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "RmaStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusInfo" } } } } } } }, "/procurement/rmaStatuses/{id}/usages": { "get": { "tags": [ "RmaStatuses" ], "summary": "Get List of Usage Count", "operationId": "getProcurementRmaStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/rmaStatuses/{id}/usages/list": { "get": { "tags": [ "RmaStatuses" ], "summary": "Get List of Usage", "operationId": "getProcurementRmaStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/rmaStatuses/{parentId}/emailtemplates/": { "post": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Post RmaStatusEmailTemplate", "operationId": "postProcurementRmaStatusesByParentIdEmailtemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaStatusEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } }, "required": true }, "responses": { "201": { "description": "RmaStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } } } } } }, "/procurement/rmaStatuses/{parentId}/emailTemplates/": { "get": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Get List of RmaStatusEmailTemplate", "operationId": "getProcurementRmaStatusesByParentIdEmailTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of RmaStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } } } } } } }, "/procurement/rmaStatuses/{parentId}/emailtemplates/{id}": { "get": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Get RmaStatusEmailTemplate", "operationId": "getProcurementRmaStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } } } } }, "delete": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Delete RmaStatusEmailTemplate", "operationId": "deleteProcurementRmaStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Put RmaStatusEmailTemplate", "operationId": "putProcurementRmaStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaStatusEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } }, "required": true }, "responses": { "200": { "description": "RmaStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } } } } }, "patch": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Patch RmaStatusEmailTemplate", "operationId": "patchProcurementRmaStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "RmaStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusEmailTemplate" } } } } } } }, "/procurement/rmaStatuses/{parentId}/emailtemplates/count": { "get": { "tags": [ "RmaStatusEmailTemplates" ], "summary": "Get Count of RmaStatusEmailTemplate", "operationId": "getProcurementRmaStatusesByParentIdEmailtemplatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaStatuses/{parentId}/notifications": { "get": { "tags": [ "RmaStatusNotifications" ], "summary": "Get List of RmaStatusNotification", "operationId": "getProcurementRmaStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of RmaStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaStatusNotification" } } } } } } }, "post": { "tags": [ "RmaStatusNotifications" ], "summary": "Post RmaStatusNotification", "operationId": "postProcurementRmaStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaStatusNotification" } } }, "required": true }, "responses": { "201": { "description": "RmaStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusNotification" } } } } } } }, "/procurement/rmaStatuses/{parentId}/notifications/{id}": { "get": { "tags": [ "RmaStatusNotifications" ], "summary": "Get RmaStatusNotification", "operationId": "getProcurementRmaStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusNotification" } } } } } }, "delete": { "tags": [ "RmaStatusNotifications" ], "summary": "Delete RmaStatusNotification", "operationId": "deleteProcurementRmaStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "RmaStatusNotifications" ], "summary": "Put RmaStatusNotification", "operationId": "putProcurementRmaStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaStatusNotification" } } }, "required": true }, "responses": { "200": { "description": "RmaStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusNotification" } } } } } }, "patch": { "tags": [ "RmaStatusNotifications" ], "summary": "Patch RmaStatusNotification", "operationId": "patchProcurementRmaStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "RmaStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaStatusNotification" } } } } } } }, "/procurement/rmaStatuses/{parentId}/notifications/count": { "get": { "tags": [ "RmaStatusNotifications" ], "summary": "Get Count of RmaStatusNotification", "operationId": "getProcurementRmaStatusesByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "rmaStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaStatuses/count": { "get": { "tags": [ "RmaStatuses" ], "summary": "Get Count of RmaStatus", "operationId": "getProcurementRmaStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaStatuses/info": { "get": { "tags": [ "RmaStatusInfos" ], "summary": "Get List of RmaStatusInfos", "operationId": "getProcurementRmaStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of rmaStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaStatusInfo" } } } } } } } }, "/procurement/rmaStatuses/info/count": { "get": { "tags": [ "RmaStatusInfos" ], "summary": "Get Count of RmaStatusInfos", "operationId": "getProcurementRmaStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaTags": { "get": { "tags": [ "RmaTags" ], "summary": "Get List of RmaTag", "operationId": "getProcurementRmaTags", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of RmaTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RmaTag" } } } } } } }, "post": { "tags": [ "RmaTags" ], "summary": "Post RmaTag", "operationId": "postProcurementRmaTags", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaTag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaTag" } } }, "required": true }, "responses": { "201": { "description": "RmaTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaTag" } } } } } } }, "/procurement/rmaTags/{id}": { "get": { "tags": [ "RmaTags" ], "summary": "Get RmaTag", "operationId": "getProcurementRmaTagsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "RmaTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaTag" } } } } } }, "delete": { "tags": [ "RmaTags" ], "summary": "Delete RmaTag", "operationId": "deleteProcurementRmaTagsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "RmaTags" ], "summary": "Put RmaTag", "operationId": "putProcurementRmaTagsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "rmaTag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RmaTag" } } }, "required": true }, "responses": { "200": { "description": "RmaTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaTag" } } } } } }, "patch": { "tags": [ "RmaTags" ], "summary": "Patch RmaTag", "operationId": "patchProcurementRmaTagsById", "parameters": [ { "name": "id", "in": "path", "description": "rmaTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "RmaTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaTag" } } } } } } }, "/procurement/rmaTags/count": { "get": { "tags": [ "RmaTags" ], "summary": "Get Count of RmaTag", "operationId": "getProcurementRmaTagsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/rmaTags/default": { "get": { "tags": [ "RmaTags" ], "summary": "Get RmaTag", "operationId": "getProcurementRmaTagsDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "description": "productId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "billingLogId", "in": "path", "description": "billingLogId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ticketId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "salesOrderId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "companyId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "RmaTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/RmaTag" } } } } } } }, "/procurement/settings": { "get": { "tags": [ "ProcurementSettings" ], "summary": "Get List of ProcurementSetting", "operationId": "getProcurementSettings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProcurementSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProcurementSetting" } } } } } } } }, "/procurement/settings/{id}": { "get": { "tags": [ "ProcurementSettings" ], "summary": "Get ProcurementSetting", "operationId": "getProcurementSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProcurementSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementSetting" } } } } } }, "put": { "tags": [ "ProcurementSettings" ], "summary": "Put ProcurementSetting", "operationId": "putProcurementSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "procurementSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcurementSetting" } } }, "required": true }, "responses": { "200": { "description": "ProcurementSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementSetting" } } } } } }, "patch": { "tags": [ "ProcurementSettings" ], "summary": "Patch ProcurementSetting", "operationId": "patchProcurementSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProcurementSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProcurementSetting" } } } } } } }, "/procurement/settings/count": { "get": { "tags": [ "ProcurementSettings" ], "summary": "Get Count of ProcurementSetting", "operationId": "getProcurementSettingsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/shipmentmethods": { "get": { "tags": [ "ShipmentMethods" ], "summary": "Get List of ShipmentMethod", "operationId": "getProcurementShipmentmethods", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ShipmentMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentMethod" } } } } } } }, "post": { "tags": [ "ShipmentMethods" ], "summary": "Post ShipmentMethod", "operationId": "postProcurementShipmentmethods", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "shipmentMethod", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentMethod" } } }, "required": true }, "responses": { "201": { "description": "ShipmentMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ShipmentMethod" } } } } } } }, "/procurement/shipmentmethods/{id}": { "get": { "tags": [ "ShipmentMethods" ], "summary": "Get ShipmentMethod", "operationId": "getProcurementShipmentmethodsById", "parameters": [ { "name": "id", "in": "path", "description": "shipmentmethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ShipmentMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ShipmentMethod" } } } } } }, "delete": { "tags": [ "ShipmentMethods" ], "summary": "Delete ShipmentMethod", "operationId": "deleteProcurementShipmentmethodsById", "parameters": [ { "name": "id", "in": "path", "description": "shipmentmethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ShipmentMethods" ], "summary": "Put ShipmentMethod", "operationId": "putProcurementShipmentmethodsById", "parameters": [ { "name": "id", "in": "path", "description": "shipmentmethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "shipmentMethod", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentMethod" } } }, "required": true }, "responses": { "200": { "description": "ShipmentMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ShipmentMethod" } } } } } }, "patch": { "tags": [ "ShipmentMethods" ], "summary": "Patch ShipmentMethod", "operationId": "patchProcurementShipmentmethodsById", "parameters": [ { "name": "id", "in": "path", "description": "shipmentmethodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ShipmentMethod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ShipmentMethod" } } } } } } }, "/procurement/shipmentmethods/{id}/info": { "get": { "tags": [ "ShipmentMethodInfos" ], "summary": "Get ShipmentMethodInfos", "operationId": "getProcurementShipmentmethodsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ShipmentMethodInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ShipmentMethodInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ShipmentMethodInfo" } } } } } } }, "/procurement/shipmentmethods/{id}/usages": { "get": { "tags": [ "ShipmentMethods" ], "summary": "Get List of Usage", "operationId": "getProcurementShipmentmethodsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/shipmentmethods/{id}/usages/list": { "get": { "tags": [ "ShipmentMethods" ], "summary": "Get List of Usage", "operationId": "getProcurementShipmentmethodsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "shipmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/shipmentmethods/count": { "get": { "tags": [ "ShipmentMethods" ], "summary": "Get Count of ShipmentMethod", "operationId": "getProcurementShipmentmethodsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/shipmentmethods/info": { "get": { "tags": [ "ShipmentMethodInfos" ], "summary": "Get List of ShipmentMethodInfos", "operationId": "getProcurementShipmentmethodsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of shipmentMethodInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentMethodInfo" } } } } } } } }, "/procurement/shipmentmethods/info/count": { "get": { "tags": [ "ShipmentMethodInfos" ], "summary": "Get Count of ShipmentMethodInfos", "operationId": "getProcurementShipmentmethodsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/subcategories/": { "get": { "tags": [ "SubCategories" ], "summary": "Get List of SubCategory", "operationId": "getProcurementSubcategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubCategory" } } } } } } }, "post": { "tags": [ "SubCategories" ], "summary": "Post SubCategory", "operationId": "postProcurementSubcategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "subCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubCategory" } } }, "required": true }, "responses": { "201": { "description": "SubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SubCategory" } } } } } } }, "/procurement/subcategories/{id}": { "get": { "tags": [ "SubCategories" ], "summary": "Get SubCategory", "operationId": "getProcurementSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SubCategory" } } } } } }, "delete": { "tags": [ "SubCategories" ], "summary": "Delete SubCategory", "operationId": "deleteProcurementSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SubCategories" ], "summary": "Put SubCategory", "operationId": "putProcurementSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "subCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubCategory" } } }, "required": true }, "responses": { "200": { "description": "SubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SubCategory" } } } } } }, "patch": { "tags": [ "SubCategories" ], "summary": "Patch SubCategory", "operationId": "patchProcurementSubcategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SubCategory" } } } } } } }, "/procurement/subcategories/{id}/info": { "get": { "tags": [ "SubCategories" ], "summary": "Get SubCategoryInfo", "operationId": "getProcurementSubcategoriesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SubCategoryInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SubCategoryInfo" } } } } } } }, "/procurement/subcategories/{id}/usages": { "get": { "tags": [ "SubCategories" ], "summary": "Get List of Usage", "operationId": "getProcurementSubcategoriesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/subcategories/{id}/usages/list": { "get": { "tags": [ "SubCategories" ], "summary": "Get List of Usage", "operationId": "getProcurementSubcategoriesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "subcategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/subcategories/count": { "get": { "tags": [ "SubCategories" ], "summary": "Get Count of SubCategory", "operationId": "getProcurementSubcategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/subcategories/info/": { "get": { "tags": [ "SubCategories" ], "summary": "Get List of SubCategoryInfo", "operationId": "getProcurementSubcategoriesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SubCategoryInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubCategoryInfo" } } } } } } } }, "/procurement/subcategories/info/count": { "get": { "tags": [ "SubCategories" ], "summary": "Get Count of SubCategoryInfo", "operationId": "getProcurementSubcategoriesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/types": { "get": { "tags": [ "ProductTypes" ], "summary": "Get List of ProductType", "operationId": "getProcurementTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductType" } } } } } } }, "post": { "tags": [ "ProductTypes" ], "summary": "Post ProductType", "operationId": "postProcurementTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productTypes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } }, "required": true }, "responses": { "201": { "description": "ProductType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductType" } } } } } } }, "/procurement/types/{id}": { "get": { "tags": [ "ProductTypes" ], "summary": "Get ProductType", "operationId": "getProcurementTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProductType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductType" } } } } } }, "delete": { "tags": [ "ProductTypes" ], "summary": "Delete ProductType", "operationId": "deleteProcurementTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProductTypes" ], "summary": "Put ProductType", "operationId": "putProcurementTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "productTypes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } }, "required": true }, "responses": { "200": { "description": "ProductType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductType" } } } } } }, "patch": { "tags": [ "ProductTypes" ], "summary": "Patch ProductType", "operationId": "patchProcurementTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProductType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductType" } } } } } } }, "/procurement/types/{id}/info": { "get": { "tags": [ "ProductTypes" ], "summary": "Get ProductTypeInfo", "operationId": "getProcurementTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProductTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProductTypeInfo" } } } } } } }, "/procurement/types/{id}/usages": { "get": { "tags": [ "ProductTypes" ], "summary": "Get List of Usage Count", "operationId": "getProcurementTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/types/{id}/usages/list": { "get": { "tags": [ "ProductTypes" ], "summary": "Get List of Usage", "operationId": "getProcurementTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/procurement/types/count": { "get": { "tags": [ "ProductTypes" ], "summary": "Get Count of ProductType", "operationId": "getProcurementTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/types/info": { "get": { "tags": [ "ProductTypes" ], "summary": "Get List of ProductTypeInfo", "operationId": "getProcurementTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeInfo" } } } } } } } }, "/procurement/types/info/count": { "get": { "tags": [ "ProductTypes" ], "summary": "Get Count of ProductTypeInfo", "operationId": "getProcurementTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/unitOfMeasures": { "get": { "tags": [ "UnitOfMeasures" ], "summary": "Get List of UnitOfMeasure", "operationId": "getProcurementUnitOfMeasures", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UnitOfMeasure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasure" } } } } } } }, "post": { "tags": [ "UnitOfMeasures" ], "summary": "Post UnitOfMeasure", "operationId": "postProcurementUnitOfMeasures", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "unitOfMeasure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } }, "required": true }, "responses": { "201": { "description": "UnitOfMeasure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } } } } }, "/procurement/unitOfMeasures/{id}": { "get": { "tags": [ "UnitOfMeasures" ], "summary": "Get UnitOfMeasure", "operationId": "getProcurementUnitOfMeasuresById", "parameters": [ { "name": "id", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UnitOfMeasure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } } } }, "delete": { "tags": [ "UnitOfMeasures" ], "summary": "Delete UnitOfMeasure", "operationId": "deleteProcurementUnitOfMeasuresById", "parameters": [ { "name": "id", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "UnitOfMeasures" ], "summary": "Put UnitOfMeasure", "operationId": "putProcurementUnitOfMeasuresById", "parameters": [ { "name": "id", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "unitOfMeasure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } }, "required": true }, "responses": { "200": { "description": "UnitOfMeasure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } } } }, "patch": { "tags": [ "UnitOfMeasures" ], "summary": "Patch UnitOfMeasure", "operationId": "patchProcurementUnitOfMeasuresById", "parameters": [ { "name": "id", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "UnitOfMeasure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UnitOfMeasure" } } } } } } }, "/procurement/unitOfMeasures/{parentId}/conversions": { "get": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Get List of Conversion", "operationId": "getProcurementUnitOfMeasuresByParentIdConversions", "parameters": [ { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Conversion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Conversion" } } } } } } }, "post": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Post Conversion", "operationId": "postProcurementUnitOfMeasuresByParentIdConversions", "parameters": [ { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" } } }, "required": true }, "responses": { "201": { "description": "Conversion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Conversion" } } } } } } }, "/procurement/unitOfMeasures/{parentId}/conversions/{id}": { "get": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Get Conversion", "operationId": "getProcurementUnitOfMeasuresByParentIdConversionsById", "parameters": [ { "name": "id", "in": "path", "description": "conversionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Conversion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Conversion" } } } } } }, "delete": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Delete Conversion", "operationId": "deleteProcurementUnitOfMeasuresByParentIdConversionsById", "parameters": [ { "name": "id", "in": "path", "description": "conversionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Put Conversion", "operationId": "putProcurementUnitOfMeasuresByParentIdConversionsById", "parameters": [ { "name": "id", "in": "path", "description": "conversionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversion" } } }, "required": true }, "responses": { "200": { "description": "Conversion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Conversion" } } } } } }, "patch": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Patch Conversion", "operationId": "patchProcurementUnitOfMeasuresByParentIdConversionsById", "parameters": [ { "name": "id", "in": "path", "description": "conversionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Conversion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Conversion" } } } } } } }, "/procurement/unitOfMeasures/{parentId}/conversions/count": { "get": { "tags": [ "UnitOfMeasureConversions" ], "summary": "Get Count of Conversion", "operationId": "getProcurementUnitOfMeasuresByParentIdConversionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "unitOfMeasureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/unitOfMeasures/count": { "get": { "tags": [ "UnitOfMeasures" ], "summary": "Get Count of UnitOfMeasure", "operationId": "getProcurementUnitOfMeasuresCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/warehouseBins": { "get": { "tags": [ "WarehouseBins" ], "summary": "Get List of WarehouseBin", "operationId": "getProcurementWarehouseBins", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WarehouseBin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseBin" } } } } } } }, "post": { "tags": [ "WarehouseBins" ], "summary": "Post WarehouseBin", "operationId": "postProcurementWarehouseBins", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "warehouseBin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseBin" } } }, "required": true }, "responses": { "201": { "description": "WarehouseBin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WarehouseBin" } } } } } } }, "/procurement/warehouseBins/{id}": { "get": { "tags": [ "WarehouseBins" ], "summary": "Get WarehouseBin", "operationId": "getProcurementWarehouseBinsById", "parameters": [ { "name": "id", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WarehouseBin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WarehouseBin" } } } } } }, "delete": { "tags": [ "WarehouseBins" ], "summary": "Delete WarehouseBin", "operationId": "deleteProcurementWarehouseBinsById", "parameters": [ { "name": "id", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WarehouseBins" ], "summary": "Put WarehouseBin", "operationId": "putProcurementWarehouseBinsById", "parameters": [ { "name": "id", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "warehouseBin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseBin" } } }, "required": true }, "responses": { "200": { "description": "WarehouseBin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WarehouseBin" } } } } } }, "patch": { "tags": [ "WarehouseBins" ], "summary": "Patch WarehouseBin", "operationId": "patchProcurementWarehouseBinsById", "parameters": [ { "name": "id", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WarehouseBin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WarehouseBin" } } } } } } }, "/procurement/warehouseBins/{id}/info": { "get": { "tags": [ "WarehouseBinInfos" ], "summary": "Get WarehouseBinInfos", "operationId": "getProcurementWarehouseBinsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "WarehouseBinInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WarehouseBinInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WarehouseBinInfo" } } } } } } }, "/procurement/warehouseBins/{parentId}/inventoryOnHand": { "get": { "tags": [ "InventoryOnHands" ], "summary": "Get List of InventoryOnHand", "operationId": "getProcurementWarehouseBinsByParentIdInventoryOnHand", "parameters": [ { "name": "parentId", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InventoryOnHand", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryOnHand" } } } } } } } }, "/procurement/warehouseBins/{parentId}/inventoryOnHand/{id}": { "get": { "tags": [ "InventoryOnHands" ], "summary": "Get InventoryOnHand", "operationId": "getProcurementWarehouseBinsByParentIdInventoryOnHandById", "parameters": [ { "name": "id", "in": "path", "description": "inventoryOnHandId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InventoryOnHand", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InventoryOnHand" } } } } } } }, "/procurement/warehouseBins/{parentId}/inventoryOnHand/count": { "get": { "tags": [ "InventoryOnHands" ], "summary": "Get Count of InventoryOnHand", "operationId": "getProcurementWarehouseBinsByParentIdInventoryOnHandCount", "parameters": [ { "name": "parentId", "in": "path", "description": "warehouseBinId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/warehouseBins/count": { "get": { "tags": [ "WarehouseBins" ], "summary": "Get Count of WarehouseBin", "operationId": "getProcurementWarehouseBinsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/warehouseBins/info": { "get": { "tags": [ "WarehouseBinInfos" ], "summary": "Get List of WarehouseBinInfos", "operationId": "getProcurementWarehouseBinsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of warehouseBinInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseBinInfo" } } } } } } } }, "/procurement/warehouseBins/info/count": { "get": { "tags": [ "WarehouseBinInfos" ], "summary": "Get Count of WarehouseBins", "operationId": "getProcurementWarehouseBinsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/warehouses": { "get": { "tags": [ "Warehouses" ], "summary": "Get List of Warehouse", "operationId": "getProcurementWarehouses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Warehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" } } } } } } }, "post": { "tags": [ "Warehouses" ], "summary": "Post Warehouse", "operationId": "postProcurementWarehouses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "warehouse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Warehouse" } } }, "required": true }, "responses": { "201": { "description": "Warehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } } } } }, "/procurement/warehouses/{id}": { "get": { "tags": [ "Warehouses" ], "summary": "Get Warehouse", "operationId": "getProcurementWarehousesById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Warehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } } } }, "delete": { "tags": [ "Warehouses" ], "summary": "Delete Warehouse", "operationId": "deleteProcurementWarehousesById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Warehouses" ], "summary": "Put Warehouse", "operationId": "putProcurementWarehousesById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "warehouse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Warehouse" } } }, "required": true }, "responses": { "200": { "description": "Warehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } } } }, "patch": { "tags": [ "Warehouses" ], "summary": "Patch Warehouse", "operationId": "patchProcurementWarehousesById", "parameters": [ { "name": "id", "in": "path", "description": "warehousId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Warehouse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Warehouse" } } } } } } }, "/procurement/warehouses/{id}/info": { "get": { "tags": [ "WarehouseInfos" ], "summary": "Get WarehouseInfos", "operationId": "getProcurementWarehousesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "WarehouseInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WarehouseInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WarehouseInfo" } } } } } } }, "/procurement/warehouses/count": { "get": { "tags": [ "Warehouses" ], "summary": "Get Count of Warehouse", "operationId": "getProcurementWarehousesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/procurement/warehouses/info": { "get": { "tags": [ "WarehouseInfos" ], "summary": "Get List of WarehouseInfos", "operationId": "getProcurementWarehousesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of warehouseInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseInfo" } } } } } } } }, "/procurement/warehouses/info/count": { "get": { "tags": [ "WarehouseInfos" ], "summary": "Get Count of Warehouses", "operationId": "getProcurementWarehousesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/{parentId}/billingRates": { "get": { "tags": [ "ProjectBillingRates" ], "summary": "Get List of ProjectBillingRate", "operationId": "getProjectByParentIdBillingRates", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBillingRate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBillingRate" } } } } } } }, "post": { "tags": [ "ProjectBillingRates" ], "summary": "Post ProjectBillingRate", "operationId": "postProjectByParentIdBillingRates", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingRate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBillingRate" } } }, "required": true }, "responses": { "201": { "description": "ProjectBillingRate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBillingRate" } } } } } } }, "/project/{parentId}/billingRates/{id}": { "get": { "tags": [ "ProjectBillingRates" ], "summary": "Get ProjectBillingRate", "operationId": "getProjectByParentIdBillingRatesById", "parameters": [ { "name": "id", "in": "path", "description": "billingRateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBillingRate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBillingRate" } } } } } }, "delete": { "tags": [ "ProjectBillingRates" ], "summary": "Delete ProjectBillingRate", "operationId": "deleteProjectByParentIdBillingRatesById", "parameters": [ { "name": "id", "in": "path", "description": "billingRate", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBillingRates" ], "summary": "Put ProjectBillingRate", "operationId": "putProjectByParentIdBillingRatesById", "parameters": [ { "name": "id", "in": "path", "description": "billingRateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "billingRate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBillingRate" } } }, "required": true }, "responses": { "200": { "description": "ProjectBillingRate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBillingRate" } } } } } } }, "/project/{parentId}/billingRates/count": { "get": { "tags": [ "ProjectBillingRates" ], "summary": "Get Count of ProjectBillingRate", "operationId": "getProjectByParentIdBillingRatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/billingRates/{parentId}/billingRates/{id}": { "patch": { "tags": [ "ProjectBillingRates" ], "summary": "Patch ProjectBillingRate", "operationId": "patchProjectBillingRatesByParentIdBillingRatesById", "parameters": [ { "name": "id", "in": "path", "description": "billingRateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBillingRate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBillingRate" } } } } } } }, "/project/boards/{grandparentId}/teams/{parentId}/members": { "get": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Get List of ProjectBoardTeamMember", "operationId": "getProjectBoardsByGrandparentIdTeamsByParentIdMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } } }, "post": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Post ProjectBoardTeamMember", "operationId": "postProjectBoardsByGrandparentIdTeamsByParentIdMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } }, "required": true }, "responses": { "201": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } } }, "/project/boards/{grandparentId}/teams/{parentId}/members/{id}": { "get": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Get ProjectBoardTeamMember", "operationId": "getProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } }, "delete": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Delete ProjectBoardTeamMember", "operationId": "deleteProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Put ProjectBoardTeamMember", "operationId": "putProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } }, "patch": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Patch ProjectBoardTeamMember", "operationId": "patchProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } } }, "/project/boards/{parentId}/kanbanSettings": { "get": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Get List of ProjectBoardKanbanSettings", "operationId": "getProjectBoardsByParentIdKanbanSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } } }, "post": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Post ProjectBoardKanbanSetting", "operationId": "postProjectBoardsByParentIdKanbanSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "kanbanSettings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } }, "required": true }, "responses": { "201": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } } }, "/project/boards/{parentId}/kanbanSettings/{id}": { "get": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Get ProjectBoardKanbanSetting", "operationId": "getProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } }, "delete": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Delete ProjectBoardKanbanSetting", "operationId": "deleteProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Put ProjectBoardKanbanSetting", "operationId": "putProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Kanban", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } }, "patch": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Patch ProjectBoardKanbanSetting", "operationId": "patchProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } } }, "/project/boards/{parentId}/teams": { "get": { "tags": [ "ProjectBoardTeams" ], "summary": "Get List of ProjectBoardTeam", "operationId": "getProjectBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } } }, "post": { "tags": [ "ProjectBoardTeams" ], "summary": "Post ProjectBoardTeam", "operationId": "postProjectBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } }, "required": true }, "responses": { "201": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } } }, "/project/boards/{parentId}/teams/{id}": { "get": { "tags": [ "ProjectBoardTeams" ], "summary": "Get ProjectBoardTeam", "operationId": "getProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } }, "delete": { "tags": [ "ProjectBoardTeams" ], "summary": "Delete ProjectBoardTeam", "operationId": "deleteProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBoardTeams" ], "summary": "Put ProjectBoardTeam", "operationId": "putProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } }, "patch": { "tags": [ "ProjectBoardTeams" ], "summary": "Patch ProjectBoardTeam", "operationId": "patchProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } } }, "/project/boards/{parentId}/teams/{id}/info": { "get": { "tags": [ "ProjectBoardTeamInfos" ], "summary": "Get ProjectBoardTeamInfos", "operationId": "getProjectBoardsByParentIdTeamsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ProjectBoardTeamInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardTeamInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamInfo" } } } } } } }, "/project/boards/{parentId}/teams/{id}/info/count": { "get": { "tags": [ "ProjectBoardTeamInfos" ], "summary": "Get Count of ProjectBoardTeamInfos", "operationId": "getProjectBoardsByParentIdTeamsByIdInfoCount", "parameters": [ { "name": "id", "in": "path", "description": "ProjectBoardTeamInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/boards/{parentId}/teams/count": { "get": { "tags": [ "ProjectBoardTeams" ], "summary": "Get Count of ProjectBoardTeam", "operationId": "getProjectBoardsByParentIdTeamsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/boards/{parentId}/teams/info": { "get": { "tags": [ "ProjectBoardTeamInfos" ], "summary": "Get List of ProjectBoardTeamInfos", "operationId": "getProjectBoardsByParentIdTeamsInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "parentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectBoardTeamInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardTeamInfo" } } } } } } } }, "/project/phaseStatuses": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get List of PhaseStatus", "operationId": "getProjectPhaseStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhaseStatus" } } } } } } }, "post": { "tags": [ "PhaseStatuses" ], "summary": "Post PhaseStatus", "operationId": "postProjectPhaseStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "phaseStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } }, "required": true }, "responses": { "201": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } } }, "/project/phaseStatuses/{id}": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get PhaseStatus", "operationId": "getProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } }, "delete": { "tags": [ "PhaseStatuses" ], "summary": "Delete PhaseStatus", "operationId": "deleteProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PhaseStatuses" ], "summary": "Put PhaseStatus", "operationId": "putProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "phaseStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } }, "required": true }, "responses": { "200": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } }, "patch": { "tags": [ "PhaseStatuses" ], "summary": "Patch PhaseStatus", "operationId": "patchProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } } }, "/project/phaseStatuses/{id}/info": { "get": { "tags": [ "PhaseStatusInfos" ], "summary": "Get PhaseStatusInfos", "operationId": "getProjectPhaseStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "PhaseStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PhaseStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PhaseStatusInfo" } } } } } } }, "/project/phaseStatuses/{id}/usages": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get List of Usage Count", "operationId": "getProjectPhaseStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/phaseStatuses/{id}/usages/list": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get List of Usage", "operationId": "getProjectPhaseStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/phaseStatuses/count": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get Count of PhaseStatus", "operationId": "getProjectPhaseStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/phaseStatuses/info": { "get": { "tags": [ "PhaseStatusInfos" ], "summary": "Get List of PhaseStatusInfos", "operationId": "getProjectPhaseStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of phaseStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhaseStatusInfo" } } } } } } } }, "/project/projects": { "get": { "tags": [ "Projects" ], "summary": "Get List of ApiProject", "operationId": "getProjectProjects", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Post ApiProject", "operationId": "postProjectProjects", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "required": true }, "responses": { "201": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Project" } } } } } } }, "/project/projects/{id}": { "get": { "tags": [ "Projects" ], "summary": "Get ApiProject", "operationId": "getProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Project" } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete ApiProject", "operationId": "deleteProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Projects" ], "summary": "Put ApiProject", "operationId": "putProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "required": true }, "responses": { "200": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Project" } } } } } }, "patch": { "tags": [ "Projects" ], "summary": "Patch ApiProject", "operationId": "patchProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Project" } } } } } } }, "/project/projects/{id}/projectWorkplan": { "get": { "tags": [ "Projects" ], "summary": "Get ProjectWorkplan", "operationId": "getProjectProjectsByIdProjectWorkplan", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectWorkplan", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectWorkplan" } } } } } } }, "/project/projects/{parentId}/applyTemplate/{id}": { "post": { "tags": [ "Projects" ], "summary": "Post ApplyTemplate", "operationId": "postProjectProjectsByParentIdApplyTemplateById", "parameters": [ { "name": "id", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "ProjectWorkplan", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectWorkplan" } } } } } } }, "/project/projects/{parentId}/applyTemplates": { "post": { "tags": [ "Projects" ], "summary": "Post ApplyTemplates", "operationId": "postProjectProjectsByParentIdApplyTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of Project Templates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplate" } } } }, "required": true }, "responses": { "201": { "description": "ProjectWorkplan", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectWorkplan" } } } } } } }, "/project/projects/{parentId}/contacts": { "get": { "tags": [ "ProjectContacts" ], "summary": "Get List of ProjectContact", "operationId": "getProjectProjectsByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectContact" } } } } } } }, "post": { "tags": [ "ProjectContacts" ], "summary": "Post ProjectContact", "operationId": "postProjectProjectsByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectContact" } } }, "required": true }, "responses": { "201": { "description": "ProjectContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectContact" } } } } } } }, "/project/projects/{parentId}/contacts/{id}": { "get": { "tags": [ "ProjectContacts" ], "summary": "Get ProjectContact", "operationId": "getProjectProjectsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectContact" } } } } } }, "delete": { "tags": [ "ProjectContacts" ], "summary": "Delete ProjectContact", "operationId": "deleteProjectProjectsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/project/projects/{parentId}/notes": { "get": { "tags": [ "ProjectNotes" ], "summary": "Get List of ProjectNote", "operationId": "getProjectProjectsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectNote" } } } } } } }, "post": { "tags": [ "ProjectNotes" ], "summary": "Post ProjectNote", "operationId": "postProjectProjectsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } }, "required": true }, "responses": { "201": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } } }, "/project/projects/{parentId}/notes/{id}": { "get": { "tags": [ "ProjectNotes" ], "summary": "Get ProjectNote", "operationId": "getProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } }, "delete": { "tags": [ "ProjectNotes" ], "summary": "Delete ProjectNote", "operationId": "deleteProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectNotes" ], "summary": "Put ProjectNote", "operationId": "putProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } }, "required": true }, "responses": { "200": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } }, "patch": { "tags": [ "ProjectNotes" ], "summary": "Patch ProjectNote", "operationId": "patchProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } } }, "/project/projects/{parentId}/notes/count": { "get": { "tags": [ "ProjectNotes" ], "summary": "Get Count of ProjectNote", "operationId": "getProjectProjectsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/{parentId}/phases": { "get": { "tags": [ "ProjectPhases" ], "summary": "Get List of ProjectPhase", "operationId": "getProjectProjectsByParentIdPhases", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectPhase" } } } } } } }, "post": { "tags": [ "ProjectPhases" ], "summary": "Post ProjectPhase", "operationId": "postProjectProjectsByParentIdPhases", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectPhase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } }, "required": true }, "responses": { "201": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } } }, "/project/projects/{parentId}/phases/{id}": { "get": { "tags": [ "ProjectPhases" ], "summary": "Get ProjectPhase", "operationId": "getProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } }, "delete": { "tags": [ "ProjectPhases" ], "summary": "Delete ProjectPhase", "operationId": "deleteProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectPhases" ], "summary": "Put ProjectPhase", "operationId": "putProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectPhase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } }, "required": true }, "responses": { "200": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } }, "patch": { "tags": [ "ProjectPhases" ], "summary": "Patch ProjectPhase", "operationId": "patchProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } } }, "/project/projects/{parentId}/phases/count": { "get": { "tags": [ "ProjectPhases" ], "summary": "Get Count of ProjectPhase", "operationId": "getProjectProjectsByParentIdPhasesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/{parentId}/teamMembers": { "get": { "tags": [ "ProjectsTeamMembers" ], "summary": "Get List of ProjectTeamMember", "operationId": "getProjectProjectsByParentIdTeamMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } } }, "post": { "tags": [ "ProjectsTeamMembers" ], "summary": "Post ProjectTeamMember", "operationId": "postProjectProjectsByParentIdTeamMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } }, "required": true }, "responses": { "201": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } } }, "/project/projects/{parentId}/teamMembers/{id}": { "get": { "tags": [ "ProjectsTeamMembers" ], "summary": "Get ProjectTeamMember", "operationId": "getProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } }, "delete": { "tags": [ "ProjectsTeamMembers" ], "summary": "Delete ProjectTeamMember", "operationId": "deleteProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectsTeamMembers" ], "summary": "Put ProjectTeamMember", "operationId": "putProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } }, "required": true }, "responses": { "200": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } }, "patch": { "tags": [ "ProjectsTeamMembers" ], "summary": "Patch ProjectTeamMember", "operationId": "patchProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } } }, "/project/projects/{parentId}/teamMembers/count": { "get": { "tags": [ "ProjectsTeamMembers" ], "summary": "Get Count of ProjectTeamMember", "operationId": "getProjectProjectsByParentIdTeamMembersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/count": { "get": { "tags": [ "Projects" ], "summary": "Get Count of ApiProject", "operationId": "getProjectProjectsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projectTemplates/": { "get": { "tags": [ "ProjectTemplates" ], "summary": "Get List of ProjectTemplates", "operationId": "getProjectProjectTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectTemplates", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplate" } } } } } } }, "post": { "tags": [ "ProjectTemplates" ], "summary": "Post ProjectTemplates", "operationId": "postProjectProjectTemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ProjectTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } }, "required": true }, "responses": { "201": { "description": "ProjectTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } } } } } }, "/project/projectTemplates/{grandParentId}/projectTemplateTickets/{parentId}/tasks": { "get": { "tags": [ "ProjectTemplateTasks" ], "summary": "Get List of ProjectTemplateTasks", "operationId": "getProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasks", "parameters": [ { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectTemplateTaskses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplateTask" } } } } } } }, "post": { "tags": [ "ProjectTemplateTasks" ], "summary": "Post ProjectTemplateTasks", "operationId": "postProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasks", "parameters": [ { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ProjectTemplateTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTask" } } }, "required": true }, "responses": { "201": { "description": "ProjectTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTask" } } } } } } }, "/project/projectTemplates/{grandParentId}/projectTemplateTickets/{parentId}/tasks/{id}": { "get": { "tags": [ "ProjectTemplateTasks" ], "summary": "Get ProjectTemplateTasks", "operationId": "getProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTaskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTask" } } } } } }, "delete": { "tags": [ "ProjectTemplateTasks" ], "summary": "Delete ProjectTemplateTasks", "operationId": "deleteProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTaskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTemplateTasks" ], "summary": "Put ProjectTemplateTasks", "operationId": "putProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTaskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTask" } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTask" } } } } } }, "patch": { "tags": [ "ProjectTemplateTasks" ], "summary": "Patch ProjectTemplateTasks", "operationId": "patchProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTaskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTask" } } } } } } }, "/project/projectTemplates/{grandParentId}/projectTemplateTickets/{parentId}/tasks/count": { "get": { "tags": [ "ProjectTemplateTasks" ], "summary": "Get Count of ProjectTemplateTasks", "operationId": "getProjectProjectTemplatesByGrandParentIdProjectTemplateTicketsByParentIdTasksCount", "parameters": [ { "name": "grandParentId", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projectTemplates/{id}": { "get": { "tags": [ "ProjectTemplates" ], "summary": "Get ProjectTemplates", "operationId": "getProjectProjectTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } } } } }, "delete": { "tags": [ "ProjectTemplates" ], "summary": "Delete ProjectTemplates", "operationId": "deleteProjectProjectTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTemplates" ], "summary": "Put ProjectTemplates", "operationId": "putProjectProjectTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } } } } }, "patch": { "tags": [ "ProjectTemplates" ], "summary": "Patch ProjectTemplates", "operationId": "patchProjectProjectTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } } } } } }, "/project/projectTemplates/{id}/workplan": { "get": { "tags": [ "ProjectTemplates" ], "summary": "Get ProjectTemplatesWorkplan", "operationId": "getProjectProjectTemplatesByIdWorkplan", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "projectTemplateWorkPlan", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplateWorkPlan" } } } } } } } }, "/project/projectTemplates/{parentId}/projectTemplatePhases": { "get": { "tags": [ "ProjectTemplatePhases" ], "summary": "Get List of ProjectTemplatePhases", "operationId": "getProjectProjectTemplatesByParentIdProjectTemplatePhases", "parameters": [ { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectTemplatePhaseses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } } } } } }, "post": { "tags": [ "ProjectTemplatePhases" ], "summary": "Post ProjectTemplatePhases", "operationId": "postProjectProjectTemplatesByParentIdProjectTemplatePhases", "parameters": [ { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ProjectTemplatePhase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } }, "required": true }, "responses": { "201": { "description": "ProjectTemplatePhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } } } } } }, "/project/projectTemplates/{parentId}/projectTemplatePhases/{id}": { "get": { "tags": [ "ProjectTemplatePhases" ], "summary": "Get ProjectTemplatePhases", "operationId": "getProjectProjectTemplatesByParentIdProjectTemplatePhasesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplatePhaseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTemplatePhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } } } } }, "delete": { "tags": [ "ProjectTemplatePhases" ], "summary": "Delete ProjectTemplatePhases", "operationId": "deleteProjectProjectTemplatesByParentIdProjectTemplatePhasesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplatePhaseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTemplatePhases" ], "summary": "Put ProjectTemplatePhases", "operationId": "putProjectProjectTemplatesByParentIdProjectTemplatePhasesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplatePhaseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectTemplatePhase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplatePhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } } } } }, "patch": { "tags": [ "ProjectTemplatePhases" ], "summary": "Patch ProjectTemplatePhases", "operationId": "patchProjectProjectTemplatesByParentIdProjectTemplatePhasesById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplatePhaseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplatePhase", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } } } } } }, "/project/projectTemplates/{parentId}/projectTemplateTickets": { "get": { "tags": [ "ProjectTemplateTickets" ], "summary": "Get List of ProjectTemplateTickets", "operationId": "getProjectProjectTemplatesByParentIdProjectTemplateTickets", "parameters": [ { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectTemplateTickets", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } } } } } }, "post": { "tags": [ "ProjectTemplateTickets" ], "summary": "Post ProjectTemplateTickets", "operationId": "postProjectProjectTemplatesByParentIdProjectTemplateTickets", "parameters": [ { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ProjectTemplateTicket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } }, "required": true }, "responses": { "201": { "description": "ProjectTemplateTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } } } } } }, "/project/projectTemplates/{parentId}/projectTemplateTickets/{id}": { "get": { "tags": [ "ProjectTemplateTickets" ], "summary": "Get ProjectTemplateTickets", "operationId": "getProjectProjectTemplatesByParentIdProjectTemplateTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTemplateTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } } } } }, "delete": { "tags": [ "ProjectTemplateTickets" ], "summary": "Delete ProjectTemplateTickets", "operationId": "deleteProjectProjectTemplatesByParentIdProjectTemplateTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTemplateTickets" ], "summary": "Put ProjectTemplateTickets", "operationId": "putProjectProjectTemplatesByParentIdProjectTemplateTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplateTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } } } } }, "patch": { "tags": [ "ProjectTemplateTickets" ], "summary": "Patch ProjectTemplateTickets", "operationId": "patchProjectProjectTemplatesByParentIdProjectTemplateTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTemplateTicketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTemplateTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } } } } } }, "/project/projectTemplates/{parentId}/projectTemplateTickets/count": { "get": { "tags": [ "ProjectTemplateTickets" ], "summary": "Get Count of ProjectTemplateTickets", "operationId": "getProjectProjectTemplatesByParentIdProjectTemplateTicketsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projectTemplates/count": { "get": { "tags": [ "ProjectTemplates" ], "summary": "Get Count of ProjectTemplates", "operationId": "getProjectProjectTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projectTemplates/createFromProject/{id}": { "post": { "tags": [ "ProjectTemplates" ], "summary": "Post CreateFromProject", "operationId": "postProjectProjectTemplatesCreateFromProjectById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ProjectTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } }, "required": true }, "responses": { "201": { "description": "ProjectTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTemplate" } } } } } } }, "/project/projectTemplates/projectTemplatePhases": { "get": { "tags": [ "ProjectTemplatePhases" ], "summary": "Get List of ProjectTemplatePhases", "operationId": "getProjectProjectTemplatesProjectTemplatePhases", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "List of projectTemplatePhaseses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplatePhase" } } } } } } } }, "/project/projectTemplates/projectTemplateTickets": { "get": { "tags": [ "ProjectTemplateTickets" ], "summary": "Get List of ProjectTemplateTickets", "operationId": "getProjectProjectTemplatesProjectTemplateTickets", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "parentId", "in": "path", "description": "projectTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "List of projectTemplateTickets", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplateTicket" } } } } } } } }, "/project/projectTemplates/projectTemplateTickets/tasks": { "get": { "tags": [ "ProjectTemplateTasks" ], "summary": "Get List of ProjectTemplateTasks", "operationId": "getProjectProjectTemplatesProjectTemplateTicketsTasks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectTemplateTaskses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplateTask" } } } } } } } }, "/project/projectTypes": { "get": { "tags": [ "ProjectTypes" ], "summary": "Get List of ProjectType", "operationId": "getProjectProjectTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectType" } } } } } } }, "post": { "tags": [ "ProjectTypes" ], "summary": "Post ProjectType", "operationId": "postProjectProjectTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectType" } } }, "required": true }, "responses": { "201": { "description": "ProjectType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectType" } } } } } } }, "/project/projectTypes/{id}": { "get": { "tags": [ "ProjectTypes" ], "summary": "Get ProjectType", "operationId": "getProjectProjectTypesById", "parameters": [ { "name": "id", "in": "path", "description": "projectTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectType" } } } } } }, "delete": { "tags": [ "ProjectTypes" ], "summary": "Delete ProjectType", "operationId": "deleteProjectProjectTypesById", "parameters": [ { "name": "id", "in": "path", "description": "projectTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTypes" ], "summary": "Put ProjectType", "operationId": "putProjectProjectTypesById", "parameters": [ { "name": "id", "in": "path", "description": "projectTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectType" } } }, "required": true }, "responses": { "200": { "description": "ProjectType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectType" } } } } } }, "patch": { "tags": [ "ProjectTypes" ], "summary": "Patch ProjectType", "operationId": "patchProjectProjectTypesById", "parameters": [ { "name": "id", "in": "path", "description": "projectTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectType" } } } } } } }, "/project/projectTypes/{id}/info": { "get": { "tags": [ "ProjectTypeInfos" ], "summary": "Get ProjectTypeInfos", "operationId": "getProjectProjectTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ProjectTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTypeInfo" } } } } } } }, "/project/projectTypes/{id}/usages": { "get": { "tags": [ "ProjectTypes" ], "summary": "Get List of Usage Count", "operationId": "getProjectProjectTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "projectTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/projectTypes/{id}/usages/list": { "get": { "tags": [ "ProjectTypes" ], "summary": "Get List of Usage", "operationId": "getProjectProjectTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "projectTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/projectTypes/count": { "get": { "tags": [ "ProjectTypes" ], "summary": "Get Count of ProjectType", "operationId": "getProjectProjectTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projectTypes/info": { "get": { "tags": [ "ProjectTypeInfos" ], "summary": "Get List of ProjectTypeInfos", "operationId": "getProjectProjectTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTypeInfo" } } } } } } } }, "/project/projectTypes/info/count": { "get": { "tags": [ "ProjectTypeInfos" ], "summary": "Get Count of ProjectTypeInfos", "operationId": "getProjectProjectTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/securityRoles": { "get": { "tags": [ "ProjectSecurityRoles" ], "summary": "Get List of ProjectSecurityRole", "operationId": "getProjectSecurityRoles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectSecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectSecurityRole" } } } } } } }, "post": { "tags": [ "ProjectSecurityRoles" ], "summary": "Post ProjectSecurityRole", "operationId": "postProjectSecurityRoles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectSecurityRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRole" } } }, "required": true }, "responses": { "201": { "description": "ProjectSecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRole" } } } } } } }, "/project/securityRoles/{id}": { "get": { "tags": [ "ProjectSecurityRoles" ], "summary": "Get ProjectSecurityRole", "operationId": "getProjectSecurityRolesById", "parameters": [ { "name": "id", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectSecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRole" } } } } } }, "delete": { "tags": [ "ProjectSecurityRoles" ], "summary": "Delete ProjectSecurityRole", "operationId": "deleteProjectSecurityRolesById", "parameters": [ { "name": "id", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectSecurityRoles" ], "summary": "Put ProjectSecurityRole", "operationId": "putProjectSecurityRolesById", "parameters": [ { "name": "id", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectSecurityRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRole" } } }, "required": true }, "responses": { "200": { "description": "ProjectSecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRole" } } } } } }, "patch": { "tags": [ "ProjectSecurityRoles" ], "summary": "Patch ProjectSecurityRole", "operationId": "patchProjectSecurityRolesById", "parameters": [ { "name": "id", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectSecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRole" } } } } } } }, "/project/securityRoles/{id}/info": { "get": { "tags": [ "ProjectSecurityRoleInfos" ], "summary": "Get ProjectSecurityRoleInfos", "operationId": "getProjectSecurityRolesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ProjectSecurityRoleInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectSecurityRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRoleInfo" } } } } } } }, "/project/securityRoles/{parentId}/settings": { "get": { "tags": [ "ProjectSecurityRoleSettings" ], "summary": "Get List of ProjectSecurityRoleSetting", "operationId": "getProjectSecurityRolesByParentIdSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectSecurityRoleSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectSecurityRoleSetting" } } } } } } } }, "/project/securityRoles/{parentId}/settings/{id}": { "get": { "tags": [ "ProjectSecurityRoleSettings" ], "summary": "Get ProjectSecurityRoleSetting", "operationId": "getProjectSecurityRolesByParentIdSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectSecurityRoleSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRoleSetting" } } } } } }, "put": { "tags": [ "ProjectSecurityRoleSettings" ], "summary": "Put ProjectSecurityRoleSetting", "operationId": "putProjectSecurityRolesByParentIdSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectSecurityRoleSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRoleSetting" } } }, "required": true }, "responses": { "200": { "description": "ProjectSecurityRoleSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRoleSetting" } } } } } }, "patch": { "tags": [ "ProjectSecurityRoleSettings" ], "summary": "Patch ProjectSecurityRoleSetting", "operationId": "patchProjectSecurityRolesByParentIdSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectSecurityRoleSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectSecurityRoleSetting" } } } } } } }, "/project/securityRoles/{parentId}/settings/count": { "get": { "tags": [ "ProjectSecurityRoleSettings" ], "summary": "Get Count of ProjectSecurityRoleSetting", "operationId": "getProjectSecurityRolesByParentIdSettingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/securityRoles/count": { "get": { "tags": [ "ProjectSecurityRoles" ], "summary": "Get Count of ProjectSecurityRole", "operationId": "getProjectSecurityRolesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/securityRoles/info": { "get": { "tags": [ "ProjectSecurityRoleInfos" ], "summary": "Get List of ProjectSecurityRoleInfos", "operationId": "getProjectSecurityRolesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectSecurityRoleInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectSecurityRoleInfo" } } } } } } } }, "/project/statuses": { "get": { "tags": [ "ProjectStatuses" ], "summary": "Get List of ProjectStatus", "operationId": "getProjectStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatus" } } } } } } }, "post": { "tags": [ "ProjectStatuses" ], "summary": "Post ProjectStatus", "operationId": "postProjectStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "required": true }, "responses": { "201": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } } }, "/project/statuses/{id}": { "get": { "tags": [ "ProjectStatuses" ], "summary": "Get ProjectStatus", "operationId": "getProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } }, "delete": { "tags": [ "ProjectStatuses" ], "summary": "Delete ProjectStatus", "operationId": "deleteProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectStatuses" ], "summary": "Put ProjectStatus", "operationId": "putProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "required": true }, "responses": { "200": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } }, "patch": { "tags": [ "ProjectStatuses" ], "summary": "Patch ProjectStatus", "operationId": "patchProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } } }, "/project/statuses/{id}/info": { "get": { "tags": [ "ProjectStatusesInfo" ], "summary": "Get ProjectStatusesInfo", "operationId": "getProjectStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ProjectStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectStatusInfo" } } } } } } }, "/project/statuses/{id}/usages": { "get": { "tags": [ "Statuses" ], "summary": "Get List of Usage Count", "operationId": "getProjectStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/statuses/{id}/usages/list": { "get": { "tags": [ "Statuses" ], "summary": "Get List of Usage", "operationId": "getProjectStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/statuses/count": { "get": { "tags": [ "ProjectStatuses" ], "summary": "Get Count of ProjectStatus", "operationId": "getProjectStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/statuses/info": { "get": { "tags": [ "ProjectStatusesInfo" ], "summary": "Get List of ProjectStatusesInfo", "operationId": "getProjectStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatusInfo" } } } } } } } }, "/project/statuses/info/count": { "get": { "tags": [ "ProjectStatusesInfo" ], "summary": "Get Count of ProjectStatusInfo", "operationId": "getProjectStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/statusIndicators": { "get": { "tags": [ "StatusIndicators" ], "summary": "Get List of StatusIndicator", "operationId": "getProjectStatusIndicators", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of StatusIndicator", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusIndicator" } } } } } } } }, "/project/statusIndicators/{id}": { "get": { "tags": [ "StatusIndicators" ], "summary": "Get StatusIndicator", "operationId": "getProjectStatusIndicatorsById", "parameters": [ { "name": "id", "in": "path", "description": "statusIndicatorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "StatusIndicator", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StatusIndicator" } } } } } } }, "/project/statusIndicators/count": { "get": { "tags": [ "StatusIndicators" ], "summary": "Get Count of StatusIndicator", "operationId": "getProjectStatusIndicatorsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/ticketNote/{id}/markAs/": { "post": { "tags": [ "ProjectTicketNotes" ], "summary": "Post ProjectTicketNote", "operationId": "postProjectTicketNoteByIdMarkAs", "parameters": [ { "name": "id", "in": "path", "description": "ticketNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTicketNote" } } }, "required": true }, "responses": { "default": { "description": "Responses cannot be located for this operation." } } } }, "/project/tickets": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ProjectTicket", "operationId": "getProjectTickets", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } }, "post": { "tags": [ "ProjectTickets" ], "summary": "Post ProjectTicket", "operationId": "postProjectTickets", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } }, "required": true }, "responses": { "201": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } }, "/project/tickets/{id}": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get ProjectTicket", "operationId": "getProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } }, "delete": { "tags": [ "ProjectTickets" ], "summary": "Delete ProjectTicket", "operationId": "deleteProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTickets" ], "summary": "Put ProjectTicket", "operationId": "putProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } }, "required": true }, "responses": { "200": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } }, "patch": { "tags": [ "ProjectTickets" ], "summary": "Patch ProjectTicket", "operationId": "patchProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } }, "/project/tickets/{parentId}/activities": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ActivityReference\r\n Gets activities associated to the ticket\r\n Please use the /sales/activities?conditions=ticket/id={id} endpoint", "operationId": "getProjectTicketsByParentIdActivities", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityReference" } } } } } } } }, "/project/tickets/{parentId}/activities/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ActivityReference\r\n Gets count of activities associated to the ticket\r\n Please use the /sales/activities/count?conditions=ticket/id={id} endpoint", "operationId": "getProjectTicketsByParentIdActivitiesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/allNotes": { "get": { "tags": [ "ProjectTicketNotes" ], "summary": "Get List of ProjectTicketNote", "operationId": "getProjectTicketsByParentIdAllNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectTicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTicketNote" } } } } } } } }, "/project/tickets/{parentId}/configurations": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ConfigurationReference", "operationId": "getProjectTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "post": { "tags": [ "ProjectTickets" ], "summary": "Post ConfigurationReference", "operationId": "postProjectTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "/project/tickets/{parentId}/configurations/{id}": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get ConfigurationReference", "operationId": "getProjectTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } }, "delete": { "tags": [ "ProjectTickets" ], "summary": "Delete ConfigurationReference", "operationId": "deleteProjectTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/project/tickets/{parentId}/configurations/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ConfigurationReference", "operationId": "getProjectTicketsByParentIdConfigurationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/convert": { "post": { "tags": [ "ProjectTickets" ], "summary": "Post SuccessResponse", "operationId": "postProjectTicketsByParentIdConvert", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertItem" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/project/tickets/{parentId}/documents": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of DocumentReference\r\n Gets the documents associated to the ticket\r\n Please use the /system/documents?recordType=Ticket&recordId={id} endpoint", "operationId": "getProjectTicketsByParentIdDocuments", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } } } } }, "/project/tickets/{parentId}/documents/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of DocumentReference", "operationId": "getProjectTicketsByParentIdDocumentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/notes": { "get": { "tags": [ "TicketNotes" ], "summary": "Get List of TicketNote", "operationId": "getProjectTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketNote" } } } } } } }, "post": { "tags": [ "TicketNotes" ], "summary": "Post TicketNote", "operationId": "postProjectTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketNote" } } }, "required": true }, "responses": { "201": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } } }, "/project/tickets/{parentId}/notes/{id}": { "get": { "tags": [ "TicketNotes" ], "summary": "Get TicketNote", "operationId": "getProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } }, "delete": { "tags": [ "TicketNotes" ], "summary": "Delete TicketNote", "operationId": "deleteProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketNotes" ], "summary": "Put TicketNote", "operationId": "putProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketNote" } } }, "required": true }, "responses": { "200": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } }, "patch": { "tags": [ "TicketNotes" ], "summary": "Patch TicketNote", "operationId": "patchProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } } }, "/project/tickets/{parentId}/notes/count": { "get": { "tags": [ "TicketNotes" ], "summary": "Get Count of TicketNote", "operationId": "getProjectTicketsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/products": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdProducts", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReference" } } } } } } } }, "/project/tickets/{parentId}/products/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products/count?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdProductsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/scheduleentries": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ScheduleEntryReference\r\n Gets the schedule entries associated to the ticket\r\n Please use the /schedule/entries?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getProjectTicketsByParentIdScheduleentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntryReference" } } } } } } } }, "/project/tickets/{parentId}/scheduleentries/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ScheduleEntryReference\r\n Gets the schedule entries count associated to the ticket\r\n Please use the /schedule/entries/count?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getProjectTicketsByParentIdScheduleentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/tasks": { "get": { "tags": [ "TicketTasks" ], "summary": "Get List of TicketTask", "operationId": "getProjectTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTask" } } } } } } }, "post": { "tags": [ "TicketTasks" ], "summary": "Post TicketTask", "operationId": "postProjectTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketTask" } } }, "required": true }, "responses": { "201": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } } }, "/project/tickets/{parentId}/tasks/{id}": { "get": { "tags": [ "TicketTasks" ], "summary": "Get TicketTask", "operationId": "getProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } }, "delete": { "tags": [ "TicketTasks" ], "summary": "Delete TicketTask", "operationId": "deleteProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketTasks" ], "summary": "Put TicketTask", "operationId": "putProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketTask" } } }, "required": true }, "responses": { "200": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } }, "patch": { "tags": [ "TicketTasks" ], "summary": "Patch TicketTask", "operationId": "patchProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } } }, "/project/tickets/{parentId}/tasks/count": { "get": { "tags": [ "TicketTasks" ], "summary": "Get Count of TicketTask", "operationId": "getProjectTicketsByParentIdTasksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/timeentries": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of TimeEntryReference\r\n Gets time entries associated to the ticket\r\n Please use the /time/entries?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdTimeentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryReference" } } } } } } } }, "/project/tickets/{parentId}/timeentries/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of TimeEntryReference\r\n Gets time entries count associated to the ticket\r\n Please use the /time/entries/count?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdTimeentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ProjectTicket", "operationId": "getProjectTicketsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/search": { "post": { "tags": [ "ProjectTickets" ], "summary": "Post List of ProjectTicket", "operationId": "postProjectTicketsSearch", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "filterValues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterValues" } } }, "required": true }, "responses": { "200": { "description": "List of ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } } }, "/sales/activities": { "get": { "tags": [ "Activities" ], "summary": "Get List of Activity", "operationId": "getSalesActivities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Activity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } } } } } }, "post": { "tags": [ "Activities" ], "summary": "Post Activity", "operationId": "postSalesActivities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } }, "required": true }, "responses": { "201": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } } }, "/sales/activities/{id}": { "get": { "tags": [ "Activities" ], "summary": "Get Activity", "operationId": "getSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } }, "delete": { "tags": [ "Activities" ], "summary": "Delete Activity", "operationId": "deleteSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Activities" ], "summary": "Put Activity", "operationId": "putSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } }, "required": true }, "responses": { "200": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } }, "patch": { "tags": [ "Activities" ], "summary": "Patch Activity", "operationId": "patchSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } } }, "/sales/activities/count": { "get": { "tags": [ "Activities" ], "summary": "Get Count of Activity", "operationId": "getSalesActivitiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/statuses": { "get": { "tags": [ "ActivityStatuses" ], "summary": "Get List of ActivityStatus", "operationId": "getSalesActivitiesStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatus" } } } } } } }, "post": { "tags": [ "ActivityStatuses" ], "summary": "Post ActivityStatus", "operationId": "postSalesActivitiesStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } }, "required": true }, "responses": { "201": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } } }, "/sales/activities/statuses/{id}": { "get": { "tags": [ "ActivityStatuses" ], "summary": "Get ActivityStatus", "operationId": "getSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } }, "delete": { "tags": [ "ActivityStatuses" ], "summary": "Delete ActivityStatus", "operationId": "deleteSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ActivityStatuses" ], "summary": "Put ActivityStatus", "operationId": "putSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } }, "required": true }, "responses": { "200": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } }, "patch": { "tags": [ "ActivityStatuses" ], "summary": "Patch ActivityStatus", "operationId": "patchSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } } }, "/sales/activities/statuses/{id}/info": { "get": { "tags": [ "ActivityStatusInfos" ], "summary": "Get ActivityStatusInfos", "operationId": "getSalesActivitiesStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ActivityStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStatusInfo" } } } } } } }, "/sales/activities/statuses/count": { "get": { "tags": [ "ActivityStatuses" ], "summary": "Get Count of ActivityStatus", "operationId": "getSalesActivitiesStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/statuses/info": { "get": { "tags": [ "ActivityStatusInfos" ], "summary": "Get List of ActivityStatusInfos", "operationId": "getSalesActivitiesStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of activityStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatusInfo" } } } } } } } }, "/sales/activities/statuses/info/count": { "get": { "tags": [ "ActivityStatusInfos" ], "summary": "Get Count of ActivityStatus", "operationId": "getSalesActivitiesStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/types": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get List of ActivityType", "operationId": "getSalesActivitiesTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } } } } } } }, "post": { "tags": [ "ActivityTypes" ], "summary": "Post ActivityType", "operationId": "postSalesActivitiesTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityType" } } }, "required": true }, "responses": { "201": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } } }, "/sales/activities/types/{id}": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get ActivityType", "operationId": "getSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } }, "delete": { "tags": [ "ActivityTypes" ], "summary": "Delete ActivityType", "operationId": "deleteSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ActivityTypes" ], "summary": "Put ActivityType", "operationId": "putSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityType" } } }, "required": true }, "responses": { "200": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } }, "patch": { "tags": [ "ActivityTypes" ], "summary": "Patch ActivityType", "operationId": "patchSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } } }, "/sales/activities/types/{id}/usages": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get List of Usage Count", "operationId": "getSalesActivitiesTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/activities/types/{id}/usages/list": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get List of Usage", "operationId": "getSalesActivitiesTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/activities/types/count": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get Count of ActivityType", "operationId": "getSalesActivitiesTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/commissions": { "get": { "tags": [ "Commissions" ], "summary": "Get List of Commission", "operationId": "getSalesCommissions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Commission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Commission" } } } } } } }, "post": { "tags": [ "Commissions" ], "summary": "Post Commission", "operationId": "postSalesCommissions", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "commission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commission" } } }, "required": true }, "responses": { "201": { "description": "Commission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Commission" } } } } } } }, "/sales/commissions/{id}": { "get": { "tags": [ "Commissions" ], "summary": "Get Commission", "operationId": "getSalesCommissionsById", "parameters": [ { "name": "id", "in": "path", "description": "commissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Commission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Commission" } } } } } }, "delete": { "tags": [ "Commissions" ], "summary": "Delete Commission", "operationId": "deleteSalesCommissionsById", "parameters": [ { "name": "id", "in": "path", "description": "commissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Commissions" ], "summary": "Put Commission", "operationId": "putSalesCommissionsById", "parameters": [ { "name": "id", "in": "path", "description": "commissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "commission", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commission" } } }, "required": true }, "responses": { "200": { "description": "Commission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Commission" } } } } } }, "patch": { "tags": [ "Commissions" ], "summary": "Patch Commission", "operationId": "patchSalesCommissionsById", "parameters": [ { "name": "id", "in": "path", "description": "commissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Commission", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Commission" } } } } } } }, "/sales/commissions/{id}/usages": { "get": { "tags": [ "Commissions" ], "summary": "Get List of Usage Count", "operationId": "getSalesCommissionsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "commissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/commissions/{id}/usages/list": { "get": { "tags": [ "Commissions" ], "summary": "Get List of Usage", "operationId": "getSalesCommissionsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "commissionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/commissions/count": { "get": { "tags": [ "Commissions" ], "summary": "Get Count of Commission", "operationId": "getSalesCommissionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities": { "get": { "tags": [ "Opportunities" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "getSalesOpportunities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Opportunity" } } } } } } }, "post": { "tags": [ "Opportunities" ], "summary": "Post ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "postSalesOpportunities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Opportunity" } } }, "required": true }, "responses": { "201": { "description": "ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Opportunity" } } } } } } }, "/sales/opportunities/{id}": { "get": { "tags": [ "Opportunities" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "getSalesOpportunitiesById", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Opportunity" } } } } } }, "delete": { "tags": [ "Opportunities" ], "summary": "Delete ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "deleteSalesOpportunitiesById", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Opportunities" ], "summary": "Put ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "putSalesOpportunitiesById", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Opportunity" } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Opportunity" } } } } } }, "patch": { "tags": [ "Opportunities" ], "summary": "Patch ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "patchSalesOpportunitiesById", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Opportunity" } } } } } } }, "/sales/opportunities/{id}/convertToAgreement": { "post": { "tags": [ "Opportunities" ], "summary": "Post ApiAgreement", "operationId": "postSalesOpportunitiesByIdConvertToAgreement", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityToAgreementConversion" } } }, "required": true }, "responses": { "201": { "description": "ApiAgreement", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/sales/opportunities/{id}/convertToProject": { "post": { "tags": [ "Opportunities" ], "summary": "Post ApiProject", "operationId": "postSalesOpportunitiesByIdConvertToProject", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityToProjectConversion" } } }, "required": true }, "responses": { "201": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Project" } } } } } } }, "/sales/opportunities/{id}/convertToSalesOrder": { "post": { "tags": [ "Opportunities" ], "summary": "Post ApiSalesOrder", "operationId": "postSalesOpportunitiesByIdConvertToSalesOrder", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityToSalesOrderConversion" } } }, "required": true }, "responses": { "201": { "description": "ApiSalesOrder", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/sales/opportunities/{id}/convertToServiceTicket": { "post": { "tags": [ "Opportunities" ], "summary": "Post ApiTicket", "operationId": "postSalesOpportunitiesByIdConvertToServiceTicket", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityToServiceTicketConversion" } } }, "required": true }, "responses": { "201": { "description": "ApiTicket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/sales/opportunities/{parentId}/contacts": { "get": { "tags": [ "OpportunityContacts" ], "summary": "Get List of OpportunityContact", "operationId": "getSalesOpportunitiesByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityContact" } } } } } } }, "post": { "tags": [ "OpportunityContacts" ], "summary": "Post OpportunityContact", "operationId": "postSalesOpportunitiesByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunityContact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityContact" } } }, "required": true }, "responses": { "201": { "description": "OpportunityContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityContact" } } } } } } }, "/sales/opportunities/{parentId}/contacts/{id}": { "get": { "tags": [ "OpportunityContacts" ], "summary": "Get OpportunityContact", "operationId": "getSalesOpportunitiesByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityContact" } } } } } }, "delete": { "tags": [ "OpportunityContacts" ], "summary": "Delete OpportunityContact", "operationId": "deleteSalesOpportunitiesByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityContacts" ], "summary": "Put OpportunityContact", "operationId": "putSalesOpportunitiesByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunityContact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityContact" } } }, "required": true }, "responses": { "200": { "description": "OpportunityContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityContact" } } } } } }, "patch": { "tags": [ "OpportunityContacts" ], "summary": "Patch OpportunityContact", "operationId": "patchSalesOpportunitiesByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OpportunityContact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityContact" } } } } } } }, "/sales/opportunities/{parentId}/contacts/count": { "get": { "tags": [ "OpportunityContacts" ], "summary": "Get Count of OpportunityContact", "operationId": "getSalesOpportunitiesByParentIdContactsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/{parentId}/forecast": { "get": { "tags": [ "OpportunityForecasts" ], "summary": "Get List of Forecast", "operationId": "getSalesOpportunitiesByParentIdForecast", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Forecast", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Forecast" } } } } } } }, "post": { "tags": [ "OpportunityForecasts" ], "summary": "Post Forecast", "operationId": "postSalesOpportunitiesByParentIdForecast", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "forecast", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forecast" } } }, "required": true }, "responses": { "201": { "description": "Forecast", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Forecast" } } } } } } }, "/sales/opportunities/{parentId}/forecast/": { "delete": { "tags": [ "OpportunityForecasts" ], "summary": "Delete Forecast", "operationId": "deleteSalesOpportunitiesByParentIdForecast", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityForecasts" ], "summary": "Put Forecast", "operationId": "putSalesOpportunitiesByParentIdForecast", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "forecast", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forecast" } } }, "required": true }, "responses": { "200": { "description": "Forecast", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Forecast" } } } } } }, "patch": { "tags": [ "OpportunityForecasts" ], "summary": "Patch Forecast", "operationId": "patchSalesOpportunitiesByParentIdForecast", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Forecast", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Forecast" } } } } } } }, "/sales/opportunities/{parentId}/forecast/{id}": { "get": { "tags": [ "OpportunityForecastItems" ], "summary": "Get ForecastItem", "operationId": "getSalesOpportunitiesByParentIdForecastById", "parameters": [ { "name": "id", "in": "path", "description": "forecastId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ForecastItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ForecastItem" } } } } } }, "post": { "tags": [ "OpportunityForecastItems" ], "summary": "Post ForecastItem", "operationId": "postSalesOpportunitiesByParentIdForecastById", "parameters": [ { "name": "id", "in": "path", "description": "forecastId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "forecast", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastItem" } } }, "required": true }, "responses": { "201": { "description": "ForecastItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ForecastItem" } } } } } }, "delete": { "tags": [ "OpportunityForecastItems" ], "summary": "Delete ForecastItem", "operationId": "deleteSalesOpportunitiesByParentIdForecastById", "parameters": [ { "name": "id", "in": "path", "description": "forecastId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityForecastItems" ], "summary": "Put ForecastItem", "operationId": "putSalesOpportunitiesByParentIdForecastById", "parameters": [ { "name": "id", "in": "path", "description": "forecastId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "forecast", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastItem" } } }, "required": true }, "responses": { "200": { "description": "ForecastItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ForecastItem" } } } } } }, "patch": { "tags": [ "OpportunityForecastItems" ], "summary": "Patch ForecastItem", "operationId": "patchSalesOpportunitiesByParentIdForecastById", "parameters": [ { "name": "id", "in": "path", "description": "forecastId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ForecastItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ForecastItem" } } } } } } }, "/sales/opportunities/{parentId}/forecast/copy/{id}": { "post": { "tags": [ "OpportunityForecasts" ], "summary": "Post SuccessResponse", "operationId": "postSalesOpportunitiesByParentIdForecastCopyById", "parameters": [ { "name": "id", "in": "path", "description": "copyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/sales/opportunities/{parentId}/forecast/count": { "get": { "tags": [ "OpportunityForecasts" ], "summary": "Get Count of Forecast", "operationId": "getSalesOpportunitiesByParentIdForecastCount", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/{parentId}/notes": { "get": { "tags": [ "OpportunityNotes" ], "summary": "Get List of OpportunityNote", "operationId": "getSalesOpportunitiesByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityNote" } } } } } } }, "post": { "tags": [ "OpportunityNotes" ], "summary": "Post OpportunityNote", "operationId": "postSalesOpportunitiesByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityNote" } } }, "required": true }, "responses": { "201": { "description": "OpportunityNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityNote" } } } } } } }, "/sales/opportunities/{parentId}/notes/{id}": { "get": { "tags": [ "OpportunityNotes" ], "summary": "Get OpportunityNote", "operationId": "getSalesOpportunitiesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityNote" } } } } } }, "delete": { "tags": [ "OpportunityNotes" ], "summary": "Delete OpportunityNote", "operationId": "deleteSalesOpportunitiesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityNotes" ], "summary": "Put OpportunityNote", "operationId": "putSalesOpportunitiesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityNote" } } }, "required": true }, "responses": { "200": { "description": "OpportunityNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityNote" } } } } } }, "patch": { "tags": [ "OpportunityNotes" ], "summary": "Patch OpportunityNote", "operationId": "patchSalesOpportunitiesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OpportunityNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityNote" } } } } } } }, "/sales/opportunities/{parentId}/notes/count": { "get": { "tags": [ "OpportunityNotes" ], "summary": "Get List of OpportunityNote", "operationId": "getSalesOpportunitiesByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityNote" } } } } } } } }, "/sales/opportunities/{parentId}/team": { "get": { "tags": [ "OpportunityTeams" ], "summary": "Get List of Team", "operationId": "getSalesOpportunitiesByParentIdTeam", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Team", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } } } } } }, "post": { "tags": [ "OpportunityTeams" ], "summary": "Post Team", "operationId": "postSalesOpportunitiesByParentIdTeam", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "required": true }, "responses": { "201": { "description": "Team", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Team" } } } } } } }, "/sales/opportunities/{parentId}/team/{id}": { "get": { "tags": [ "OpportunityTeams" ], "summary": "Get Team", "operationId": "getSalesOpportunitiesByParentIdTeamById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Team", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Team" } } } } } }, "delete": { "tags": [ "OpportunityTeams" ], "summary": "Delete Team", "operationId": "deleteSalesOpportunitiesByParentIdTeamById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityTeams" ], "summary": "Put Team", "operationId": "putSalesOpportunitiesByParentIdTeamById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } } }, "required": true }, "responses": { "200": { "description": "Team", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Team" } } } } } }, "patch": { "tags": [ "OpportunityTeams" ], "summary": "Patch Team", "operationId": "patchSalesOpportunitiesByParentIdTeamById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Team", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Team" } } } } } } }, "/sales/opportunities/{parentId}/team/count": { "get": { "tags": [ "OpportunityTeams" ], "summary": "Get Count of Team", "operationId": "getSalesOpportunitiesByParentIdTeamCount", "parameters": [ { "name": "parentId", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/conversions/{id}": { "get": { "tags": [ "Opportunities" ], "summary": "Get Conversion", "operationId": "getSalesOpportunitiesConversionsById", "parameters": [ { "name": "id", "in": "path", "description": "opportunityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityConvesions", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesConversion" } } } } } } } }, "/sales/opportunities/count": { "get": { "tags": [ "Opportunities" ], "summary": "Get Count of ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "getSalesOpportunitiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/default": { "get": { "tags": [ "Opportunities" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "operationId": "getSalesOpportunitiesDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Sales.Opportunity.Opportunity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Opportunity" } } } } } } }, "/sales/opportunities/ratings": { "get": { "tags": [ "OpportunityRatings" ], "summary": "Get List of OpportunityRating", "operationId": "getSalesOpportunitiesRatings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityRating", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityRating" } } } } } } }, "post": { "tags": [ "OpportunityRatings" ], "summary": "Post OpportunityRating", "operationId": "postSalesOpportunitiesRatings", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunityRating", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRating" } } }, "required": true }, "responses": { "201": { "description": "OpportunityRating", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityRating" } } } } } } }, "/sales/opportunities/ratings/{id}": { "get": { "tags": [ "OpportunityRatings" ], "summary": "Get OpportunityRating", "operationId": "getSalesOpportunitiesRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "ratingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityRating", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityRating" } } } } } }, "delete": { "tags": [ "OpportunityRatings" ], "summary": "Delete OpportunityRating", "operationId": "deleteSalesOpportunitiesRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "ratingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityRatings" ], "summary": "Put OpportunityRating", "operationId": "putSalesOpportunitiesRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "ratingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunityRating", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityRating" } } }, "required": true }, "responses": { "200": { "description": "OpportunityRating", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityRating" } } } } } }, "patch": { "tags": [ "OpportunityRatings" ], "summary": "Patch OpportunityRating", "operationId": "patchSalesOpportunitiesRatingsById", "parameters": [ { "name": "id", "in": "path", "description": "ratingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OpportunityRating", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityRating" } } } } } } }, "/sales/opportunities/ratings/{id}/info": { "get": { "tags": [ "OpportunityRatings" ], "summary": "Get OpportunityRatingInfo", "operationId": "getSalesOpportunitiesRatingsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ratingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityRatingInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityRatingInfo" } } } } } } }, "/sales/opportunities/ratings/count": { "get": { "tags": [ "OpportunityRatings" ], "summary": "Get Count of OpportunityRating", "operationId": "getSalesOpportunitiesRatingsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/ratings/info": { "get": { "tags": [ "OpportunityRatings" ], "summary": "Get List of OpportunityRatingInfo", "operationId": "getSalesOpportunitiesRatingsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityRatingInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityRatingInfo" } } } } } } } }, "/sales/opportunities/ratings/info/count": { "get": { "tags": [ "OpportunityRatings" ], "summary": "Get Count of OpportunityRatingInfo", "operationId": "getSalesOpportunitiesRatingsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/statuses": { "get": { "tags": [ "OpportunityStatuses" ], "summary": "Get List of OpportunityStatus", "operationId": "getSalesOpportunitiesStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStatus" } } } } } } }, "post": { "tags": [ "OpportunityStatuses" ], "summary": "Post OpportunityStatus", "operationId": "postSalesOpportunitiesStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityStatus" } } }, "required": true }, "responses": { "201": { "description": "OpportunityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStatus" } } } } } } }, "/sales/opportunities/statuses/{id}": { "get": { "tags": [ "OpportunityStatuses" ], "summary": "Get OpportunityStatus", "operationId": "getSalesOpportunitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStatus" } } } } } }, "delete": { "tags": [ "OpportunityStatuses" ], "summary": "Delete OpportunityStatus", "operationId": "deleteSalesOpportunitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityStatuses" ], "summary": "Put OpportunityStatus", "operationId": "putSalesOpportunitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityStatus" } } }, "required": true }, "responses": { "200": { "description": "OpportunityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStatus" } } } } } }, "patch": { "tags": [ "OpportunityStatuses" ], "summary": "Patch OpportunityStatus", "operationId": "patchSalesOpportunitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OpportunityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStatus" } } } } } } }, "/sales/opportunities/statuses/{id}/info": { "get": { "tags": [ "OpportunityStatusInfos" ], "summary": "Get OpportunityStatusInfos", "operationId": "getSalesOpportunitiesStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "OpportunityStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStatusInfo" } } } } } } }, "/sales/opportunities/statuses/{id}/usages": { "get": { "tags": [ "OpportunityStatuses" ], "summary": "Get List of Usage Count", "operationId": "getSalesOpportunitiesStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/opportunities/statuses/{id}/usages/list": { "get": { "tags": [ "OpportunityStatuses" ], "summary": "Get List of Usage", "operationId": "getSalesOpportunitiesStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/opportunities/statuses/count": { "get": { "tags": [ "OpportunityStatuses" ], "summary": "Get Count of OpportunityStatus", "operationId": "getSalesOpportunitiesStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/statuses/info": { "get": { "tags": [ "OpportunityStatusInfos" ], "summary": "Get List of OpportunityStatusInfos", "operationId": "getSalesOpportunitiesStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of opportunityStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStatusInfo" } } } } } } } }, "/sales/opportunities/statuses/info/count": { "get": { "tags": [ "OpportunityStatusInfos" ], "summary": "Get Count of OpportunityStatusInfos", "operationId": "getSalesOpportunitiesStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/types": { "get": { "tags": [ "OpportunityTypes" ], "summary": "Get List of OpportunityType", "operationId": "getSalesOpportunitiesTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OpportunityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityType" } } } } } } }, "post": { "tags": [ "OpportunityTypes" ], "summary": "Post OpportunityType", "operationId": "postSalesOpportunitiesTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunityType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityType" } } }, "required": true }, "responses": { "201": { "description": "OpportunityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityType" } } } } } } }, "/sales/opportunities/types/{id}": { "get": { "tags": [ "OpportunityTypes" ], "summary": "Get OpportunityType", "operationId": "getSalesOpportunitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityType" } } } } } }, "delete": { "tags": [ "OpportunityTypes" ], "summary": "Delete OpportunityType", "operationId": "deleteSalesOpportunitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityTypes" ], "summary": "Put OpportunityType", "operationId": "putSalesOpportunitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "opportunityType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityType" } } }, "required": true }, "responses": { "200": { "description": "OpportunityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityType" } } } } } }, "patch": { "tags": [ "OpportunityTypes" ], "summary": "Patch OpportunityType", "operationId": "patchSalesOpportunitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OpportunityType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityType" } } } } } } }, "/sales/opportunities/types/{id}/info": { "get": { "tags": [ "OpportunityTypeInfos" ], "summary": "Get OpportunityTypeInfos", "operationId": "getSalesOpportunitiesTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "OpportunityTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OpportunityTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityTypeInfo" } } } } } } }, "/sales/opportunities/types/{id}/usages": { "get": { "tags": [ "OpportunityTypes" ], "summary": "Get List of Usage Count", "operationId": "getSalesOpportunitiesTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/opportunities/types/{id}/usages/list": { "get": { "tags": [ "OpportunityTypes" ], "summary": "Get List of Usage", "operationId": "getSalesOpportunitiesTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/opportunities/types/count": { "get": { "tags": [ "OpportunityTypes" ], "summary": "Get Count of OpportunityType", "operationId": "getSalesOpportunitiesTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/opportunities/types/info": { "get": { "tags": [ "OpportunityTypeInfos" ], "summary": "Get List of OpportunityTypeInfos", "operationId": "getSalesOpportunitiesTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of opportunityTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityTypeInfo" } } } } } } } }, "/sales/opportunities/types/info/count": { "get": { "tags": [ "OpportunityTypeInfos" ], "summary": "Get Count of OpportunityType", "operationId": "getSalesOpportunitiesTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/orders": { "get": { "tags": [ "Orders" ], "summary": "Get List of Order", "operationId": "getSalesOrders", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Order", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } }, "post": { "tags": [ "Orders" ], "summary": "Post List of Order", "operationId": "postSalesOrders", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } }, "required": true }, "responses": { "200": { "description": "Order", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/sales/orders/{id}": { "get": { "tags": [ "Orders" ], "summary": "Get Order", "operationId": "getSalesOrdersById", "parameters": [ { "name": "id", "in": "path", "description": "orderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Order", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Order" } } } } } }, "delete": { "tags": [ "Orders" ], "summary": "Delete Order", "operationId": "deleteSalesOrdersById", "parameters": [ { "name": "id", "in": "path", "description": "orderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Orders" ], "summary": "Put Order", "operationId": "putSalesOrdersById", "parameters": [ { "name": "id", "in": "path", "description": "orderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "order", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } }, "required": true }, "responses": { "200": { "description": "Order", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Order" } } } } } }, "patch": { "tags": [ "Orders" ], "summary": "Patch Order", "operationId": "patchSalesOrdersById", "parameters": [ { "name": "id", "in": "path", "description": "orderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Order", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/sales/orders/{id}/convertToServiceTicket": { "post": { "tags": [ "Orders" ], "summary": "Post Ticket", "operationId": "postSalesOrdersByIdConvertToServiceTicket", "parameters": [ { "name": "id", "in": "path", "description": "orderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/sales/orders/{id}/financialrecap": { "get": { "tags": [ "SalesOrderRecaps" ], "summary": "Get List of SalesOrderRecaps", "operationId": "getSalesOrdersByIdFinancialrecap", "parameters": [ { "name": "id", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of salesOrderRecapses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderRecap" } } } } } } } }, "/sales/orders/{parentId}/lineitems/": { "get": { "tags": [ "SalesOrdersLineItems" ], "summary": "Get List of SalesOrdersLineItems", "operationId": "getSalesOrdersByParentIdLineitems", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of salesOrdersLineItemses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } } } } } }, "post": { "tags": [ "SalesOrdersLineItems" ], "summary": "Post SalesOrdersLineItems", "operationId": "postSalesOrdersByParentIdLineitems", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesOrdersLineItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } }, "required": true }, "responses": { "201": { "description": "SalesOrdersLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } } } } } }, "/sales/orders/{parentId}/lineitems/{id}": { "get": { "tags": [ "SalesOrdersLineItems" ], "summary": "Get SalesOrdersLineItems", "operationId": "getSalesOrdersByParentIdLineitemsById", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "salesOrdersLineItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SalesOrdersLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } } } } }, "delete": { "tags": [ "SalesOrdersLineItems" ], "summary": "Delete SalesOrdersLineItems", "operationId": "deleteSalesOrdersByParentIdLineitemsById", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "salesOrdersLineItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SalesOrdersLineItems" ], "summary": "Put SalesOrdersLineItems", "operationId": "putSalesOrdersByParentIdLineitemsById", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "salesOrdersLineItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesOrdersLineItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } }, "required": true }, "responses": { "200": { "description": "SalesOrdersLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } } } } }, "patch": { "tags": [ "SalesOrdersLineItems" ], "summary": "Patch SalesOrdersLineItems", "operationId": "patchSalesOrdersByParentIdLineitemsById", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "salesOrdersLineItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SalesOrdersLineItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesOrdersLineItem" } } } } } } }, "/sales/orders/{parentId}/lineitems/count": { "get": { "tags": [ "SalesOrdersLineItems" ], "summary": "Get Count of SalesOrdersLineItems", "operationId": "getSalesOrdersByParentIdLineitemsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "salesOrderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/orders/conversions/{id}": { "get": { "tags": [ "Orders" ], "summary": "Get Conversion", "operationId": "getSalesOrdersConversionsById", "parameters": [ { "name": "id", "in": "path", "description": "orderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SalesOrderConvesions", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesConversion" } } } } } } } }, "/sales/orders/count": { "get": { "tags": [ "Orders" ], "summary": "Get Count of Order", "operationId": "getSalesOrdersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/orders/statuses": { "get": { "tags": [ "OrderStatuses" ], "summary": "Get List of OrderStatus", "operationId": "getSalesOrdersStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } } } } } }, "post": { "tags": [ "OrderStatuses" ], "summary": "Post List of OrderStatus", "operationId": "postSalesOrdersStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatus" } } }, "required": true }, "responses": { "200": { "description": "List of OrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatus" } } } } } } } }, "/sales/orders/statuses/{id}": { "get": { "tags": [ "OrderStatuses" ], "summary": "Get OrderStatus", "operationId": "getSalesOrdersStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatus" } } } } } }, "delete": { "tags": [ "OrderStatuses" ], "summary": "Delete OrderStatus", "operationId": "deleteSalesOrdersStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OrderStatuses" ], "summary": "Put OrderStatus", "operationId": "putSalesOrdersStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatus" } } }, "required": true }, "responses": { "200": { "description": "OrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatus" } } } } } }, "patch": { "tags": [ "OrderStatuses" ], "summary": "Patch OrderStatus", "operationId": "patchSalesOrdersStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OrderStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatus" } } } } } } }, "/sales/orders/statuses/{id}/info": { "get": { "tags": [ "OrderStatusInfos" ], "summary": "Get OrderStatusInfos", "operationId": "getSalesOrdersStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "OrderStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OrderStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusInfo" } } } } } } }, "/sales/orders/statuses/{id}/usages": { "get": { "tags": [ "OrderStatuses" ], "summary": "Get List of Usage Count", "operationId": "getSalesOrdersStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/orders/statuses/{id}/usages/list": { "get": { "tags": [ "OrderStatuses" ], "summary": "Get List of Usage", "operationId": "getSalesOrdersStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/orders/statuses/{parentId}/emailtemplates/": { "get": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Get List of OrderStatusEmailTemplate", "operationId": "getSalesOrdersStatusesByParentIdEmailtemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } } } } } }, "post": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Post OrderStatusEmailTemplate", "operationId": "postSalesOrdersStatusesByParentIdEmailtemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "orderStatusEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } }, "required": true }, "responses": { "201": { "description": "OrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } } } } } }, "/sales/orders/statuses/{parentId}/emailtemplates/{id}": { "get": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Get OrderStatusEmailTemplate", "operationId": "getSalesOrdersStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } } } } }, "delete": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Delete OrderStatusEmailTemplate", "operationId": "deleteSalesOrdersStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Put OrderStatusEmailTemplate", "operationId": "putSalesOrdersStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "orderStatusEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } }, "required": true }, "responses": { "200": { "description": "OrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } } } } }, "patch": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Patch OrderStatusEmailTemplate", "operationId": "patchSalesOrdersStatusesByParentIdEmailtemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailtemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OrderStatusEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusEmailTemplate" } } } } } } }, "/sales/orders/statuses/{parentId}/emailtemplates/count": { "get": { "tags": [ "OrderStatusesEmailTemplate" ], "summary": "Get Count of OrderStatusEmailTemplate", "operationId": "getSalesOrdersStatusesByParentIdEmailtemplatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/orders/statuses/{parentId}/notifications": { "get": { "tags": [ "OrderStatusNotifications" ], "summary": "Get List of OrderStatusNotification", "operationId": "getSalesOrdersStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusNotification" } } } } } } }, "post": { "tags": [ "OrderStatusNotifications" ], "summary": "Post OrderStatusNotification", "operationId": "postSalesOrdersStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "orderStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusNotification" } } }, "required": true }, "responses": { "201": { "description": "OrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusNotification" } } } } } } }, "/sales/orders/statuses/{parentId}/notifications/{id}": { "get": { "tags": [ "OrderStatusNotifications" ], "summary": "Get OrderStatusNotification", "operationId": "getSalesOrdersStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusNotification" } } } } } }, "delete": { "tags": [ "OrderStatusNotifications" ], "summary": "Delete OrderStatusNotification", "operationId": "deleteSalesOrdersStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OrderStatusNotifications" ], "summary": "Put OrderStatusNotification", "operationId": "putSalesOrdersStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "orderStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusNotification" } } }, "required": true }, "responses": { "200": { "description": "OrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusNotification" } } } } } }, "patch": { "tags": [ "OrderStatusNotifications" ], "summary": "Patch OrderStatusNotification", "operationId": "patchSalesOrdersStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OrderStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OrderStatusNotification" } } } } } } }, "/sales/orders/statuses/{parentId}/notifications/count": { "get": { "tags": [ "OrderStatusNotifications" ], "summary": "Get Count of OrderStatusNotification", "operationId": "getSalesOrdersStatusesByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/orders/statuses/count": { "get": { "tags": [ "OrderStatuses" ], "summary": "Get Count of OrderStatus", "operationId": "getSalesOrdersStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/orders/statuses/info": { "get": { "tags": [ "OrderStatusInfos" ], "summary": "Get List of OrderStatusInfos", "operationId": "getSalesOrdersStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of orderStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderStatusInfo" } } } } } } } }, "/sales/orders/statuses/info/count": { "get": { "tags": [ "OrderStatusInfos" ], "summary": "Get Count of OrderStatusInfos", "operationId": "getSalesOrdersStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/probabilities": { "get": { "tags": [ "SalesProbabilities" ], "summary": "Get List of SalesProbability", "operationId": "getSalesProbabilities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SalesProbability", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesProbability" } } } } } } }, "post": { "tags": [ "SalesProbabilities" ], "summary": "Post SalesProbability", "operationId": "postSalesProbabilities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "probability", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesProbability" } } }, "required": true }, "responses": { "201": { "description": "SalesProbability", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesProbability" } } } } } } }, "/sales/probabilities/{id}": { "get": { "tags": [ "SalesProbabilities" ], "summary": "Get SalesProbability", "operationId": "getSalesProbabilitiesById", "parameters": [ { "name": "id", "in": "path", "description": "probabilityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SalesProbability", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesProbability" } } } } } }, "delete": { "tags": [ "SalesProbabilities" ], "summary": "Delete SalesProbability", "operationId": "deleteSalesProbabilitiesById", "parameters": [ { "name": "id", "in": "path", "description": "probabilityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SalesProbabilities" ], "summary": "Put SalesProbability", "operationId": "putSalesProbabilitiesById", "parameters": [ { "name": "id", "in": "path", "description": "probabilityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "probability", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesProbability" } } }, "required": true }, "responses": { "200": { "description": "SalesProbability", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesProbability" } } } } } }, "patch": { "tags": [ "SalesProbabilities" ], "summary": "Patch SalesProbability", "operationId": "patchSalesProbabilitiesById", "parameters": [ { "name": "id", "in": "path", "description": "probabilityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SalesProbability", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesProbability" } } } } } } }, "/sales/probabilities/{id}/info": { "get": { "tags": [ "SalesProbabilityInfos" ], "summary": "Get SalesProbabilityInfos", "operationId": "getSalesProbabilitiesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SalesProbabilityInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SalesProbabilityInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesProbabilityInfo" } } } } } } }, "/sales/probabilities/count": { "get": { "tags": [ "SalesProbabilities" ], "summary": "Get Count of SalesProbability", "operationId": "getSalesProbabilitiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/probabilities/info": { "get": { "tags": [ "SalesProbabilityInfos" ], "summary": "Get List of SalesProbabilityInfos", "operationId": "getSalesProbabilitiesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of salesProbabilityInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesProbabilityInfo" } } } } } } } }, "/sales/probabilities/info/count": { "get": { "tags": [ "SalesProbabilityInfos" ], "summary": "Get Count of SalesProbabilityInfos", "operationId": "getSalesProbabilitiesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/quotas": { "get": { "tags": [ "SalesQuotas" ], "summary": "Get List of SalesQuota", "operationId": "getSalesQuotas", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SalesQuota", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesQuota" } } } } } } }, "post": { "tags": [ "SalesQuotas" ], "summary": "Post SalesQuota", "operationId": "postSalesQuotas", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesQuota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuota" } } }, "required": true }, "responses": { "201": { "description": "SalesQuota", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesQuota" } } } } } } }, "/sales/quotas/{id}": { "get": { "tags": [ "SalesQuotas" ], "summary": "Get SalesQuota", "operationId": "getSalesQuotasById", "parameters": [ { "name": "id", "in": "path", "description": "quotaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SalesQuota", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesQuota" } } } } } }, "delete": { "tags": [ "SalesQuotas" ], "summary": "Delete SalesQuota", "operationId": "deleteSalesQuotasById", "parameters": [ { "name": "id", "in": "path", "description": "quotaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SalesQuotas" ], "summary": "Put SalesQuota", "operationId": "putSalesQuotasById", "parameters": [ { "name": "id", "in": "path", "description": "quotaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesQuota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesQuota" } } }, "required": true }, "responses": { "200": { "description": "SalesQuota", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesQuota" } } } } } }, "patch": { "tags": [ "SalesQuotas" ], "summary": "Patch SalesQuota", "operationId": "patchSalesQuotasById", "parameters": [ { "name": "id", "in": "path", "description": "quotaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SalesQuota", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesQuota" } } } } } } }, "/sales/quotas/count": { "get": { "tags": [ "SalesQuotas" ], "summary": "Get Count of SalesQuota", "operationId": "getSalesQuotasCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/roles": { "get": { "tags": [ "Roles" ], "summary": "Get List of Role", "operationId": "getSalesRoles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Role", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Role" } } } } } } }, "post": { "tags": [ "Roles" ], "summary": "Post Role", "operationId": "postSalesRoles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "role", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "required": true }, "responses": { "201": { "description": "Role", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Role" } } } } } } }, "/sales/roles/{id}": { "get": { "tags": [ "Roles" ], "summary": "Get Role", "operationId": "getSalesRolesById", "parameters": [ { "name": "id", "in": "path", "description": "roleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Role", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Role" } } } } } }, "delete": { "tags": [ "Roles" ], "summary": "Delete Role", "operationId": "deleteSalesRolesById", "parameters": [ { "name": "id", "in": "path", "description": "roleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Roles" ], "summary": "Put Role", "operationId": "putSalesRolesById", "parameters": [ { "name": "id", "in": "path", "description": "roleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "role", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "required": true }, "responses": { "200": { "description": "Role", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Role" } } } } } }, "patch": { "tags": [ "Roles" ], "summary": "Patch Role", "operationId": "patchSalesRolesById", "parameters": [ { "name": "id", "in": "path", "description": "roleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Role", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Role" } } } } } } }, "/sales/roles/count": { "get": { "tags": [ "Roles" ], "summary": "Get Count of Role", "operationId": "getSalesRolesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/salesTeams": { "get": { "tags": [ "SalesTeams" ], "summary": "Get List of SalesTeam", "operationId": "getSalesSalesTeams", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SalesTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesTeam" } } } } } } }, "post": { "tags": [ "SalesTeams" ], "summary": "Post SalesTeam", "operationId": "postSalesSalesTeams", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTeam" } } }, "required": true }, "responses": { "201": { "description": "SalesTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeam" } } } } } } }, "/sales/salesTeams/{id}": { "get": { "tags": [ "SalesTeams" ], "summary": "Get SalesTeam", "operationId": "getSalesSalesTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SalesTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeam" } } } } } }, "delete": { "tags": [ "SalesTeams" ], "summary": "Delete SalesTeam", "operationId": "deleteSalesSalesTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SalesTeams" ], "summary": "Put SalesTeam", "operationId": "putSalesSalesTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTeam" } } }, "required": true }, "responses": { "200": { "description": "SalesTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeam" } } } } } }, "patch": { "tags": [ "SalesTeams" ], "summary": "Patch SalesTeam", "operationId": "patchSalesSalesTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SalesTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeam" } } } } } } }, "/sales/salesTeams/{parentId}/members": { "get": { "tags": [ "SalesTeamMembers" ], "summary": "Get List of SalesTeamMember", "operationId": "getSalesSalesTeamsByParentIdMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SalesTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesTeamMember" } } } } } } }, "post": { "tags": [ "SalesTeamMembers" ], "summary": "Post SalesTeamMember", "operationId": "postSalesSalesTeamsByParentIdMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesTeamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTeamMember" } } }, "required": true }, "responses": { "201": { "description": "SalesTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeamMember" } } } } } } }, "/sales/salesTeams/{parentId}/members/{id}": { "get": { "tags": [ "SalesTeamMembers" ], "summary": "Get SalesTeamMember", "operationId": "getSalesSalesTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SalesTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeamMember" } } } } } }, "delete": { "tags": [ "SalesTeamMembers" ], "summary": "Delete SalesTeamMember", "operationId": "deleteSalesSalesTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SalesTeamMembers" ], "summary": "Put SalesTeamMember", "operationId": "putSalesSalesTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "salesTeamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesTeamMember" } } }, "required": true }, "responses": { "200": { "description": "SalesTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeamMember" } } } } } }, "patch": { "tags": [ "SalesTeamMembers" ], "summary": "Patch SalesTeamMember", "operationId": "patchSalesSalesTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SalesTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SalesTeamMember" } } } } } } }, "/sales/salesTeams/{parentId}/members/count": { "get": { "tags": [ "SalesTeamMembers" ], "summary": "Get Count of SalesTeamMember", "operationId": "getSalesSalesTeamsByParentIdMembersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "salesTeamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/salesTeams/count": { "get": { "tags": [ "SalesTeams" ], "summary": "Get Count of SalesTeam", "operationId": "getSalesSalesTeamsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/schedule/holidaylists/{parentId}/holidays/info/count": { "get": { "tags": [ "HolidayInfos" ], "summary": "Get Count of HolidayInfos", "operationId": "getSalesScheduleHolidaylistsByParentIdHolidaysInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "HolidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/schedule/holidaylists/info/count": { "get": { "tags": [ "HolidayListInfos" ], "summary": "Get Count of HolidayListInfos", "operationId": "getSalesScheduleHolidaylistsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/service/priority/info/count": { "get": { "tags": [ "OrderStatusInfos" ], "summary": "Get Count of OrderStatusInfos", "operationId": "getSalesServicePriorityInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/stages": { "get": { "tags": [ "OpportunityStages" ], "summary": "Get List of Stage", "operationId": "getSalesStages", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Stage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStage" } } } } } } }, "post": { "tags": [ "OpportunityStages" ], "summary": "Post Stage", "operationId": "postSalesStages", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "stage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityStage" } } }, "required": true }, "responses": { "201": { "description": "Stage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStage" } } } } } } }, "/sales/stages/{id}": { "get": { "tags": [ "OpportunityStages" ], "summary": "Get Stage", "operationId": "getSalesStagesById", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Stage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStage" } } } } } }, "delete": { "tags": [ "OpportunityStages" ], "summary": "Delete Stage", "operationId": "deleteSalesStagesById", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "OpportunityStages" ], "summary": "Put Stage", "operationId": "putSalesStagesById", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "stage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityStage" } } }, "required": true }, "responses": { "200": { "description": "Stage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStage" } } } } } }, "patch": { "tags": [ "OpportunityStages" ], "summary": "Patch Stage", "operationId": "patchSalesStagesById", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Stage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStage" } } } } } } }, "/sales/stages/{id}/info": { "get": { "tags": [ "OpportunityStagesInfo" ], "summary": "Get StageInfo", "operationId": "getSalesStagesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "StageInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OpportunityStageInfo" } } } } } } }, "/sales/stages/{id}/usages": { "get": { "tags": [ "OpportunityStages" ], "summary": "Get List of Usage Count", "operationId": "getSalesStagesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/stages/{id}/usages/list": { "get": { "tags": [ "OpportunityStages" ], "summary": "Get List of Usage", "operationId": "getSalesStagesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "stageId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/stages/count": { "get": { "tags": [ "OpportunityStages" ], "summary": "Get Count of Stage", "operationId": "getSalesStagesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/stages/info": { "get": { "tags": [ "OpportunityStagesInfo" ], "summary": "Get List of StageInfos", "operationId": "getSalesStagesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of StageInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityStageInfo" } } } } } } } }, "/sales/stages/info/count": { "get": { "tags": [ "OpportunityStagesInfo" ], "summary": "Get Count of StageInfo", "operationId": "getSalesStagesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/calendars": { "get": { "tags": [ "Calendars" ], "summary": "Get List of Calendar", "operationId": "getScheduleCalendars", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Calendar" } } } } } } }, "post": { "tags": [ "Calendars" ], "summary": "Post Calendar", "operationId": "postScheduleCalendars", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "calendar", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } }, "required": true }, "responses": { "201": { "description": "Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Calendar" } } } } } } }, "/schedule/calendars/{id}": { "get": { "tags": [ "Calendars" ], "summary": "Get Calendar", "operationId": "getScheduleCalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Calendar" } } } } } }, "patch": { "tags": [ "Calendars" ], "summary": "Patch Calendar", "operationId": "patchScheduleCalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Calendar" } } } } } }, "put": { "tags": [ "Calendars" ], "summary": "Put Calendar", "operationId": "putScheduleCalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "calendar", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Calendar" } } }, "required": true }, "responses": { "200": { "description": "Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Calendar" } } } } } }, "delete": { "tags": [ "Calendars" ], "summary": "Delete Calendar", "operationId": "deleteScheduleCalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/schedule/calendars/{id}/copy": { "post": { "tags": [ "Calendars" ], "summary": "Post Calendar", "operationId": "postScheduleCalendarsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Calendar" } } } } } } }, "/schedule/calendars/{id}/info": { "get": { "tags": [ "CalendarInfos" ], "summary": "Get CalendarInfos", "operationId": "getScheduleCalendarsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "CalendarInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CalendarInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CalendarInfo" } } } } } } }, "/schedule/calendars/{id}/usages": { "get": { "tags": [ "Calendars" ], "summary": "Get List of Usage", "operationId": "getScheduleCalendarsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/schedule/calendars/{id}/usages/list": { "get": { "tags": [ "Calendars" ], "summary": "Get List of Usage", "operationId": "getScheduleCalendarsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "calendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/schedule/calendars/count": { "get": { "tags": [ "Calendars" ], "summary": "Get Calendar", "operationId": "getScheduleCalendarsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Calendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Calendar" } } } } } } }, "/schedule/calendars/info": { "get": { "tags": [ "CalendarInfos" ], "summary": "Get List of CalendarInfos", "operationId": "getScheduleCalendarsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of calendarInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarInfo" } } } } } } } }, "/schedule/calendars/info/count": { "get": { "tags": [ "CalendarInfos" ], "summary": "Get CalendarInfos", "operationId": "getScheduleCalendarsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CalendarInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CalendarInfo" } } } } } } }, "/schedule/colors": { "get": { "tags": [ "ScheduleColors" ], "summary": "Get List of ScheduleColor", "operationId": "getScheduleColors", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleColor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleColor" } } } } } } } }, "/schedule/colors/{id}": { "get": { "tags": [ "ScheduleColors" ], "summary": "Get ScheduleColor", "operationId": "getScheduleColorsById", "parameters": [ { "name": "id", "in": "path", "description": "colorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleColor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleColor" } } } } } }, "put": { "tags": [ "ScheduleColors" ], "summary": "Put ScheduleColor", "operationId": "putScheduleColorsById", "parameters": [ { "name": "id", "in": "path", "description": "colorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleColor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleColor" } } }, "required": true }, "responses": { "200": { "description": "ScheduleColor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleColor" } } } } } }, "patch": { "tags": [ "ScheduleColors" ], "summary": "Patch ScheduleColor", "operationId": "patchScheduleColorsById", "parameters": [ { "name": "id", "in": "path", "description": "colorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleColor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleColor" } } } } } } }, "/schedule/colors/{id}/clear": { "post": { "tags": [ "ScheduleColors" ], "summary": "Post ScheduleColor", "operationId": "postScheduleColorsByIdClear", "parameters": [ { "name": "id", "in": "path", "description": "colorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleColor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleColor" } } } } } } }, "/schedule/colors/count": { "get": { "tags": [ "ScheduleColors" ], "summary": "Get Count of ScheduleColor", "operationId": "getScheduleColorsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/colors/reset": { "post": { "tags": [ "ScheduleColors" ], "summary": "Post List of ScheduleColor", "operationId": "postScheduleColorsReset", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleColor", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleColor" } } } } } } } }, "/schedule/details": { "get": { "tags": [ "ScheduleEntryDetails" ], "summary": "Get List of ScheduleEntryDetail", "operationId": "getScheduleDetails", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntryDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntryDetail" } } } } } } } }, "/schedule/details/{id}": { "get": { "tags": [ "ScheduleEntryDetails" ], "summary": "Get ScheduleEntryDetail", "operationId": "getScheduleDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleEntryDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleEntryDetail" } } } } } } }, "/schedule/details/count": { "get": { "tags": [ "ScheduleEntryDetails" ], "summary": "Get Count of ScheduleEntryDetail", "operationId": "getScheduleDetailsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/entries": { "get": { "tags": [ "ScheduleEntries" ], "summary": "Get List of ScheduleEntry", "operationId": "getScheduleEntries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } } }, "post": { "tags": [ "ScheduleEntries" ], "summary": "Post ScheduleEntry", "operationId": "postScheduleEntries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } }, "required": true }, "responses": { "201": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } } }, "/schedule/entries/{id}": { "get": { "tags": [ "ScheduleEntries" ], "summary": "Get ScheduleEntry", "operationId": "getScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } }, "delete": { "tags": [ "ScheduleEntries" ], "summary": "Delete ScheduleEntry", "operationId": "deleteScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ScheduleEntries" ], "summary": "Put ScheduleEntry", "operationId": "putScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } }, "required": true }, "responses": { "200": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } }, "patch": { "tags": [ "ScheduleEntries" ], "summary": "Patch ScheduleEntry", "operationId": "patchScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } } }, "/schedule/entries/{id}/{notifyResource}": { "delete": { "tags": [ "ScheduleEntries" ], "summary": "Delete ScheduleEntry", "operationId": "deleteScheduleEntriesByIdByNotifyResource", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "notifyResource", "in": "path", "description": "notifyResource", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/schedule/entries/{parentId}/details": { "get": { "tags": [ "ScheduleDetails" ], "summary": "Get List of ScheduleDetail", "operationId": "getScheduleEntriesByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDetail" } } } } } } } }, "/schedule/entries/{parentId}/details/{id}": { "get": { "tags": [ "ScheduleDetails" ], "summary": "Get ScheduleDetail", "operationId": "getScheduleEntriesByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleDetail" } } } } } } }, "/schedule/entries/{parentId}/details/count": { "get": { "tags": [ "ScheduleDetails" ], "summary": "Get Count of ScheduleDetail", "operationId": "getScheduleEntriesByParentIdDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/entries/count": { "get": { "tags": [ "ScheduleEntries" ], "summary": "Get Count of ScheduleEntry", "operationId": "getScheduleEntriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/holidayLists": { "get": { "tags": [ "HolidayLists" ], "summary": "Get List of HolidayList", "operationId": "getScheduleHolidayLists", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of HolidayList", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HolidayList" } } } } } } }, "post": { "tags": [ "HolidayLists" ], "summary": "Post HolidayList", "operationId": "postScheduleHolidayLists", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "holidayList", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayList" } } }, "required": true }, "responses": { "201": { "description": "HolidayList", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayList" } } } } } } }, "/schedule/holidayLists/{id}": { "get": { "tags": [ "HolidayLists" ], "summary": "Get HolidayList", "operationId": "getScheduleHolidayListsById", "parameters": [ { "name": "id", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "HolidayList", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayList" } } } } } }, "delete": { "tags": [ "HolidayLists" ], "summary": "Delete HolidayList", "operationId": "deleteScheduleHolidayListsById", "parameters": [ { "name": "id", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "HolidayLists" ], "summary": "Put HolidayList", "operationId": "putScheduleHolidayListsById", "parameters": [ { "name": "id", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "holidayList", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayList" } } }, "required": true }, "responses": { "200": { "description": "HolidayList", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayList" } } } } } }, "patch": { "tags": [ "HolidayLists" ], "summary": "Patch HolidayList", "operationId": "patchScheduleHolidayListsById", "parameters": [ { "name": "id", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "HolidayList", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayList" } } } } } } }, "/schedule/holidaylists/{id}/info": { "get": { "tags": [ "HolidayListInfos" ], "summary": "Get HolidayListInfos", "operationId": "getScheduleHolidaylistsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "HolidayListInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "HolidayListInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayListInfo" } } } } } } }, "/schedule/holidayLists/{id}/usages": { "get": { "tags": [ "HolidayLists" ], "summary": "Get List of Usage Count", "operationId": "getScheduleHolidayListsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/schedule/holidayLists/{id}/usages/list": { "get": { "tags": [ "HolidayLists" ], "summary": "Get List of Usage", "operationId": "getScheduleHolidayListsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/schedule/holidayLists/{parentId}/holidays": { "get": { "tags": [ "Holidays" ], "summary": "Get List of Holiday", "operationId": "getScheduleHolidayListsByParentIdHolidays", "parameters": [ { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Holiday", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Holiday" } } } } } } }, "post": { "tags": [ "Holidays" ], "summary": "Post Holiday", "operationId": "postScheduleHolidayListsByParentIdHolidays", "parameters": [ { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "holiday", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Holiday" } } }, "required": true }, "responses": { "201": { "description": "Holiday", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Holiday" } } } } } } }, "/schedule/holidayLists/{parentId}/holidays/{id}": { "get": { "tags": [ "Holidays" ], "summary": "Get Holiday", "operationId": "getScheduleHolidayListsByParentIdHolidaysById", "parameters": [ { "name": "id", "in": "path", "description": "holidayId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Holiday", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Holiday" } } } } } }, "delete": { "tags": [ "Holidays" ], "summary": "Delete Holiday", "operationId": "deleteScheduleHolidayListsByParentIdHolidaysById", "parameters": [ { "name": "id", "in": "path", "description": "holidayId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Holidays" ], "summary": "Put Holiday", "operationId": "putScheduleHolidayListsByParentIdHolidaysById", "parameters": [ { "name": "id", "in": "path", "description": "holidayId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "holiday", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Holiday" } } }, "required": true }, "responses": { "200": { "description": "Holiday", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Holiday" } } } } } }, "patch": { "tags": [ "Holidays" ], "summary": "Patch Holiday", "operationId": "patchScheduleHolidayListsByParentIdHolidaysById", "parameters": [ { "name": "id", "in": "path", "description": "holidayId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Holiday", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Holiday" } } } } } } }, "/schedule/holidaylists/{parentId}/holidays/{id}/info": { "get": { "tags": [ "HolidayInfos" ], "summary": "Get HolidayInfos", "operationId": "getScheduleHolidaylistsByParentIdHolidaysByIdInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "HolidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "HolidayInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "HolidayInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayInfo" } } } } } } }, "/schedule/holidayLists/{parentId}/holidays/count": { "get": { "tags": [ "Holidays" ], "summary": "Get Count of Holiday", "operationId": "getScheduleHolidayListsByParentIdHolidaysCount", "parameters": [ { "name": "parentId", "in": "path", "description": "holidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/holidaylists/{parentId}/holidays/info": { "get": { "tags": [ "HolidayInfos" ], "summary": "Get List of HolidayInfo", "operationId": "getScheduleHolidaylistsByParentIdHolidaysInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "HolidayListId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of holidayInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HolidayInfo" } } } } } } } }, "/schedule/holidayLists/copy": { "post": { "tags": [ "HolidayLists" ], "summary": "Post HolidayList", "operationId": "postScheduleHolidayListsCopy", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "copy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayList" } } }, "required": true }, "responses": { "200": { "description": "HolidayList", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/HolidayList" } } } } } } }, "/schedule/holidayLists/count": { "get": { "tags": [ "HolidayLists" ], "summary": "Get Count of Usage", "operationId": "getScheduleHolidayListsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/holidaylists/info": { "get": { "tags": [ "HolidayListInfos" ], "summary": "Get List of HolidayListInfos", "operationId": "getScheduleHolidaylistsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of holidayListInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HolidayListInfo" } } } } } } } }, "/schedule/portalcalendars": { "get": { "tags": [ "PortalCalendars" ], "summary": "Get List of PortalCalendar", "operationId": "getSchedulePortalcalendars", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalCalendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalCalendar" } } } } } } } }, "/schedule/portalcalendars/{id}": { "get": { "tags": [ "PortalCalendars" ], "summary": "Get PortalCalendar", "operationId": "getSchedulePortalcalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "portalcalendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalCalendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalCalendar" } } } } } }, "put": { "tags": [ "PortalCalendars" ], "summary": "Put PortalCalendar", "operationId": "putSchedulePortalcalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "portalcalendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalCalendar", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalCalendar" } } }, "required": true }, "responses": { "200": { "description": "PortalCalendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalCalendar" } } } } } }, "patch": { "tags": [ "PortalCalendars" ], "summary": "Patch PortalCalendar", "operationId": "patchSchedulePortalcalendarsById", "parameters": [ { "name": "id", "in": "path", "description": "portalcalendarId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalCalendar", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalCalendar" } } } } } } }, "/schedule/portalcalendars/count": { "get": { "tags": [ "PortalCalendars" ], "summary": "Get Count of PortalCalendar", "operationId": "getSchedulePortalcalendarsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/reminderTimes": { "get": { "tags": [ "ScheduleReminderTime" ], "summary": "Get List of ScheduleReminderTime", "operationId": "getScheduleReminderTimes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleReminderTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleReminderTime" } } } } } } } }, "/schedule/reminderTimes/{id}": { "get": { "tags": [ "ScheduleReminderTime" ], "summary": "Get ScheduleReminderTime", "operationId": "getScheduleReminderTimesById", "parameters": [ { "name": "id", "in": "path", "description": "reminderTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleReminderTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleReminderTime" } } } } } }, "put": { "tags": [ "ScheduleReminderTime" ], "summary": "Put ScheduleReminderTime", "operationId": "putScheduleReminderTimesById", "parameters": [ { "name": "id", "in": "path", "description": "reminderTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "reminderTime", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleReminderTime" } } }, "required": true }, "responses": { "200": { "description": "ScheduleReminderTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleReminderTime" } } } } } }, "patch": { "tags": [ "ScheduleReminderTime" ], "summary": "Patch ScheduleReminderTime", "operationId": "patchScheduleReminderTimesById", "parameters": [ { "name": "id", "in": "path", "description": "reminderTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleReminderTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleReminderTime" } } } } } } }, "/schedule/reminderTimes/count": { "get": { "tags": [ "ScheduleReminderTime" ], "summary": "Get Count of ScheduleReminderTime", "operationId": "getScheduleReminderTimesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/statuses": { "get": { "tags": [ "ScheduleStatuses" ], "summary": "Get List of ScheduleStatus", "operationId": "getScheduleStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleStatus" } } } } } } }, "post": { "tags": [ "ScheduleStatuses" ], "summary": "Post ScheduleStatus", "operationId": "postScheduleStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleStatus" } } }, "required": true }, "responses": { "201": { "description": "ScheduleStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStatus" } } } } } } }, "/schedule/statuses/{id}": { "get": { "tags": [ "ScheduleStatuses" ], "summary": "Get ScheduleStatus", "operationId": "getScheduleStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStatus" } } } } } }, "delete": { "tags": [ "ScheduleStatuses" ], "summary": "Delete ScheduleStatus", "operationId": "deleteScheduleStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ScheduleStatuses" ], "summary": "Put ScheduleStatus", "operationId": "putScheduleStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleStatus" } } }, "required": true }, "responses": { "200": { "description": "ScheduleStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStatus" } } } } } }, "patch": { "tags": [ "ScheduleStatuses" ], "summary": "Patch ScheduleStatus", "operationId": "patchScheduleStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStatus" } } } } } } }, "/schedule/statuses/{id}/info": { "get": { "tags": [ "ScheduleStatusInfos" ], "summary": "Get ScheduleStatusInfos", "operationId": "getScheduleStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ScheduleStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStatusInfo" } } } } } } }, "/schedule/statuses/count": { "get": { "tags": [ "ScheduleStatuses" ], "summary": "Get Count of ScheduleStatus", "operationId": "getScheduleStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/statuses/info": { "get": { "tags": [ "ScheduleStatusInfos" ], "summary": "Get List of ScheduleStatusInfos", "operationId": "getScheduleStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of scheduleStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleStatusInfo" } } } } } } } }, "/schedule/statuses/info/count": { "get": { "tags": [ "ScheduleStatusesInfos" ], "summary": "Get Count of ScheduleStatusInfos", "operationId": "getScheduleStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/types": { "get": { "tags": [ "ScheduleTypes" ], "summary": "Get List of ScheduleType", "operationId": "getScheduleTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleType" } } } } } } }, "post": { "tags": [ "ScheduleTypes" ], "summary": "Post ScheduleType", "operationId": "postScheduleTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleType" } } }, "required": true }, "responses": { "201": { "description": "ScheduleType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleType" } } } } } } }, "/schedule/types/{id}": { "get": { "tags": [ "ScheduleTypes" ], "summary": "Get ScheduleType", "operationId": "getScheduleTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleType" } } } } } }, "delete": { "tags": [ "ScheduleTypes" ], "summary": "Delete ScheduleType", "operationId": "deleteScheduleTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ScheduleTypes" ], "summary": "Put ScheduleType", "operationId": "putScheduleTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleType" } } }, "required": true }, "responses": { "200": { "description": "ScheduleType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleType" } } } } } }, "patch": { "tags": [ "ScheduleTypes" ], "summary": "Patch ScheduleType", "operationId": "patchScheduleTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleType" } } } } } } }, "/schedule/types/{id}/info": { "get": { "tags": [ "ScheduleTypesInfo" ], "summary": "Get ScheduleTypeInfo", "operationId": "getScheduleTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleTypeInfo" } } } } } } }, "/schedule/types/{id}/usages": { "get": { "tags": [ "ScheduleTypes" ], "summary": "Get List of Usage Count", "operationId": "getScheduleTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/schedule/types/{id}/usages/list": { "get": { "tags": [ "ScheduleTypes" ], "summary": "Get List of Usage", "operationId": "getScheduleTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/schedule/types/count": { "get": { "tags": [ "ScheduleTypes" ], "summary": "Get Count of ScheduleType", "operationId": "getScheduleTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/types/info": { "get": { "tags": [ "ScheduleTypesInfo" ], "summary": "Get List of ScheduleTypeInfo", "operationId": "getScheduleTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleTypeInfo" } } } } } } } }, "/schedule/types/info/count": { "get": { "tags": [ "ScheduleTypesInfo" ], "summary": "Get Count of ScheduleTypeInfo", "operationId": "getScheduleTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards": { "get": { "tags": [ "Boards" ], "summary": "Get List of Board", "operationId": "getServiceBoards", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Board" } } } } } } }, "post": { "tags": [ "Boards" ], "summary": "Post Board", "operationId": "postServiceBoards", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "board", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "required": true }, "responses": { "201": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/service/boards/{grandparentId}/items/{parentId}/associations": { "get": { "tags": [ "BoardItemAssociations" ], "summary": "Get List of BoardItemAssociation", "operationId": "getServiceBoardsByGrandparentIdItemsByParentIdAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } } } }, "/service/boards/{grandparentId}/items/{parentId}/associations/{id}": { "get": { "tags": [ "BoardItemAssociations" ], "summary": "Get BoardItemAssociation", "operationId": "getServiceBoardsByGrandparentIdItemsByParentIdAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "associationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } }, "put": { "tags": [ "BoardItemAssociations" ], "summary": "Put BoardItemAssociation", "operationId": "putServiceBoardsByGrandparentIdItemsByParentIdAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "associationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "itemAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } }, "required": true }, "responses": { "200": { "description": "BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } }, "patch": { "tags": [ "BoardItemAssociations" ], "summary": "Patch BoardItemAssociation", "operationId": "patchServiceBoardsByGrandparentIdItemsByParentIdAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "associationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } } }, "/service/boards/{grandparentId}/items/{parentId}/associations/count": { "get": { "tags": [ "BoardItemAssociations" ], "summary": "Get Count of BoardItemAssociation", "operationId": "getServiceBoardsByGrandparentIdItemsByParentIdAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{grandparentId}/statuses/{parentId}/notifications": { "get": { "tags": [ "BoardStatusNotifications" ], "summary": "Get List of BoardStatusNotification", "operationId": "getServiceBoardsByGrandparentIdStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } } }, "post": { "tags": [ "BoardStatusNotifications" ], "summary": "Post BoardStatusNotification", "operationId": "postServiceBoardsByGrandparentIdStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } }, "required": true }, "responses": { "201": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } } }, "/service/boards/{grandparentId}/statuses/{parentId}/notifications/{id}": { "get": { "tags": [ "BoardStatusNotifications" ], "summary": "Get BoardStatusNotification", "operationId": "getServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } }, "delete": { "tags": [ "BoardStatusNotifications" ], "summary": "Delete BoardStatusNotification", "operationId": "deleteServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardStatusNotifications" ], "summary": "Put BoardStatusNotification", "operationId": "putServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } }, "required": true }, "responses": { "200": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } }, "patch": { "tags": [ "BoardStatusNotifications" ], "summary": "Patch BoardStatusNotification", "operationId": "patchServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } } }, "/service/boards/{grandparentId}/statuses/{parentId}/notifications/count": { "get": { "tags": [ "BoardStatusNotifications" ], "summary": "Get Count of BoardStatusNotification", "operationId": "getServiceBoardsByGrandparentIdStatusesByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{id}": { "get": { "tags": [ "Boards" ], "summary": "Get Board", "operationId": "getServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Board" } } } } } }, "delete": { "tags": [ "Boards" ], "summary": "Delete Board", "operationId": "deleteServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Boards" ], "summary": "Put Board", "operationId": "putServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "board", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Board" } } } } } }, "patch": { "tags": [ "Boards" ], "summary": "Patch Board", "operationId": "patchServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/service/boards/{id}/usages": { "get": { "tags": [ "Boards" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{id}/usages/list": { "get": { "tags": [ "Boards" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/autoAssignResources": { "get": { "tags": [ "BoardAutoAssignResources" ], "summary": "Get List of BoardAutoAssignResource", "operationId": "getServiceBoardsByParentIdAutoAssignResources", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } } }, "post": { "tags": [ "BoardAutoAssignResources" ], "summary": "Post BoardAutoAssignResource", "operationId": "postServiceBoardsByParentIdAutoAssignResources", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoAssignResource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } }, "required": true }, "responses": { "201": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } } }, "/service/boards/{parentId}/autoAssignResources/{id}": { "get": { "tags": [ "BoardAutoAssignResources" ], "summary": "Get BoardAutoAssignResource", "operationId": "getServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } }, "delete": { "tags": [ "BoardAutoAssignResources" ], "summary": "Delete BoardAutoAssignResource", "operationId": "deleteServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardAutoAssignResources" ], "summary": "Put BoardAutoAssignResource", "operationId": "putServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoAssignResource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } }, "required": true }, "responses": { "200": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } }, "patch": { "tags": [ "BoardAutoAssignResources" ], "summary": "Patch BoardAutoAssignResource", "operationId": "patchServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } } }, "/service/boards/{parentId}/autoAssignResources/count": { "get": { "tags": [ "BoardAutoAssignResources" ], "summary": "Get Count of BoardAutoAssignResource", "operationId": "getServiceBoardsByParentIdAutoAssignResourcesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/autoTemplates": { "get": { "tags": [ "BoardAutoTemplates" ], "summary": "Get List of BoardAutoTemplate", "operationId": "getServiceBoardsByParentIdAutoTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } } }, "post": { "tags": [ "BoardAutoTemplates" ], "summary": "Post BoardAutoTemplate", "operationId": "postServiceBoardsByParentIdAutoTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } }, "required": true }, "responses": { "201": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } } }, "/service/boards/{parentId}/autoTemplates/{id}": { "get": { "tags": [ "BoardAutoTemplates" ], "summary": "Get BoardAutoTemplate", "operationId": "getServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } }, "delete": { "tags": [ "BoardAutoTemplates" ], "summary": "Delete BoardAutoTemplate", "operationId": "deleteServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardAutoTemplates" ], "summary": "Put BoardAutoTemplate", "operationId": "putServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } }, "required": true }, "responses": { "200": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } }, "patch": { "tags": [ "BoardAutoTemplates" ], "summary": "Patch BoardAutoTemplate", "operationId": "patchServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } } }, "/service/boards/{parentId}/autoTemplates/count": { "get": { "tags": [ "BoardAutoTemplates" ], "summary": "Get Count of BoardAutoTemplate", "operationId": "getServiceBoardsByParentIdAutoTemplatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/excludedMembers": { "get": { "tags": [ "BoardExcludedMembers" ], "summary": "Get List of BoardExcludedMember", "operationId": "getServiceBoardsByParentIdExcludedMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardExcludedMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardExcludedMember" } } } } } } }, "post": { "tags": [ "BoardExcludedMembers" ], "summary": "Post BoardExcludedMember", "operationId": "postServiceBoardsByParentIdExcludedMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardExcludedMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardExcludedMember" } } }, "required": true }, "responses": { "201": { "description": "BoardExcludedMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardExcludedMember" } } } } } } }, "/service/boards/{parentId}/excludedMembers/{id}": { "get": { "tags": [ "BoardExcludedMembers" ], "summary": "Get BoardExcludedMember", "operationId": "getServiceBoardsByParentIdExcludedMembersById", "parameters": [ { "name": "id", "in": "path", "description": "excludedMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardExcludedMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardExcludedMember" } } } } } }, "delete": { "tags": [ "BoardExcludedMembers" ], "summary": "Delete BoardExcludedMember", "operationId": "deleteServiceBoardsByParentIdExcludedMembersById", "parameters": [ { "name": "id", "in": "path", "description": "excludedMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/boards/{parentId}/excludedMembers/count": { "get": { "tags": [ "BoardExcludedMembers" ], "summary": "Get Count of BoardExcludedMember", "operationId": "getServiceBoardsByParentIdExcludedMembersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/items": { "get": { "tags": [ "BoardItems" ], "summary": "Get List of BoardItem", "operationId": "getServiceBoardsByParentIdItems", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItem" } } } } } } }, "post": { "tags": [ "BoardItems" ], "summary": "Post BoardItem", "operationId": "postServiceBoardsByParentIdItems", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardItem" } } }, "required": true }, "responses": { "201": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } } }, "/service/boards/{parentId}/items/{id}": { "get": { "tags": [ "BoardItems" ], "summary": "Get BoardItem", "operationId": "getServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } }, "delete": { "tags": [ "BoardItems" ], "summary": "Delete BoardItem", "operationId": "deleteServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardItems" ], "summary": "Put BoardItem", "operationId": "putServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardItem" } } }, "required": true }, "responses": { "200": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } }, "patch": { "tags": [ "BoardItems" ], "summary": "Patch BoardItem", "operationId": "patchServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } } }, "/service/boards/{parentId}/items/{id}/usages": { "get": { "tags": [ "BoardItems" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdItemsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/items/{id}/usages/list": { "get": { "tags": [ "BoardItems" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdItemsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/items/count": { "get": { "tags": [ "BoardItems" ], "summary": "Get Count of Usage", "operationId": "getServiceBoardsByParentIdItemsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/notifications": { "get": { "tags": [ "BoardNotifications" ], "summary": "Get List of BoardNotification", "operationId": "getServiceBoardsByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardNotification" } } } } } } }, "post": { "tags": [ "BoardNotifications" ], "summary": "Post BoardNotification", "operationId": "postServiceBoardsByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } }, "required": true }, "responses": { "201": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } } }, "/service/boards/{parentId}/notifications/{id}": { "get": { "tags": [ "BoardNotifications" ], "summary": "Get BoardNotification", "operationId": "getServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } }, "delete": { "tags": [ "BoardNotifications" ], "summary": "Delete BoardNotification", "operationId": "deleteServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardNotifications" ], "summary": "Put BoardNotification", "operationId": "putServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } }, "required": true }, "responses": { "200": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } }, "patch": { "tags": [ "BoardNotifications" ], "summary": "Patch BoardNotification", "operationId": "patchServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } } }, "/service/boards/{parentId}/notifications/count": { "get": { "tags": [ "BoardNotifications" ], "summary": "Get Count of BoardNotification", "operationId": "getServiceBoardsByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/skillMappings/": { "get": { "tags": [ "BoardSkillMappings" ], "summary": "Get List of BoardSkillMappings", "operationId": "getServiceBoardsByParentIdSkillMappings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } } }, "post": { "tags": [ "BoardSkillMappings" ], "summary": "Post BoardSkillMappings", "operationId": "postServiceBoardsByParentIdSkillMappings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "BoardSkillMapping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } }, "required": true }, "responses": { "201": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } } }, "/service/boards/{parentId}/skillMappings/{id}": { "get": { "tags": [ "BoardSkillMappings" ], "summary": "Get BoardSkillMappings", "operationId": "getServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } }, "delete": { "tags": [ "BoardSkillMappings" ], "summary": "Delete BoardSkillMappings", "operationId": "deleteServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardSkillMappings" ], "summary": "Put BoardSkillMappings", "operationId": "putServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardSkillMapping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } }, "required": true }, "responses": { "200": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } }, "patch": { "tags": [ "BoardSkillMappings" ], "summary": "Patch BoardSkillMappings", "operationId": "patchServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } } }, "/service/boards/{parentId}/skillMappings/count": { "get": { "tags": [ "BoardSkillMappings" ], "summary": "Get Count of BoardSkillMappings", "operationId": "getServiceBoardsByParentIdSkillMappingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/statuses": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get List of BoardStatus", "operationId": "getServiceBoardsByParentIdStatuses", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatus" } } } } } } }, "post": { "tags": [ "BoardStatuses" ], "summary": "Post BoardStatus", "operationId": "postServiceBoardsByParentIdStatuses", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } }, "required": true }, "responses": { "201": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } } }, "/service/boards/{parentId}/statuses/{id}": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get BoardStatus", "operationId": "getServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } }, "delete": { "tags": [ "BoardStatuses" ], "summary": "Delete BoardStatus", "operationId": "deleteServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardStatuses" ], "summary": "Put BoardStatus", "operationId": "putServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } }, "required": true }, "responses": { "200": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } }, "patch": { "tags": [ "BoardStatuses" ], "summary": "Patch BoardStatus", "operationId": "patchServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } } }, "/service/boards/{parentId}/statuses/{id}/info": { "get": { "tags": [ "BoardStatusInfo" ], "summary": "Get BoardStatusInfos", "operationId": "getServiceBoardsByParentIdStatusesByIdInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "ServiceBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "StatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardStatusInfo" } } } } } } }, "/service/boards/{parentId}/statuses/{id}/usages": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/statuses/{id}/usages/list": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/statuses/count": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get Count of BoardStatus", "operationId": "getServiceBoardsByParentIdStatusesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/statuses/info": { "get": { "tags": [ "BoardStatusInfo" ], "summary": "Get List of BoardStatusInfos", "operationId": "getServiceBoardsByParentIdStatusesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "ServiceBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardStatusInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatusInfo" } } } } } } } }, "/service/boards/{parentId}/statuses/info/count": { "get": { "tags": [ "BoardStatusInfo" ], "summary": "Get Count of BoardStatusInfos", "operationId": "getServiceBoardsByParentIdStatusesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ServiceBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/subtypes": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get List of BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSubType" } } } } } } }, "post": { "tags": [ "BoardSubTypes" ], "summary": "Post BoardSubType", "operationId": "postServiceBoardsByParentIdSubtypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardSubType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } }, "required": true }, "responses": { "201": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } } }, "/service/boards/{parentId}/subtypes/{id}": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } }, "delete": { "tags": [ "BoardSubTypes" ], "summary": "Delete Usage", "operationId": "deleteServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardSubTypes" ], "summary": "Put BoardSubType", "operationId": "putServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardSubType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } }, "required": true }, "responses": { "200": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } }, "patch": { "tags": [ "BoardSubTypes" ], "summary": "Patch BoardSubType", "operationId": "patchServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } } }, "/service/boards/{parentId}/subtypes/{id}/info": { "get": { "tags": [ "BoardSubTypeInfos" ], "summary": "Get BoardSubTypeInfos", "operationId": "getServiceBoardsByParentIdSubtypesByIdInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "BoardSubTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardSubTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardSubTypeInfo" } } } } } } }, "/service/boards/{parentId}/subtypes/{id}/usages": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdSubtypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/subtypes/{id}/usages/list": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdSubtypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/subtypes/count": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get Count of BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/subtypes/info": { "get": { "tags": [ "BoardSubTypeInfos" ], "summary": "Get List of BoardSubTypeInfos", "operationId": "getServiceBoardsByParentIdSubtypesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of boardSubTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSubTypeInfo" } } } } } } } }, "/service/boards/{parentId}/subtypes/info/count": { "get": { "tags": [ "BoardSubTypeInfos" ], "summary": "Get Count of BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/teams": { "get": { "tags": [ "BoardTeams" ], "summary": "Get List of BoardTeam", "operationId": "getServiceBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTeam" } } } } } } }, "post": { "tags": [ "BoardTeams" ], "summary": "Post BoardTeam", "operationId": "postServiceBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "_boardTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } }, "required": true }, "responses": { "201": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } } }, "/service/boards/{parentId}/teams/{id}": { "get": { "tags": [ "BoardTeams" ], "summary": "Get BoardTeam", "operationId": "getServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } }, "delete": { "tags": [ "BoardTeams" ], "summary": "Delete BoardTeam", "operationId": "deleteServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardTeams" ], "summary": "Put BoardTeam", "operationId": "putServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "_boardTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } }, "required": true }, "responses": { "200": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } }, "patch": { "tags": [ "BoardTeams" ], "summary": "Patch BoardTeam", "operationId": "patchServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } } }, "/service/boards/{parentId}/teams/{id}/info": { "get": { "tags": [ "BoardTeamInfos" ], "summary": "Get BoardTeamInfos", "operationId": "getServiceBoardsByParentIdTeamsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "BoardTeamInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTeamInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTeamInfo" } } } } } } }, "/service/boards/{parentId}/teams/{id}/usages/list": { "get": { "tags": [ "BoardTeams" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdTeamsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/teams/count": { "get": { "tags": [ "BoardTeams" ], "summary": "Get Count of BoardTeam", "operationId": "getServiceBoardsByParentIdTeamsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/teams/info": { "get": { "tags": [ "BoardTeamInfos" ], "summary": "Get List of BoardTeamInfos", "operationId": "getServiceBoardsByParentIdTeamsInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of boardTeamInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTeamInfo" } } } } } } } }, "/service/boards/{parentId}/teams/info/count": { "get": { "tags": [ "BoardTeamInfos" ], "summary": "Get Count of BoardTeamInfo", "operationId": "getServiceBoardsByParentIdTeamsInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/types": { "get": { "tags": [ "BoardTypes" ], "summary": "Get List of BoardType", "operationId": "getServiceBoardsByParentIdTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardType" } } } } } } }, "post": { "tags": [ "BoardTypes" ], "summary": "Post BoardType", "operationId": "postServiceBoardsByParentIdTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardType" } } }, "required": true }, "responses": { "201": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } } }, "/service/boards/{parentId}/types/{id}": { "get": { "tags": [ "BoardTypes" ], "summary": "Get BoardType", "operationId": "getServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } }, "delete": { "tags": [ "BoardTypes" ], "summary": "Delete BoardType", "operationId": "deleteServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardTypes" ], "summary": "Put BoardType", "operationId": "putServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardType" } } }, "required": true }, "responses": { "200": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } }, "patch": { "tags": [ "BoardTypes" ], "summary": "Patch BoardType", "operationId": "patchServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } } }, "/service/boards/{parentId}/types/{id}/usages": { "get": { "tags": [ "BoardTypes" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/types/{id}/usages/list": { "get": { "tags": [ "BoardTypes" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/types/count": { "get": { "tags": [ "BoardTypes" ], "summary": "Get Count of BoardType", "operationId": "getServiceBoardsByParentIdTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/typeSubTypeItemAssociations": { "get": { "tags": [ "BoardTypeSubTypeItemAssociation" ], "summary": "Get List of BoardTypeSubTypeItemAssociation", "operationId": "getServiceBoardsByParentIdTypeSubTypeItemAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardTypeSubTypeItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTypeSubTypeItemAssociation" } } } } } } } }, "/service/boards/{parentId}/typeSubTypeItemAssociations/{id}": { "get": { "tags": [ "BoardTypeSubTypeItemAssociation" ], "summary": "Get BoardTypeSubTypeItemAssociation", "operationId": "getServiceBoardsByParentIdTypeSubTypeItemAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeSubTypeItemAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTypeSubTypeItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTypeSubTypeItemAssociation" } } } } } } }, "/service/boards/{parentId}/typeSubTypeItemAssociations/count": { "get": { "tags": [ "BoardTypeSubTypeItemAssociation" ], "summary": "Get Count of BoardTypeSubTypeItemAssociation", "operationId": "getServiceBoardsByParentIdTypeSubTypeItemAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/copy": { "post": { "tags": [ "Boards" ], "summary": "Post Board", "operationId": "postServiceBoardsCopy", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "copy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardCopy" } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/service/boards/count": { "get": { "tags": [ "Boards" ], "summary": "Get Count of Board", "operationId": "getServiceBoardsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/codes": { "get": { "tags": [ "Codes" ], "summary": "Get List of Code", "operationId": "getServiceCodes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Code", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Code" } } } } } } }, "post": { "tags": [ "Codes" ], "summary": "Post Code", "operationId": "postServiceCodes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "responses": { "201": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Code" } } } } } } }, "/service/codes/{id}": { "get": { "tags": [ "Codes" ], "summary": "Get Code", "operationId": "getServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Code" } } } } } }, "delete": { "tags": [ "Codes" ], "summary": "Delete Code", "operationId": "deleteServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Codes" ], "summary": "Put Code", "operationId": "putServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "responses": { "200": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Code" } } } } } }, "patch": { "tags": [ "Codes" ], "summary": "Patch Code", "operationId": "patchServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Code" } } } } } } }, "/service/codes/count": { "get": { "tags": [ "Codes" ], "summary": "Get Count of Code", "operationId": "getServiceCodesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/emailTemplates": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get List of ServiceEmailTemplate", "operationId": "getServiceEmailTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } } }, "post": { "tags": [ "ServiceEmailTemplates" ], "summary": "Post ServiceEmailTemplate", "operationId": "postServiceEmailTemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } }, "required": true }, "responses": { "201": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } } }, "/service/emailTemplates/{id}": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get ServiceEmailTemplate", "operationId": "getServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } }, "delete": { "tags": [ "ServiceEmailTemplates" ], "summary": "Delete ServiceEmailTemplate", "operationId": "deleteServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceEmailTemplates" ], "summary": "Put ServiceEmailTemplate", "operationId": "putServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } }, "required": true }, "responses": { "200": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } }, "patch": { "tags": [ "ServiceEmailTemplates" ], "summary": "Patch ServiceEmailTemplate", "operationId": "patchServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } } }, "/service/emailTemplates/{id}/usages": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get List of Usage Count", "operationId": "getServiceEmailTemplatesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/emailTemplates/{id}/usages/list": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get List of Usage", "operationId": "getServiceEmailTemplatesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/emailTemplates/count": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get Count of ServiceEmailTemplate", "operationId": "getServiceEmailTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/impacts": { "get": { "tags": [ "Impacts" ], "summary": "Get List of Impact", "operationId": "getServiceImpacts", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Impact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Impact" } } } } } } } }, "/service/impacts/{id}": { "get": { "tags": [ "Impacts" ], "summary": "Get Impact", "operationId": "getServiceImpactsById", "parameters": [ { "name": "id", "in": "path", "description": "impactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Impact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Impact" } } } } } }, "put": { "tags": [ "Impacts" ], "summary": "Put Impact", "operationId": "putServiceImpactsById", "parameters": [ { "name": "id", "in": "path", "description": "impactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "impact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Impact" } } }, "required": true }, "responses": { "200": { "description": "Impact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Impact" } } } } } }, "patch": { "tags": [ "Impacts" ], "summary": "Patch Impact", "operationId": "patchServiceImpactsById", "parameters": [ { "name": "id", "in": "path", "description": "impactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Impact", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Impact" } } } } } } }, "/service/impacts/count": { "get": { "tags": [ "Impacts" ], "summary": "Get Count of Impact", "operationId": "getServiceImpactsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/info/boards": { "get": { "tags": [ "BoardInfos" ], "summary": "Get List of BoardInfo", "operationId": "getServiceInfoBoards", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardInfo" } } } } } } } }, "/service/info/boards/{id}": { "get": { "tags": [ "BoardInfos" ], "summary": "Get BoardInfo", "operationId": "getServiceInfoBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardInfo" } } } } } } }, "/service/info/boards/active": { "get": { "tags": [ "BoardInfos" ], "summary": "Get List of active BoardInfo", "operationId": "getServiceInfoBoardsActive", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of active BoardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardInfo" } } } } } } } }, "/service/info/boards/count": { "get": { "tags": [ "BoardInfos" ], "summary": "Get Count of BoardInfo", "operationId": "getServiceInfoBoardsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/info/boardtypes": { "get": { "tags": [ "BoardTypeInfos" ], "summary": "Get List of BoardTypeInfo", "operationId": "getServiceInfoBoardtypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTypeInfo" } } } } } } } }, "/service/info/boardtypes/{id}": { "get": { "tags": [ "BoardTypeInfos" ], "summary": "Get BoardTypeInfo", "operationId": "getServiceInfoBoardtypesById", "parameters": [ { "name": "id", "in": "path", "description": "boardtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BoardTypeInfo" } } } } } } }, "/service/info/boardtypes/count": { "get": { "tags": [ "BoardTypeInfos" ], "summary": "Get Count of BoardTypeInfo", "operationId": "getServiceInfoBoardtypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/knowledgeBaseArticles": { "get": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Get List of KnowledgeBaseArticle", "operationId": "getServiceKnowledgeBaseArticles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } } }, "post": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Post KnowledgeBaseArticle", "operationId": "postServiceKnowledgeBaseArticles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseArticle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } } }, "/service/knowledgeBaseArticles/{id}": { "get": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Get KnowledgeBaseArticle", "operationId": "getServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } }, "delete": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Delete KnowledgeBaseArticle", "operationId": "deleteServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Put KnowledgeBaseArticle", "operationId": "putServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseArticle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } }, "patch": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Patch KnowledgeBaseArticle", "operationId": "patchServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } } }, "/service/knowledgeBaseArticles/count": { "get": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Get Count of KnowledgeBaseArticle", "operationId": "getServiceKnowledgeBaseArticlesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/knowledgeBaseCategories": { "get": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Get List of KnowledgeBaseCategory", "operationId": "getServiceKnowledgeBaseCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } } }, "post": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Post KnowledgeBaseCategory", "operationId": "postServiceKnowledgeBaseCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } } }, "/service/knowledgeBaseCategories/{id}": { "get": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Get KnowledgeBaseCategory", "operationId": "getServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } }, "delete": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Delete KnowledgeBaseCategory", "operationId": "deleteServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Put KnowledgeBaseCategory", "operationId": "putServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } }, "patch": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Patch KnowledgeBaseCategory", "operationId": "patchServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } } }, "/service/knowledgeBaseCategories/count": { "get": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Get Count of KnowledgeBaseCategory", "operationId": "getServiceKnowledgeBaseCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/knowledgebasesettings": { "get": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Get KnowledgeBaseSettings", "operationId": "getServiceKnowledgebasesettings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } }, "post": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Post KnowledgeBaseSettings", "operationId": "postServiceKnowledgebasesettings", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSettings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } } }, "/service/knowledgebasesettings/{id}": { "get": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Get KnowledgeBaseSettings", "operationId": "getServiceKnowledgebasesettingsById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgebasesettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } }, "put": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Put KnowledgeBaseSettings", "operationId": "putServiceKnowledgebasesettingsById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgebasesettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSettings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } }, "patch": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Patch KnowledgeBaseSettings", "operationId": "patchServiceKnowledgebasesettingsById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgebasesettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } } }, "/service/knowledgeBaseSubCategories": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get List of KnowledgeBaseSubCategory", "operationId": "getServiceKnowledgeBaseSubCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } } }, "post": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Post KnowledgeBaseSubCategory", "operationId": "postServiceKnowledgeBaseSubCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSubCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } } }, "/service/knowledgeBaseSubCategories/{id}": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get KnowledgeBaseSubCategory", "operationId": "getServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } }, "delete": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Delete KnowledgeBaseSubCategory", "operationId": "deleteServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Put KnowledgeBaseSubCategory", "operationId": "putServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSubCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } }, "patch": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Patch KnowledgeBaseSubCategory", "operationId": "patchServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } } }, "/service/knowledgeBaseSubCategories/{id}/usages": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get List of Usage Count", "operationId": "getServiceKnowledgeBaseSubCategoriesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/knowledgeBaseSubCategories/{id}/usages/list": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get List of Usage", "operationId": "getServiceKnowledgeBaseSubCategoriesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/knowledgeBaseSubCategories/count": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get Count of KnowledgeBaseSubCategory", "operationId": "getServiceKnowledgeBaseSubCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/locations": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get List of ServiceLocation", "operationId": "getServiceLocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceLocation" } } } } } } }, "post": { "tags": [ "ServiceLocations" ], "summary": "Post ServiceLocation", "operationId": "postServiceLocations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } }, "required": true }, "responses": { "201": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } } }, "/service/locations/{id}": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get ServiceLocation", "operationId": "getServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } }, "delete": { "tags": [ "ServiceLocations" ], "summary": "Delete ServiceLocation", "operationId": "deleteServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceLocations" ], "summary": "Put ServiceLocation", "operationId": "putServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } }, "required": true }, "responses": { "200": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } }, "patch": { "tags": [ "ServiceLocations" ], "summary": "Patch ServiceLocation", "operationId": "patchServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } } }, "/service/locations/{id}/info": { "get": { "tags": [ "ServiceLocationInfos" ], "summary": "Get ServiceLocationInfos", "operationId": "getServiceLocationsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceLocationInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceLocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceLocationInfo" } } } } } } }, "/service/locations/count": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get Count of ServiceLocation", "operationId": "getServiceLocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/locations/info": { "get": { "tags": [ "ServiceLocationInfos" ], "summary": "Get List of ServiceLocationInfos", "operationId": "getServiceLocationsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceLocationInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceLocationInfo" } } } } } } } }, "/service/locations/info/count": { "get": { "tags": [ "ServiceLocationInfos" ], "summary": "Get Count of ServiceLocationInfo", "operationId": "getServiceLocationsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/priorities": { "get": { "tags": [ "Priorities" ], "summary": "Get List of Priority", "operationId": "getServicePriorities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Priority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Priority" } } } } } } }, "post": { "tags": [ "Priorities" ], "summary": "Post Priority", "operationId": "postServicePriorities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "201": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } } }, "/service/priorities/{id}": { "get": { "tags": [ "Priorities" ], "summary": "Get Priority", "operationId": "getServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } }, "delete": { "tags": [ "Priorities" ], "summary": "Delete Priority", "operationId": "deleteServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Priorities" ], "summary": "Put Priority", "operationId": "putServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "200": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } }, "patch": { "tags": [ "Priorities" ], "summary": "Patch Priority", "operationId": "patchServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } } }, "/service/priorities/{id}/image": { "get": { "tags": [ "Priorities" ], "summary": "Get Priority", "operationId": "getServicePrioritiesByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "lastModified", "in": "path", "description": "lastModified", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/service/priorities/{id}/usages": { "get": { "tags": [ "Priorities" ], "summary": "Get List of Usage Count", "operationId": "getServicePrioritiesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/priorities/{id}/usages/list": { "get": { "tags": [ "Priorities" ], "summary": "Get List of Usage", "operationId": "getServicePrioritiesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/priorities/count": { "get": { "tags": [ "Priorities" ], "summary": "Get Count of Priority", "operationId": "getServicePrioritiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/priority/{id}/info": { "get": { "tags": [ "PriorityInfos" ], "summary": "Get PriorityInfos", "operationId": "getServicePriorityByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "PriorityInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PriorityInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PriorityInfo" } } } } } } }, "/service/priority/info": { "get": { "tags": [ "PriorityInfos" ], "summary": "Get List of PriorityInfos", "operationId": "getServicePriorityInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of priorityInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PriorityInfo" } } } } } } } }, "/service/scheduling/members/{id}/info": { "get": { "tags": [ "SchedulingMemberInfos" ], "summary": "Get SchedulingMemberInfos", "operationId": "getServiceSchedulingMembersByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SchedulingMemberInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SchedulingMemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SchedulingMemberInfo" } } } } } } }, "/service/scheduling/members/info": { "get": { "tags": [ "SchedulingMemberInfos" ], "summary": "Get List of SchedulingMemberInfos", "operationId": "getServiceSchedulingMembersInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of schedulingMemberInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SchedulingMemberInfo" } } } } } } } }, "/service/scheduling/members/info/count": { "get": { "tags": [ "SchedulingMemberInfos" ], "summary": "Get Count of RmaActionInfos", "operationId": "getServiceSchedulingMembersInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/serviceSignoff": { "get": { "tags": [ "ServiceSignoffs" ], "summary": "Get List of ServiceSignoff", "operationId": "getServiceServiceSignoff", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceSignoff", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSignoff" } } } } } } }, "post": { "tags": [ "ServiceSignoffs" ], "summary": "Post ServiceSignoff", "operationId": "postServiceServiceSignoff", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSignoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSignoff" } } }, "required": true }, "responses": { "201": { "description": "ServiceSignoff", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoff" } } } } } } }, "/service/serviceSignoff/{id}": { "get": { "tags": [ "ServiceSignoffs" ], "summary": "Get ServiceSignoff", "operationId": "getServiceServiceSignoffById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSignoff", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoff" } } } } } }, "delete": { "tags": [ "ServiceSignoffs" ], "summary": "Delete ServiceSignoff", "operationId": "deleteServiceServiceSignoffById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceSignoffs" ], "summary": "Put ServiceSignoff", "operationId": "putServiceServiceSignoffById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSignoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSignoff" } } }, "required": true }, "responses": { "200": { "description": "ServiceSignoff", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoff" } } } } } }, "patch": { "tags": [ "ServiceSignoffs" ], "summary": "Patch ServiceSignoff", "operationId": "patchServiceServiceSignoffById", "parameters": [ { "name": "id", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceSignoff", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoff" } } } } } } }, "/service/serviceSignoff/{id}/info": { "get": { "tags": [ "ServiceSignoffInfos" ], "summary": "Get ServiceSignoffInfos", "operationId": "getServiceServiceSignoffByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceSignoffInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSignoffInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoffInfo" } } } } } } }, "/service/serviceSignoff/{id}/usages": { "get": { "tags": [ "ServiceSignoffs" ], "summary": "Get List of Usage Count", "operationId": "getServiceServiceSignoffByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/serviceSignoff/{id}/usages/list": { "get": { "tags": [ "ServiceSignoffs" ], "summary": "Get List of Usage", "operationId": "getServiceServiceSignoffByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/serviceSignoff/{parentId}/signoffcustomfields": { "get": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Get List of ServiceSignoffCustomField", "operationId": "getServiceServiceSignoffByParentIdSignoffcustomfields", "parameters": [ { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceSignoffCustomField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } } } } } }, "post": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Post ServiceSignoffCustomField", "operationId": "postServiceServiceSignoffByParentIdSignoffcustomfields", "parameters": [ { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSignoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } }, "required": true }, "responses": { "201": { "description": "ServiceSignoffCustomField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } } } } } }, "/service/serviceSignoff/{parentId}/signoffcustomfields/{id}": { "get": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Get ServiceSignoffCustomField", "operationId": "getServiceServiceSignoffByParentIdSignoffcustomfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "ServiceSignoffCustomFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSignoffCustomField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } } } } }, "put": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Put ServiceSignoffCustomField", "operationId": "putServiceServiceSignoffByParentIdSignoffcustomfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "ServiceSignoffCustomFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ServiceSignoffCustomField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } }, "required": true }, "responses": { "200": { "description": "ServiceSignoffCustomField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } } } } }, "delete": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Delete ServiceSignoffCustomField", "operationId": "deleteServiceServiceSignoffByParentIdSignoffcustomfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "ServiceSignoffCustomFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "patch": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Patch ServiceSignoffCustomField", "operationId": "patchServiceServiceSignoffByParentIdSignoffcustomfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "ServiceSignoffCustomFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceSignoff", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSignoffCustomField" } } } } } } }, "/service/serviceSignoff/{parentId}/signoffcustomfields/count": { "get": { "tags": [ "ServiceSignoffCustomField" ], "summary": "Get Count of ServiceSignoffCustomField", "operationId": "getServiceServiceSignoffByParentIdSignoffcustomfieldsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "serviceSignoffId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/serviceSignoff/count": { "get": { "tags": [ "ServiceSignoffs" ], "summary": "Get Count of ServiceSignoff", "operationId": "getServiceServiceSignoffCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/serviceSignoff/info": { "get": { "tags": [ "ServiceSignoffInfos" ], "summary": "Get List of ServiceSignoffInfos", "operationId": "getServiceServiceSignoffInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceSignoffInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSignoffInfo" } } } } } } } }, "/service/serviceSignoff/info/count": { "get": { "tags": [ "ServiceSignoffInfos" ], "summary": "Get Count of ServiceSignoffInfos", "operationId": "getServiceServiceSignoffInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/severities": { "get": { "tags": [ "Severities" ], "summary": "Get List of Severity", "operationId": "getServiceSeverities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Severity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Severity" } } } } } } } }, "/service/severities/{id}": { "get": { "tags": [ "Severities" ], "summary": "Get Severity", "operationId": "getServiceSeveritiesById", "parameters": [ { "name": "id", "in": "path", "description": "severityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Severity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Severity" } } } } } }, "put": { "tags": [ "Severities" ], "summary": "Put Severity", "operationId": "putServiceSeveritiesById", "parameters": [ { "name": "id", "in": "path", "description": "severityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "severity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Severity" } } }, "required": true }, "responses": { "200": { "description": "Severity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Severity" } } } } } }, "patch": { "tags": [ "Severities" ], "summary": "Patch Severity", "operationId": "patchServiceSeveritiesById", "parameters": [ { "name": "id", "in": "path", "description": "severityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Severity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Severity" } } } } } } }, "/service/severities/count": { "get": { "tags": [ "Severities" ], "summary": "Get Count of Severity", "operationId": "getServiceSeveritiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/SLAs": { "get": { "tags": [ "SLAs" ], "summary": "Get List of SLA", "operationId": "getServiceSLAs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SLA", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SLA" } } } } } } }, "post": { "tags": [ "SLAs" ], "summary": "Post SLA", "operationId": "postServiceSLAs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLA" } } }, "required": true }, "responses": { "201": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } } }, "/service/SLAs/{id}": { "get": { "tags": [ "SLAs" ], "summary": "Get SLA", "operationId": "getServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } }, "delete": { "tags": [ "SLAs" ], "summary": "Delete SLA", "operationId": "deleteServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SLAs" ], "summary": "Put SLA", "operationId": "putServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLA" } } }, "required": true }, "responses": { "200": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } }, "patch": { "tags": [ "SLAs" ], "summary": "Patch SLA", "operationId": "patchServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } } }, "/service/slas/{id}/info": { "get": { "tags": [ "SLAInfos" ], "summary": "Get SLAInfos", "operationId": "getServiceSlasByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SLAInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SLAInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLAInfo" } } } } } } }, "/service/SLAs/{id}/usages": { "get": { "tags": [ "SLAs" ], "summary": "Get List of Usage", "operationId": "getServiceSLAsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/SLAs/{id}/usages/list": { "get": { "tags": [ "SLAs" ], "summary": "Get List of Usage", "operationId": "getServiceSLAsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/SLAs/{parentId}/priorities": { "get": { "tags": [ "SLAPriorities" ], "summary": "Get List of SLAPriority", "operationId": "getServiceSLAsByParentIdPriorities", "parameters": [ { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SLAPriority" } } } } } } }, "post": { "tags": [ "SLAPriorities" ], "summary": "Post SLAPriority", "operationId": "postServiceSLAsByParentIdPriorities", "parameters": [ { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLAPriority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } }, "required": true }, "responses": { "201": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } } }, "/service/SLAs/{parentId}/priorities/{id}": { "get": { "tags": [ "SLAPriorities" ], "summary": "Get SLAPriority", "operationId": "getServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } }, "delete": { "tags": [ "SLAPriorities" ], "summary": "Delete SLAPriority", "operationId": "deleteServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SLAPriorities" ], "summary": "Put SLAPriority", "operationId": "putServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLAPriority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } }, "required": true }, "responses": { "200": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } }, "patch": { "tags": [ "SLAPriorities" ], "summary": "Patch SLAPriority", "operationId": "patchServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } } }, "/service/SLAs/{parentId}/priorities/count": { "get": { "tags": [ "SLAPriorities" ], "summary": "Get Count of SLAPriority", "operationId": "getServiceSLAsByParentIdPrioritiesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/SLAs/count": { "get": { "tags": [ "SLAs" ], "summary": "Get Count of SLA", "operationId": "getServiceSLAsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/slas/info": { "get": { "tags": [ "SLAInfos" ], "summary": "Get List of SLAInfos", "operationId": "getServiceSlasInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of sLAInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SLAInfo" } } } } } } } }, "/service/SLAs/info/count": { "get": { "tags": [ "SLAInfos" ], "summary": "Get Count of SLAInfos", "operationId": "getServiceSLAsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/sources": { "get": { "tags": [ "Sources" ], "summary": "Get List of Source", "operationId": "getServiceSources", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Source", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Source" } } } } } } }, "post": { "tags": [ "Sources" ], "summary": "Post Source", "operationId": "postServiceSources", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "source", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "required": true }, "responses": { "201": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Source" } } } } } } }, "/service/sources/{id}": { "get": { "tags": [ "Sources" ], "summary": "Get Source", "operationId": "getServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Source" } } } } } }, "delete": { "tags": [ "Sources" ], "summary": "Delete Source", "operationId": "deleteServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Sources" ], "summary": "Put Source", "operationId": "putServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "source", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "required": true }, "responses": { "200": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Source" } } } } } }, "patch": { "tags": [ "Sources" ], "summary": "Patch Source", "operationId": "patchServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Source" } } } } } } }, "/service/sources/{id}/info": { "get": { "tags": [ "SourceInfos" ], "summary": "Get SourceInfos", "operationId": "getServiceSourcesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SourceInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SourceInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SourceInfo" } } } } } } }, "/service/sources/{id}/usages": { "get": { "tags": [ "Sources" ], "summary": "Get List of Usage Count", "operationId": "getServiceSourcesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/sources/{id}/usages/list": { "get": { "tags": [ "Sources" ], "summary": "Get List of Usage", "operationId": "getServiceSourcesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/sources/count": { "get": { "tags": [ "Sources" ], "summary": "Get Count of Source", "operationId": "getServiceSourcesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/sources/info": { "get": { "tags": [ "SourceInfos" ], "summary": "Get List of SourceInfos", "operationId": "getServiceSourcesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of sourceInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceInfo" } } } } } } } }, "/service/sources/info/count": { "get": { "tags": [ "SourceInfos" ], "summary": "Get Count of SourceInfo", "operationId": "getServiceSourcesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get List of ServiceSurvey", "operationId": "getServiceSurveys", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "post": { "tags": [ "ServiceSurveys" ], "summary": "Post ServiceSurvey", "operationId": "postServiceSurveys", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "survey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } }, "required": true }, "responses": { "201": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "/service/surveys/{grandparentId}/questions/{parentId}/options": { "get": { "tags": [ "SurveyOptions" ], "summary": "Get List of SurveyOption", "operationId": "getServiceSurveysByGrandparentIdQuestionsByParentIdOptions", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyOption" } } } } } } }, "post": { "tags": [ "SurveyOptions" ], "summary": "Post SurveyOption", "operationId": "postServiceSurveysByGrandparentIdQuestionsByParentIdOptions", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyOption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } }, "required": true }, "responses": { "201": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } } }, "/service/surveys/{grandparentId}/questions/{parentId}/options/{id}": { "get": { "tags": [ "SurveyOptions" ], "summary": "Get SurveyOption", "operationId": "getServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } }, "delete": { "tags": [ "SurveyOptions" ], "summary": "Delete SurveyOption", "operationId": "deleteServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SurveyOptions" ], "summary": "Put SurveyOption", "operationId": "putServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyOption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } }, "required": true }, "responses": { "200": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } }, "patch": { "tags": [ "SurveyOptions" ], "summary": "Patch SurveyOption", "operationId": "patchServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } } }, "/service/surveys/{grandparentId}/questions/{parentId}/options/count": { "get": { "tags": [ "SurveyOptions" ], "summary": "Get Count of SurveyOption", "operationId": "getServiceSurveysByGrandparentIdQuestionsByParentIdOptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/{id}": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get ServiceSurvey", "operationId": "getServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } }, "delete": { "tags": [ "ServiceSurveys" ], "summary": "Delete ServiceSurvey", "operationId": "deleteServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceSurveys" ], "summary": "Put ServiceSurvey", "operationId": "putServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "survey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } }, "required": true }, "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } }, "patch": { "tags": [ "ServiceSurveys" ], "summary": "Patch ServiceSurvey", "operationId": "patchServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "/service/surveys/{id}/copy": { "post": { "tags": [ "ServiceSurveys" ], "summary": "Post ServiceSurvey", "operationId": "postServiceSurveysByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "/service/surveys/{id}/usages": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get List of Usage", "operationId": "getServiceSurveysByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/surveys/{id}/usages/list": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get List of Usage", "operationId": "getServiceSurveysByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/surveys/{parentId}/questions": { "get": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Get List of ServiceSurveyQuestion", "operationId": "getServiceSurveysByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "post": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Post ServiceSurveyQuestion", "operationId": "postServiceSurveysByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSurveyQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } }, "required": true }, "responses": { "201": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "/service/surveys/{parentId}/questions/{id}": { "get": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Get ServiceSurveyQuestion", "operationId": "getServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } }, "delete": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Delete ServiceSurveyQuestion", "operationId": "deleteServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Put ServiceSurveyQuestion", "operationId": "putServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSurveyQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } }, "required": true }, "responses": { "200": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } }, "patch": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Patch ServiceSurveyQuestion", "operationId": "patchServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "/service/surveys/{parentId}/questions/{id}/copy": { "post": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Post ServiceSurveyQuestion", "operationId": "postServiceSurveysByParentIdQuestionsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "/service/surveys/{parentId}/questions/count": { "get": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Get Count of ServiceSurveyQuestion", "operationId": "getServiceSurveysByParentIdQuestionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/{parentId}/results": { "get": { "tags": [ "SurveyResults" ], "summary": "Get List of SurveyResult", "operationId": "getServiceSurveysByParentIdResults", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResult" } } } } } } }, "post": { "tags": [ "SurveyResults" ], "summary": "Post SurveyResult", "operationId": "postServiceSurveysByParentIdResults", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } }, "required": true }, "responses": { "201": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } } }, "/service/surveys/{parentId}/results/{id}": { "get": { "tags": [ "SurveyResults" ], "summary": "Get SurveyResult", "operationId": "getServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } }, "delete": { "tags": [ "SurveyResults" ], "summary": "Delete SurveyResult", "operationId": "deleteServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SurveyResults" ], "summary": "Put SurveyResult", "operationId": "putServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } }, "required": true }, "responses": { "200": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } }, "patch": { "tags": [ "SurveyResults" ], "summary": "Patch SurveyResult", "operationId": "patchServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } } }, "/service/surveys/{parentId}/results/count": { "get": { "tags": [ "SurveyResults" ], "summary": "Get Count of SurveyResult", "operationId": "getServiceSurveysByParentIdResultsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/count": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get Count of ServiceSurvey", "operationId": "getServiceSurveysCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/teamMembers": { "post": { "tags": [ "TeamMembers" ], "summary": "Post TeamMember", "operationId": "postServiceTeamMembers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMember" } } }, "required": true }, "responses": { "201": { "description": "TeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TeamMember" } } } } } } }, "/service/teams": { "get": { "tags": [ "ServiceTeams" ], "summary": "Get List of ServiceTeam", "operationId": "getServiceTeams", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTeam" } } } } } } } }, "/service/teams/{id}": { "get": { "tags": [ "ServiceTeams" ], "summary": "Get ServiceTeam", "operationId": "getServiceTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTeam", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTeam" } } } } } } }, "/service/teams/count": { "get": { "tags": [ "ServiceTeams" ], "summary": "Get Count of ServiceTeam", "operationId": "getServiceTeamsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/templates": { "get": { "tags": [ "ServiceTemplates" ], "summary": "Get List of ServiceTemplate", "operationId": "getServiceTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } } }, "/service/templates/{id}": { "get": { "tags": [ "ServiceTemplates" ], "summary": "Get ServiceTemplate", "operationId": "getServiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "/service/templates/{id}/generate": { "post": { "tags": [ "ServiceTemplates" ], "summary": "Post Count of ServiceTemplate", "operationId": "postServiceTemplatesByIdGenerate", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TemplateGeneratedCountsModel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TemplateGeneratedCountsModel" } } } } } } }, "/service/templates/{id}/info": { "get": { "tags": [ "ServiceTemplateInfos" ], "summary": "Get ServiceTemplateInfos", "operationId": "getServiceTemplatesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceTemplateInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplateInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTemplateInfo" } } } } } } }, "/service/templates/count": { "get": { "tags": [ "ServiceTemplates" ], "summary": "Get Count of ServiceTemplate", "operationId": "getServiceTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/templates/info": { "get": { "tags": [ "ServiceTemplateInfos" ], "summary": "Get List of ServiceTemplateInfos", "operationId": "getServiceTemplatesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceTemplateInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTemplateInfo" } } } } } } } }, "/service/templates/info/count": { "get": { "tags": [ "ServiceTemplateInfos" ], "summary": "Get Count of ServiceTemplateInfo", "operationId": "getServiceTemplatesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/ticketLinks": { "get": { "tags": [ "ServiceTicketLinks" ], "summary": "Get List of ServiceTicketLink", "operationId": "getServiceTicketLinks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } } }, "post": { "tags": [ "ServiceTicketLinks" ], "summary": "Post ServiceTicketLink", "operationId": "postServiceTicketLinks", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTicketLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } }, "required": true }, "responses": { "201": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } } }, "/service/ticketLinks/{id}": { "get": { "tags": [ "ServiceTicketLinks" ], "summary": "Get ServiceTicketLink", "operationId": "getServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } }, "delete": { "tags": [ "ServiceTicketLinks" ], "summary": "Delete ServiceTicketLink", "operationId": "deleteServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceTicketLinks" ], "summary": "Put ServiceTicketLink", "operationId": "putServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTicketLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } }, "required": true }, "responses": { "200": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } }, "patch": { "tags": [ "ServiceTicketLinks" ], "summary": "Patch ServiceTicketLink", "operationId": "patchServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } } }, "/service/ticketLinks/{id}/info": { "get": { "tags": [ "ServiceTicketLinkInfos" ], "summary": "Get ServiceTicketLinkInfos", "operationId": "getServiceTicketLinksByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceTicketLinkInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTicketLinkInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTicketLinkInfo" } } } } } } }, "/service/ticketLinks/count": { "get": { "tags": [ "ServiceTicketLinks" ], "summary": "Get Count of ServiceTicketLink", "operationId": "getServiceTicketLinksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/ticketLinks/info": { "get": { "tags": [ "ServiceTicketLinkInfos" ], "summary": "Get List of ServiceTicketLinkInfos", "operationId": "getServiceTicketLinksInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceTicketLinkInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketLinkInfo" } } } } } } } }, "/service/ticketLinks/info/count": { "get": { "tags": [ "ServiceTicketLinkInfos" ], "summary": "Get Count of ServiceTicketLinkInfos", "operationId": "getServiceTicketLinksInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "operationId": "getServiceTickets", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Post Ticket", "operationId": "postServiceTickets", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } }, "required": true }, "responses": { "201": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/service/tickets/{id}": { "get": { "tags": [ "Tickets" ], "summary": "Get Ticket", "operationId": "getServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Delete Ticket", "operationId": "deleteServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Tickets" ], "summary": "Put Ticket", "operationId": "putServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } }, "required": true }, "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } }, "patch": { "tags": [ "Tickets" ], "summary": "Patch Ticket", "operationId": "patchServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/service/tickets/{id}/copy": { "post": { "tags": [ "Tickets" ], "summary": "Post TicketCopy", "operationId": "postServiceTicketsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/service/tickets/{id}/info": { "get": { "tags": [ "TicketInfos" ], "summary": "Get TicketInfos", "operationId": "getServiceTicketsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "TicketInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketInfo" } } } } } } }, "/service/tickets/{parentId}/activities": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ActivityReference\r\n Gets activities associated to the ticket\r\n Please use the /sales/activities?conditions=ticket/id={id} endpoint", "operationId": "getServiceTicketsByParentIdActivities", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityReference" } } } } } } } }, "/service/tickets/{parentId}/activities/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ActivityReference\r\n Gets count of activities associated to the ticket\r\n Please use the /sales/activities/count?conditions=ticket/id={id} endpoint", "operationId": "getServiceTicketsByParentIdActivitiesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/allNotes": { "get": { "tags": [ "ServiceTicketNotes" ], "summary": "Get List of ServiceTicketNote", "operationId": "getServiceTicketsByParentIdAllNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketNote" } } } } } } } }, "/service/tickets/{parentId}/attachChildren": { "post": { "tags": [ "Tickets" ], "summary": "Post SuccessResponse", "operationId": "postServiceTicketsByParentIdAttachChildren", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "bundle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBundle" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/service/tickets/{parentId}/configurations": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ConfigurationReference", "operationId": "getServiceTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Post ConfigurationReference", "operationId": "postServiceTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "/service/tickets/{parentId}/configurations/{id}": { "get": { "tags": [ "Tickets" ], "summary": "Get ConfigurationReference", "operationId": "getServiceTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Delete ConfigurationReference", "operationId": "deleteServiceTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/tickets/{parentId}/configurations/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ConfigurationReference", "operationId": "getServiceTicketsByParentIdConfigurationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/convert": { "post": { "tags": [ "Tickets" ], "summary": "Post SuccessResponse", "operationId": "postServiceTicketsByParentIdConvert", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertToProject" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/service/tickets/{parentId}/documents": { "get": { "tags": [ "Tickets" ], "summary": "Get List of DocumentReference\r\n Gets the documents associated to the ticket\r\n Please use the /system/documents?recordType=Ticket&recordId={id} endpoint", "operationId": "getServiceTicketsByParentIdDocuments", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } } } } }, "/service/tickets/{parentId}/documents/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of DocumentReference", "operationId": "getServiceTicketsByParentIdDocumentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/merge": { "post": { "tags": [ "Tickets" ], "summary": "Post SuccessResponse", "operationId": "postServiceTicketsByParentIdMerge", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "merge", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketMerge" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/service/tickets/{parentId}/notes": { "get": { "tags": [ "TicketNotes" ], "summary": "Get List of ServiceNote", "operationId": "getServiceTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceNote" } } } } } } }, "post": { "tags": [ "TicketNotes" ], "summary": "Post ServiceNote", "operationId": "postServiceTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } }, "required": true }, "responses": { "201": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } } }, "/service/tickets/{parentId}/notes/{id}": { "get": { "tags": [ "TicketNotes" ], "summary": "Get ServiceNote", "operationId": "getServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } }, "delete": { "tags": [ "TicketNotes" ], "summary": "Delete ServiceNote", "operationId": "deleteServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketNotes" ], "summary": "Put ServiceNote", "operationId": "putServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } }, "required": true }, "responses": { "200": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } }, "patch": { "tags": [ "TicketNotes" ], "summary": "Patch ServiceNote", "operationId": "patchServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } } }, "/service/tickets/{parentId}/notes/count": { "get": { "tags": [ "TicketNotes" ], "summary": "Get Count of ServiceNote", "operationId": "getServiceTicketsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/products": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdProducts", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReference" } } } } } } } }, "/service/tickets/{parentId}/products/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products/count?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdProductsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/scheduleentries": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ScheduleEntryReference\r\n Gets the schedule entries associated to the ticket\r\n Please use the /schedule/entries?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getServiceTicketsByParentIdScheduleentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntryReference" } } } } } } } }, "/service/tickets/{parentId}/scheduleentries/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ScheduleEntryReference\r\n Gets the schedule entries count associated to the ticket\r\n Please use the /schedule/entries/count?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getServiceTicketsByParentIdScheduleentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/tasks": { "get": { "tags": [ "TicketTasks" ], "summary": "Get List of Task", "operationId": "getServiceTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Task", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTask" } } } } } } }, "post": { "tags": [ "TicketTasks" ], "summary": "Post Task", "operationId": "postServiceTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } }, "required": true }, "responses": { "201": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } } }, "/service/tickets/{parentId}/tasks/{id}": { "get": { "tags": [ "TicketTasks" ], "summary": "Get Task", "operationId": "getServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } }, "delete": { "tags": [ "TicketTasks" ], "summary": "Delete Task", "operationId": "deleteServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketTasks" ], "summary": "Put Task", "operationId": "putServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } }, "required": true }, "responses": { "200": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } }, "patch": { "tags": [ "TicketTasks" ], "summary": "Patch Task", "operationId": "patchServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } } }, "/service/tickets/{parentId}/tasks/count": { "get": { "tags": [ "TicketTasks" ], "summary": "Get Count of Task", "operationId": "getServiceTicketsByParentIdTasksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/timeentries": { "get": { "tags": [ "Tickets" ], "summary": "Get List of TimeEntryReference\r\n Gets time entries associated to the ticket\r\n Please use the /time/entries?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdTimeentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryReference" } } } } } } } }, "/service/tickets/{parentId}/timeentries/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of TimeEntryReference\r\n Gets time entries count associated to the ticket\r\n Please use the /time/entries/count?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdTimeentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/calculateSla": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket with SLA calculated", "operationId": "getServiceTicketsCalculateSla", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } } }, "/service/tickets/changelogs": { "get": { "tags": [ "TicketChangeLog" ], "summary": "Get List of Ticket Change Log", "operationId": "getServiceTicketsChangelogs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketChangeLog", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketChangeLog" } } } } } } }, "delete": { "tags": [ "TicketChangeLog" ], "summary": "Delete Ticket Change Logs", "operationId": "deleteServiceTicketsChangelogs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/tickets/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "operationId": "getServiceTicketsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/info": { "get": { "tags": [ "TicketInfos" ], "summary": "Get List of TicketInfos", "operationId": "getServiceTicketsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ticketInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketInfo" } } } } } } } }, "/service/tickets/info/count": { "get": { "tags": [ "TicketInfos" ], "summary": "Get Count of TicketInfo", "operationId": "getServiceTicketsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/search": { "post": { "tags": [ "Tickets" ], "summary": "Post List of Ticket", "operationId": "postServiceTicketsSearch", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "filterValues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterValues" } } }, "required": true }, "responses": { "200": { "description": "List of Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } } }, "/service/ticketSyncs": { "get": { "tags": [ "TicketSyncs" ], "summary": "Get List of TicketSync", "operationId": "getServiceTicketSyncs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSync" } } } } } } }, "post": { "tags": [ "TicketSyncs" ], "summary": "Post TicketSync", "operationId": "postServiceTicketSyncs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketSync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSync" } } }, "required": true }, "responses": { "201": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } } }, "/service/ticketSyncs/{id}": { "get": { "tags": [ "TicketSyncs" ], "summary": "Get TicketSync", "operationId": "getServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } }, "delete": { "tags": [ "TicketSyncs" ], "summary": "Delete TicketSync", "operationId": "deleteServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketSyncs" ], "summary": "Put TicketSync", "operationId": "putServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketSync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSync" } } }, "required": true }, "responses": { "200": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } }, "patch": { "tags": [ "TicketSyncs" ], "summary": "Patch TicketSync", "operationId": "patchServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } } }, "/service/ticketSyncs/count": { "get": { "tags": [ "TicketSyncs" ], "summary": "Get Count of TicketSync", "operationId": "getServiceTicketSyncsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/allowedfiletypes/": { "get": { "tags": [ "AllowedFileType" ], "summary": "Get List of AllowedFileType", "operationId": "getSystemAllowedfiletypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AllowedFileType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllowedFileType" } } } } } } } }, "/system/AllowedFileTypes/": { "post": { "tags": [ "AllowedFileType" ], "summary": "Post AllowedFileType", "operationId": "postSystemAllowedFileTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "allowedFileType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedFileType" } } }, "required": true }, "responses": { "201": { "description": "AllowedFileType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedFileType" } } } } } } }, "/system/allowedfiletypes/{id}": { "get": { "tags": [ "AllowedFileType" ], "summary": "Get AllowedFileType", "operationId": "getSystemAllowedfiletypesById", "parameters": [ { "name": "id", "in": "path", "description": "allowedfiletypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AllowedFileType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedFileType" } } } } } }, "delete": { "tags": [ "AllowedFileType" ], "summary": "Delete AllowedFileType", "operationId": "deleteSystemAllowedfiletypesById", "parameters": [ { "name": "id", "in": "path", "description": "allowedfiletypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AllowedFileType" ], "summary": "Put AllowedFileType", "operationId": "putSystemAllowedfiletypesById", "parameters": [ { "name": "id", "in": "path", "description": "allowedFileTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "AllowedFileType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedFileType" } } }, "required": true }, "responses": { "200": { "description": "allowedFileType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedFileType" } } } } } }, "patch": { "tags": [ "AllowedFileType" ], "summary": "Patch AllowedFileType", "operationId": "patchSystemAllowedfiletypesById", "parameters": [ { "name": "id", "in": "path", "description": "allowedFileTypesId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AllowedFileType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedFileType" } } } } } } }, "/system/allowedfiletypes/count": { "get": { "tags": [ "AllowedFileType" ], "summary": "Get Count of AllowedFileType", "operationId": "getSystemAllowedfiletypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/allowedorigins": { "get": { "tags": [ "AllowedOrigins" ], "summary": "Get List of AllowedOrigin", "operationId": "getSystemAllowedorigins", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AllowedOrigin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AllowedOrigin" } } } } } } }, "post": { "tags": [ "AllowedOrigins" ], "summary": "Post AllowedOrigin", "operationId": "postSystemAllowedorigins", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedOrigin" } } }, "required": true }, "responses": { "201": { "description": "AllowedOrigin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedOrigin" } } } } } } }, "/system/allowedorigins/{id}": { "get": { "tags": [ "AllowedOrigins" ], "summary": "Get AllowedOrigin", "operationId": "getSystemAllowedoriginsById", "parameters": [ { "name": "id", "in": "path", "description": "allowedoriginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AllowedOrigin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedOrigin" } } } } } }, "delete": { "tags": [ "AllowedOrigins" ], "summary": "Delete AllowedOrigin", "operationId": "deleteSystemAllowedoriginsById", "parameters": [ { "name": "id", "in": "path", "description": "allowedoriginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AllowedOrigins" ], "summary": "Put AllowedOrigin", "operationId": "putSystemAllowedoriginsById", "parameters": [ { "name": "id", "in": "path", "description": "allowedoriginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedOrigin" } } }, "required": true }, "responses": { "200": { "description": "AllowedOrigin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedOrigin" } } } } } }, "patch": { "tags": [ "AllowedOrigins" ], "summary": "Patch AllowedOrigin", "operationId": "patchSystemAllowedoriginsById", "parameters": [ { "name": "id", "in": "path", "description": "allowedoriginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AllowedOrigin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AllowedOrigin" } } } } } } }, "/system/allowedorigins/count": { "get": { "tags": [ "AllowedOrigins" ], "summary": "Get Count of AllowedOrigin", "operationId": "getSystemAllowedoriginsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/apiMembers": { "get": { "tags": [ "ApiMembers" ], "summary": "Get List of ApiMember", "operationId": "getSystemApiMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "post": { "tags": [ "ApiMembers" ], "summary": "Post ApiMember", "operationId": "postSystemApiMembers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "apiMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiMember" } } }, "required": true }, "responses": { "201": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "/system/apiMembers/{id}": { "get": { "tags": [ "ApiMembers" ], "summary": "Get ApiMember", "operationId": "getSystemApiMembersById", "parameters": [ { "name": "id", "in": "path", "description": "apiMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } }, "put": { "tags": [ "ApiMembers" ], "summary": "Put ApiMember", "operationId": "putSystemApiMembersById", "parameters": [ { "name": "id", "in": "path", "description": "apiMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "apiMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiMember" } } }, "required": true }, "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } }, "patch": { "tags": [ "ApiMembers" ], "summary": "Patch ApiMember", "operationId": "patchSystemApiMembersById", "parameters": [ { "name": "id", "in": "path", "description": "apiMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "/system/apiMembers/count": { "get": { "tags": [ "ApiMembers" ], "summary": "Get Count of", "operationId": "getSystemApiMembersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/apiMembers/default": { "get": { "tags": [ "ApiMembers" ], "summary": "Get ApiMember", "operationId": "getSystemApiMembersDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "/system/audittrail": { "get": { "tags": [ "AuditTrail" ], "summary": "Get List of AuditTrailEntry", "operationId": "getSystemAudittrail", "parameters": [ { "name": "type", "in": "query", "description": "type", "schema": { "enum": [ "None", "Ticket", "Contact", "Company", "Opportunity", "Time", "Activity", "ProductCatalog", "ProjectTicket", "Purchasing", "Configuration", "Schedule", "Agreement", "AgreementAddition", "Project", "Invoice", "PurchaseOrder", "Expense", "ProductItem", "Survey", "Member", "PurchaseOrderLineItem" ], "type": "string" } }, { "name": "id", "in": "query", "description": "id", "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceIdentifier", "in": "query", "description": "deviceIdentifier", "schema": { "type": "string" } }, { "name": "xrefRecId", "in": "query", "description": "xrefRecId", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AuditTrailEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditTrailEntry" } } } } } } } }, "/system/audittrail/count": { "get": { "tags": [ "AuditTrail" ], "summary": "Get Count of AuditTrailEntry", "operationId": "getSystemAudittrailCount", "parameters": [ { "name": "type", "in": "query", "description": "type", "schema": { "enum": [ "None", "Ticket", "Contact", "Company", "Opportunity", "Time", "Activity", "ProductCatalog", "ProjectTicket", "Purchasing", "Configuration", "Schedule", "Agreement", "AgreementAddition", "Project", "Invoice", "PurchaseOrder", "Expense", "ProductItem", "Survey", "Member", "PurchaseOrderLineItem" ], "type": "string" } }, { "name": "id", "in": "query", "description": "id", "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceIdentifier", "in": "query", "description": "deviceIdentifier", "schema": { "type": "string" } }, { "name": "xrefRecId", "in": "query", "description": "xrefRecId", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/authAnvils": { "get": { "tags": [ "AuthAnvils" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "operationId": "getSystemAuthAnvils", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuthAnvil" } } } } } } } }, "/system/authAnvils/{id}": { "get": { "tags": [ "AuthAnvils" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "operationId": "getSystemAuthAnvilsById", "parameters": [ { "name": "id", "in": "path", "description": "authAnvilId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AuthAnvil" } } } } } }, "put": { "tags": [ "AuthAnvils" ], "summary": "Put ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "operationId": "putSystemAuthAnvilsById", "parameters": [ { "name": "id", "in": "path", "description": "authAnvilId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "authAnvil", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthAnvil" } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AuthAnvil" } } } } } }, "patch": { "tags": [ "AuthAnvils" ], "summary": "Patch ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "operationId": "patchSystemAuthAnvilsById", "parameters": [ { "name": "id", "in": "path", "description": "authAnvilId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.System.AuthAnvil.AuthAnvil", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AuthAnvil" } } } } } } }, "/system/authAnvils/count": { "get": { "tags": [ "AuthAnvils" ], "summary": "Get Count of SuccessResponse", "operationId": "getSystemAuthAnvilsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/authAnvils/testConnection": { "get": { "tags": [ "AuthAnvils" ], "summary": "Get SuccessResponse", "operationId": "getSystemAuthAnvilsTestConnection", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/autoSyncTime": { "get": { "tags": [ "AutoSyncTimes" ], "summary": "Get List of AutoSyncTime", "operationId": "getSystemAutoSyncTime", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AutoSyncTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutoSyncTime" } } } } } } }, "post": { "tags": [ "AutoSyncTimes" ], "summary": "Post AutoSyncTime", "operationId": "postSystemAutoSyncTime", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "autoSyncTime", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoSyncTime" } } }, "required": true }, "responses": { "201": { "description": "AutoSyncTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AutoSyncTime" } } } } } } }, "/system/autoSyncTime/{id}": { "get": { "tags": [ "AutoSyncTimes" ], "summary": "Get AutoSyncTime", "operationId": "getSystemAutoSyncTimeById", "parameters": [ { "name": "id", "in": "path", "description": "autoSyncTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AutoSyncTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AutoSyncTime" } } } } } }, "delete": { "tags": [ "AutoSyncTimes" ], "summary": "Delete AutoSyncTime", "operationId": "deleteSystemAutoSyncTimeById", "parameters": [ { "name": "id", "in": "path", "description": "autoSyncTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AutoSyncTimes" ], "summary": "Put AutoSyncTime", "operationId": "putSystemAutoSyncTimeById", "parameters": [ { "name": "id", "in": "path", "description": "autoSyncTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "autoSyncTime", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoSyncTime" } } }, "required": true }, "responses": { "200": { "description": "AutoSyncTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AutoSyncTime" } } } } } }, "patch": { "tags": [ "AutoSyncTimes" ], "summary": "Patch AutoSyncTime", "operationId": "patchSystemAutoSyncTimeById", "parameters": [ { "name": "id", "in": "path", "description": "autoSyncTimeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AutoSyncTime", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/AutoSyncTime" } } } } } } }, "/system/autoSyncTime/count": { "get": { "tags": [ "AutoSyncTimes" ], "summary": "Get Count of AutoSyncTime", "operationId": "getSystemAutoSyncTimeCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/BillableOptions/info": { "get": { "tags": [ "BillableOptionsInfos" ], "summary": "Get List of BillableOptionsInfos", "operationId": "getSystemBillableOptionsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of billableOptionsInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillableOptionsInfo" } } } } } } } }, "/system/bundles": { "post": { "tags": [ "Bundles" ], "summary": "Post BundleResultsCollection", "operationId": "postSystemBundles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BundleRequestsCollection" } } }, "required": true }, "responses": { "200": { "description": "BundleResultsCollection", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BundleResultsCollection" } } } } } } }, "/system/bundles/count": { "post": { "tags": [ "Bundles" ], "summary": "Post BundleResultsCollection", "operationId": "postSystemBundlesCount", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BundleRequestsCollection" } } }, "required": true }, "responses": { "200": { "description": "BundleResultsCollection", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BundleResultsCollection" } } } } } } }, "/system/callbacks": { "get": { "tags": [ "CallbackEntries" ], "summary": "Get List of CallbackEntry", "operationId": "getSystemCallbacks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackEntry" } } } } } } }, "post": { "tags": [ "CallbackEntries" ], "summary": "Post CallbackEntry", "operationId": "postSystemCallbacks", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "callbackEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } }, "required": true }, "responses": { "201": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } } }, "/system/callbacks/{id}": { "get": { "tags": [ "CallbackEntries" ], "summary": "Get CallbackEntry", "operationId": "getSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } }, "delete": { "tags": [ "CallbackEntries" ], "summary": "Delete CallbackEntry", "operationId": "deleteSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CallbackEntries" ], "summary": "Put CallbackEntry", "operationId": "putSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "callbackEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } }, "required": true }, "responses": { "200": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } }, "patch": { "tags": [ "CallbackEntries" ], "summary": "Patch CallbackEntry", "operationId": "patchSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } } }, "/system/callbacks/count": { "get": { "tags": [ "CallbackEntries" ], "summary": "Get Count of CallbackEntry", "operationId": "getSystemCallbacksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/certifications": { "get": { "tags": [ "Certifications" ], "summary": "Get List of Certification", "operationId": "getSystemCertifications", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Certification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Certification" } } } } } } }, "post": { "tags": [ "Certifications" ], "summary": "Post Certification", "operationId": "postSystemCertifications", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "certification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certification" } } }, "required": true }, "responses": { "201": { "description": "Certification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Certification" } } } } } } }, "/system/certifications/{id}": { "get": { "tags": [ "Certifications" ], "summary": "Get Certification", "operationId": "getSystemCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Certification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Certification" } } } } } }, "delete": { "tags": [ "Certifications" ], "summary": "Delete Usage", "operationId": "deleteSystemCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Certifications" ], "summary": "Put Certification", "operationId": "putSystemCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "certification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certification" } } }, "required": true }, "responses": { "200": { "description": "Certification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Certification" } } } } } }, "patch": { "tags": [ "Certifications" ], "summary": "Patch Certification", "operationId": "patchSystemCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Certification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Certification" } } } } } } }, "/system/certifications/{id}/usages": { "get": { "tags": [ "Certifications" ], "summary": "Get List of Usage Count", "operationId": "getSystemCertificationsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/certifications/{id}/usages/list": { "get": { "tags": [ "Certifications" ], "summary": "Get List of Usage", "operationId": "getSystemCertificationsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/certifications/count": { "get": { "tags": [ "Certifications" ], "summary": "Get Count of Certification", "operationId": "getSystemCertificationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/connectWiseHostedScreens": { "get": { "tags": [ "ConnectWiseHostedScreens" ], "summary": "Get List of ConnectWiseHostedScreen", "operationId": "getSystemConnectWiseHostedScreens", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWiseHostedScreen", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectWiseHostedScreen" } } } } } } } }, "/system/connectWiseHostedScreens/{id}": { "get": { "tags": [ "ConnectWiseHostedScreens" ], "summary": "Get ConnectWiseHostedScreen", "operationId": "getSystemConnectWiseHostedScreensById", "parameters": [ { "name": "id", "in": "path", "description": "connectWiseHostedScreenId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWiseHostedScreen", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedScreen" } } } } } } }, "/system/connectWiseHostedScreens/count": { "get": { "tags": [ "ConnectWiseHostedScreens" ], "summary": "Get Count of ConnectWiseHostedScreen", "operationId": "getSystemConnectWiseHostedScreensCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/connectwisehostedsetups": { "get": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Get List of ConnectWiseHostedSetup", "operationId": "getSystemConnectwisehostedsetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWiseHostedSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } } } } } }, "post": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Post ConnectWiseHostedSetup", "operationId": "postSystemConnectwisehostedsetups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "connectWiseHostedSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } }, "required": true }, "responses": { "201": { "description": "ConnectWiseHostedSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } } } } } }, "/system/connectwisehostedsetups/{id}": { "get": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Get ConnectWiseHostedSetup", "operationId": "getSystemConnectwisehostedsetupsById", "parameters": [ { "name": "id", "in": "path", "description": "connectwisehostedsetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWiseHostedSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } } } } }, "delete": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Delete ConnectWiseHostedSetup", "operationId": "deleteSystemConnectwisehostedsetupsById", "parameters": [ { "name": "id", "in": "path", "description": "connectwisehostedsetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Put ConnectWiseHostedSetup", "operationId": "putSystemConnectwisehostedsetupsById", "parameters": [ { "name": "id", "in": "path", "description": "connectwisehostedsetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "connectWiseHostedSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } }, "required": true }, "responses": { "200": { "description": "ConnectWiseHostedSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } } } } }, "patch": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Patch ConnectWiseHostedSetup", "operationId": "patchSystemConnectwisehostedsetupsById", "parameters": [ { "name": "id", "in": "path", "description": "connectwisehostedsetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConnectWiseHostedSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ConnectWiseHostedSetup" } } } } } } }, "/system/connectwisehostedsetups/count": { "get": { "tags": [ "ConnectWiseHostedSetups" ], "summary": "Get Count of ConnectWiseHostedSetup", "operationId": "getSystemConnectwisehostedsetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/contactsync/monitoring": { "get": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Get List of M365ContactSyncMonitorings", "operationId": "getSystemContactsyncMonitoring", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of M365ContactSyncMonitorings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/M365ContactSyncMonitoring" } } } } } } } }, "/system/contactsync/monitoring/": { "post": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Create Async", "operationId": "postSystemContactsyncMonitoring", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "M365ContactSyncMonitoring", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncMonitoring" } } } } } }, "patch": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Update Async", "operationId": "patchSystemContactsyncMonitoring", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "M365ContactSyncMonitoring", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncMonitoring" } } } } } } }, "/system/contactsync/monitoring/{id}": { "get": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Get M365ContactSyncMonitorings", "operationId": "getSystemContactsyncMonitoringById", "parameters": [ { "name": "id", "in": "path", "description": "M365ContactSyncMonitoringId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "M365ContactSyncMonitoring", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncMonitoring" } } } } } } }, "/system/contactsync/monitoring/count": { "get": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Get Count of M365ContactSyncMonitorings", "operationId": "getSystemContactsyncMonitoringCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/contactsync/monitoring/notificationtype/": { "get": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Get M365ContactSyncMonitoringNotification TypeId Async", "operationId": "getSystemContactsyncMonitoringNotificationtype", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "M365ContactSyncMonitoring", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncMonitoring" } } } } } } }, "/system/contactsync/monitoring/type/{id}": { "get": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Get M365ContactSyncMonitoring By TypeId Async", "operationId": "getSystemContactsyncMonitoringTypeById", "parameters": [ { "name": "id", "in": "path", "description": "M365ContactSyncMonitoringId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "M365ContactSyncMonitoring", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncMonitoring" } } } } } }, "delete": { "tags": [ "M365ContactSyncMonitorings" ], "summary": "Delete Async", "operationId": "deleteSystemContactsyncMonitoringTypeById", "parameters": [ { "name": "id", "in": "path", "description": "M365ContactSyncMonitoringId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" } } } }, "/system/customReports": { "get": { "tags": [ "CustomReports" ], "summary": "Get List of CustomReport", "operationId": "getSystemCustomReports", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CustomReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReport" } } } } } } }, "post": { "tags": [ "CustomReports" ], "summary": "Post CustomReport", "operationId": "postSystemCustomReports", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customReport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReport" } } }, "required": true }, "responses": { "201": { "description": "CustomReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } } } } }, "/system/customReports/{id}": { "get": { "tags": [ "CustomReports" ], "summary": "Get CustomReport", "operationId": "getSystemCustomReportsById", "parameters": [ { "name": "id", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CustomReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } } } }, "delete": { "tags": [ "CustomReports" ], "summary": "Delete CustomReport", "operationId": "deleteSystemCustomReportsById", "parameters": [ { "name": "id", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CustomReports" ], "summary": "Put CustomReport", "operationId": "putSystemCustomReportsById", "parameters": [ { "name": "id", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customReport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReport" } } }, "required": true }, "responses": { "200": { "description": "CustomReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } } } }, "patch": { "tags": [ "CustomReports" ], "summary": "Patch CustomReport", "operationId": "patchSystemCustomReportsById", "parameters": [ { "name": "id", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CustomReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } } } } }, "/system/customReports/{parentId}/parameters": { "get": { "tags": [ "CustomReportParameters" ], "summary": "Get List of CustomReportParameter", "operationId": "getSystemCustomReportsByParentIdParameters", "parameters": [ { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CustomReportParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReportParameter" } } } } } } }, "post": { "tags": [ "CustomReportParameters" ], "summary": "Post CustomReportParameter", "operationId": "postSystemCustomReportsByParentIdParameters", "parameters": [ { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customReportParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportParameter" } } }, "required": true }, "responses": { "201": { "description": "CustomReportParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReportParameter" } } } } } } }, "/system/customReports/{parentId}/parameters/{id}": { "get": { "tags": [ "CustomReportParameters" ], "summary": "Get CustomReportParameter", "operationId": "getSystemCustomReportsByParentIdParametersById", "parameters": [ { "name": "id", "in": "path", "description": "parameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CustomReportParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReportParameter" } } } } } }, "delete": { "tags": [ "CustomReportParameters" ], "summary": "Delete CustomReportParameter", "operationId": "deleteSystemCustomReportsByParentIdParametersById", "parameters": [ { "name": "id", "in": "path", "description": "parameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CustomReportParameters" ], "summary": "Put CustomReportParameter", "operationId": "putSystemCustomReportsByParentIdParametersById", "parameters": [ { "name": "id", "in": "path", "description": "parameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customReportParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportParameter" } } }, "required": true }, "responses": { "200": { "description": "CustomReportParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReportParameter" } } } } } }, "patch": { "tags": [ "CustomReportParameters" ], "summary": "Patch CustomReportParameter", "operationId": "patchSystemCustomReportsByParentIdParametersById", "parameters": [ { "name": "id", "in": "path", "description": "parameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CustomReportParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CustomReportParameter" } } } } } } }, "/system/customReports/{parentId}/parameters/count": { "get": { "tags": [ "CustomReportParameters" ], "summary": "Get Count of CustomReportParameter", "operationId": "getSystemCustomReportsByParentIdParametersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "customReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/customReports/count": { "get": { "tags": [ "CustomReports" ], "summary": "Get Count of CustomReport", "operationId": "getSystemCustomReportsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/cwTimeZones": { "get": { "tags": [ "CwTimeZones" ], "summary": "Get List of CwTimeZone", "operationId": "getSystemCwTimeZones", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CwTimeZone", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CwTimeZone" } } } } } } } }, "/system/cwTimeZones/{id}": { "get": { "tags": [ "CwTimeZones" ], "summary": "Get CwTimeZone", "operationId": "getSystemCwTimeZonesById", "parameters": [ { "name": "id", "in": "path", "description": "cwTimeZoneId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CwTimeZone", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CwTimeZone" } } } } } } }, "/system/cwTimeZones/count": { "get": { "tags": [ "CwTimeZones" ], "summary": "Get Count of CwTimeZone", "operationId": "getSystemCwTimeZonesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/departments": { "get": { "tags": [ "Departments" ], "summary": "Get List of Department", "operationId": "getSystemDepartments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Department", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } } } } }, "post": { "tags": [ "Departments" ], "summary": "Post Department", "operationId": "postSystemDepartments", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "department", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Department" } } }, "required": true }, "responses": { "201": { "description": "Department", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Department" } } } } } } }, "/system/departments/{id}": { "get": { "tags": [ "Departments" ], "summary": "Get Department", "operationId": "getSystemDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Department", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Department" } } } } } }, "delete": { "tags": [ "Departments" ], "summary": "Delete Department", "operationId": "deleteSystemDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Departments" ], "summary": "Put Department", "operationId": "putSystemDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "department", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Department" } } }, "required": true }, "responses": { "200": { "description": "Department", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Department" } } } } } }, "patch": { "tags": [ "Departments" ], "summary": "Patch Department", "operationId": "patchSystemDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Department", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Department" } } } } } } }, "/system/departments/{id}/usages": { "get": { "tags": [ "Departments" ], "summary": "Get List of Usage", "operationId": "getSystemDepartmentsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/departments/{id}/usages/list": { "get": { "tags": [ "Departments" ], "summary": "Get List of Usage", "operationId": "getSystemDepartmentsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/departments/{parentId}/locations": { "get": { "tags": [ "DepartmentLocations" ], "summary": "Get List of DepartmentLocation", "operationId": "getSystemDepartmentsByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DepartmentLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentLocation" } } } } } } }, "post": { "tags": [ "DepartmentLocations" ], "summary": "Post DepartmentLocation", "operationId": "postSystemDepartmentsByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "departmentLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentLocation" } } }, "required": true }, "responses": { "201": { "description": "DepartmentLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DepartmentLocation" } } } } } } }, "/system/departments/{parentId}/locations/{id}": { "get": { "tags": [ "DepartmentLocations" ], "summary": "Get DepartmentLocation", "operationId": "getSystemDepartmentsByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DepartmentLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DepartmentLocation" } } } } } }, "delete": { "tags": [ "DepartmentLocations" ], "summary": "Delete DepartmentLocation", "operationId": "deleteSystemDepartmentsByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "DepartmentLocations" ], "summary": "Put DepartmentLocation", "operationId": "putSystemDepartmentsByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "departmentLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentLocation" } } }, "required": true }, "responses": { "200": { "description": "DepartmentLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DepartmentLocation" } } } } } }, "patch": { "tags": [ "DepartmentLocations" ], "summary": "Patch DepartmentLocation", "operationId": "patchSystemDepartmentsByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "DepartmentLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DepartmentLocation" } } } } } } }, "/system/departments/{parentId}/locations/count": { "get": { "tags": [ "DepartmentLocations" ], "summary": "Get Count of DepartmentLocation", "operationId": "getSystemDepartmentsByParentIdLocationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/departments/count": { "get": { "tags": [ "Departments" ], "summary": "Get Count of Department", "operationId": "getSystemDepartmentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/directionalSyncs/{id}/info": { "get": { "tags": [ "DirectionalSyncInfos" ], "summary": "Get DirectionalSyncsInfos", "operationId": "getSystemDirectionalSyncsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "DirectionalSyncInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DirectionalSyncInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DirectionalSyncInfo" } } } } } } }, "/system/directionalSyncs/info": { "get": { "tags": [ "DirectionalSyncInfos" ], "summary": "Get List of DirectionalSyncsInfos", "operationId": "getSystemDirectionalSyncsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DirectionalSyncInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DirectionalSyncInfo" } } } } } } } }, "/system/directionalSyncs/info/count": { "get": { "tags": [ "DirectionalSyncInfos" ], "summary": "Get Count of DirectionalSyncs", "operationId": "getSystemDirectionalSyncsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/documents": { "get": { "tags": [ "Documents" ], "summary": "Get List of DocumentInfo", "operationId": "getSystemDocuments", "parameters": [ { "name": "recordType", "in": "query", "description": "recordType", "schema": { "enum": [ "Activity", "Agreement", "Company", "Config", "Configuration", "Contact", "CustomImage", "Document", "Expense", "HTMLTemplate", "Invoice", "Opportunity", "Project", "ProjectActivity", "PurchaseOrder", "Rma", "SalesOrder", "Service", "Ticket", "ProjectTicket", "ServiceTemplate", "StandardServiceTemplate", "SrDetail", "TimeEntry", "JobHeader", "MarketingManagerAudit", "KnowledgeBase", "ToolbarIcon", "Meeting", "MeetingNote", "ProductSetup", "ProjectTemplateTicket", "BillingSetup", "ServiceBoard", "WordTemplate", "Member", "PortalImagePortalLogo", "PortalImageReportLogo", "TopNavigationLogo", "PhaseStatus", "ProjectStatus", "TicketStatus", "Schedule", "Priority", "Unassigned" ], "type": "string" } }, { "name": "recordId", "in": "query", "description": "recordId", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInfo" } } } } } } }, "post": { "tags": [ "Documents" ], "summary": "Post DocumentInfo", "operationId": "postSystemDocuments", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Multipart", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DocumentFormData" } } }, "required": true }, "responses": { "201": { "description": "DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentInfo" } } } } } } }, "/system/documents/{id}": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentInfo" } } } } } }, "delete": { "tags": [ "Documents" ], "summary": "Delete DocumentInfo", "operationId": "deleteSystemDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "post": { "tags": [ "Documents" ], "summary": "Post DocumentInfo", "operationId": "postSystemDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentInfo" } } } } } } }, "/system/documents/{id}/download": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsByIdDownload", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModified", "in": "query", "description": "lastModified", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/system/documents/{id}/thumbnail": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsByIdThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModified", "in": "query", "description": "lastModified", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/system/documents/count": { "get": { "tags": [ "Documents" ], "summary": "Get Count of DocumentInfo", "operationId": "getSystemDocumentsCount", "parameters": [ { "name": "recordType", "in": "query", "description": "recordType", "schema": { "enum": [ "Activity", "Agreement", "Company", "Config", "Configuration", "Contact", "CustomImage", "Document", "Expense", "HTMLTemplate", "Invoice", "Opportunity", "Project", "ProjectActivity", "PurchaseOrder", "Rma", "SalesOrder", "Service", "Ticket", "ProjectTicket", "ServiceTemplate", "StandardServiceTemplate", "SrDetail", "TimeEntry", "JobHeader", "MarketingManagerAudit", "KnowledgeBase", "ToolbarIcon", "Meeting", "MeetingNote", "ProductSetup", "ProjectTemplateTicket", "BillingSetup", "ServiceBoard", "WordTemplate", "Member", "PortalImagePortalLogo", "PortalImageReportLogo", "TopNavigationLogo", "PhaseStatus", "ProjectStatus", "TicketStatus", "Schedule", "Priority", "Unassigned" ], "type": "string" } }, { "name": "recordId", "in": "query", "description": "recordId", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/documents/uploadsample": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsUploadsample", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = text/html" } } } }, "/system/documentTypes/{id}/info": { "get": { "tags": [ "DocumentTypes" ], "summary": "Get DocumentType", "operationId": "getSystemDocumentTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "documentTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DocumentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentType" } } } } } } }, "/system/documentTypes/info": { "get": { "tags": [ "DocumentTypes" ], "summary": "Get List of DocumentType", "operationId": "getSystemDocumentTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentType" } } } } } } } }, "/system/documentTypes/info/count": { "get": { "tags": [ "DocumentTypes" ], "summary": "Get Count of DocumentType", "operationId": "getSystemDocumentTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/emailConnectors": { "get": { "tags": [ "EmailConnectors" ], "summary": "Get List of EmailConnector", "operationId": "getSystemEmailConnectors", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EmailConnector", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailConnector" } } } } } } }, "post": { "tags": [ "EmailConnectors" ], "summary": "Post EmailConnector", "operationId": "postSystemEmailConnectors", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailConnector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConnector" } } }, "required": true }, "responses": { "201": { "description": "EmailConnector", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnector" } } } } } } }, "/system/emailConnectors/{grandparentId}/parsingStyles/{parentId}/parsingRules": { "get": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Get List of EmailConnectorParsingRule", "operationId": "getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRules", "parameters": [ { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EmailConnectorParsingRule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } } } } } }, "post": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Post EmailConnectorParsingRule", "operationId": "postSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRules", "parameters": [ { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailConnectorParsingRule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } }, "required": true }, "responses": { "201": { "description": "EmailConnectorParsingRule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } } } } } }, "/system/emailConnectors/{grandparentId}/parsingStyles/{parentId}/parsingRules/{id}": { "get": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Get EmailConnectorParsingRule", "operationId": "getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingRuleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailConnectorParsingRule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } } } } }, "delete": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Delete EmailConnectorParsingRule", "operationId": "deleteSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingRuleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Put EmailConnectorParsingRule", "operationId": "putSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingRuleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailConnectorParsingRule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } }, "required": true }, "responses": { "200": { "description": "EmailConnectorParsingRule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } } } } }, "patch": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Patch EmailConnectorParsingRule", "operationId": "patchSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingRuleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "EmailConnectorParsingRule", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingRule" } } } } } } }, "/system/emailConnectors/{grandparentId}/parsingStyles/{parentId}/parsingRules/count": { "get": { "tags": [ "EmailConnectorParsingRules" ], "summary": "Get Count of EmailConnectorParsingRule", "operationId": "getSystemEmailConnectorsByGrandparentIdParsingStylesByParentIdParsingRulesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/emailConnectors/{id}": { "get": { "tags": [ "EmailConnectors" ], "summary": "Get EmailConnector", "operationId": "getSystemEmailConnectorsById", "parameters": [ { "name": "id", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailConnector", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnector" } } } } } }, "delete": { "tags": [ "EmailConnectors" ], "summary": "Delete EmailConnector", "operationId": "deleteSystemEmailConnectorsById", "parameters": [ { "name": "id", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "EmailConnectors" ], "summary": "Put EmailConnector", "operationId": "putSystemEmailConnectorsById", "parameters": [ { "name": "id", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailConnector", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConnector" } } }, "required": true }, "responses": { "200": { "description": "EmailConnector", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnector" } } } } } }, "patch": { "tags": [ "EmailConnectors" ], "summary": "Patch EmailConnector", "operationId": "patchSystemEmailConnectorsById", "parameters": [ { "name": "id", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "EmailConnector", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnector" } } } } } } }, "/system/emailConnectors/{id}/info": { "get": { "tags": [ "EmailConnectorInfos" ], "summary": "Get EmailConnectorInfos", "operationId": "getSystemEmailConnectorsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "EmailConnectorInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailConnectorInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorInfo" } } } } } } }, "/system/emailConnectors/{parentId}/parsingStyles": { "get": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Get List of EmailConnectorParsingStyle", "operationId": "getSystemEmailConnectorsByParentIdParsingStyles", "parameters": [ { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EmailConnectorParsingStyle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } } } } } }, "post": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Post EmailConnectorParsingStyle", "operationId": "postSystemEmailConnectorsByParentIdParsingStyles", "parameters": [ { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailConnectorParsingStyle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } }, "required": true }, "responses": { "201": { "description": "EmailConnectorParsingStyle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } } } } } }, "/system/emailConnectors/{parentId}/parsingStyles/{id}": { "get": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Get EmailConnectorParsingStyle", "operationId": "getSystemEmailConnectorsByParentIdParsingStylesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailConnectorParsingStyle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } } } } }, "delete": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Delete EmailConnectorParsingStyle", "operationId": "deleteSystemEmailConnectorsByParentIdParsingStylesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Put EmailConnectorParsingStyle", "operationId": "putSystemEmailConnectorsByParentIdParsingStylesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailConnectorParsingStyle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } }, "required": true }, "responses": { "200": { "description": "EmailConnectorParsingStyle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } } } } }, "patch": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Patch EmailConnectorParsingStyle", "operationId": "patchSystemEmailConnectorsByParentIdParsingStylesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingStyleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "EmailConnectorParsingStyle", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailConnectorParsingStyle" } } } } } } }, "/system/emailConnectors/{parentId}/parsingStyles/count": { "get": { "tags": [ "EmailConnectorParsingStyles" ], "summary": "Get Count of EmailConnectorParsingStyle", "operationId": "getSystemEmailConnectorsByParentIdParsingStylesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "emailConnectorId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/emailConnectors/count": { "get": { "tags": [ "EmailConnectors" ], "summary": "Get Count of EmailConnector", "operationId": "getSystemEmailConnectorsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/emailConnectors/info": { "get": { "tags": [ "EmailConnectorInfos" ], "summary": "Get List of EmailConnectorInfos", "operationId": "getSystemEmailConnectorsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of emailConnectorInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailConnectorInfo" } } } } } } } }, "/system/emailConnectors/info/count": { "get": { "tags": [ "EmailConnectorInfos" ], "summary": "Get Count of EmailConnectorInfos", "operationId": "getSystemEmailConnectorsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/emailExclusions": { "get": { "tags": [ "EmailExclusions" ], "summary": "Get List of EmailExclusion", "operationId": "getSystemEmailExclusions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EmailExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailExclusion" } } } } } } }, "post": { "tags": [ "EmailExclusions" ], "summary": "Post EmailExclusion", "operationId": "postSystemEmailExclusions", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailExclusion" } } }, "required": true }, "responses": { "201": { "description": "EmailExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailExclusion" } } } } } } }, "/system/emailExclusions/{id}": { "get": { "tags": [ "EmailExclusions" ], "summary": "Get EmailExclusion", "operationId": "getSystemEmailExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "emailExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailExclusion" } } } } } }, "delete": { "tags": [ "EmailExclusions" ], "summary": "Delete EmailExclusion", "operationId": "deleteSystemEmailExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "emailExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "EmailExclusions" ], "summary": "Put EmailExclusion", "operationId": "putSystemEmailExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "emailExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "emailExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailExclusion" } } }, "required": true }, "responses": { "200": { "description": "EmailExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailExclusion" } } } } } }, "patch": { "tags": [ "EmailExclusions" ], "summary": "Patch EmailExclusion", "operationId": "patchSystemEmailExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "emailExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "EmailExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailExclusion" } } } } } } }, "/system/emailExclusions/count": { "get": { "tags": [ "EmailExclusions" ], "summary": "Get Count of EmailExclusion", "operationId": "getSystemEmailExclusionsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/emailTokens": { "get": { "tags": [ "EmailTokens" ], "summary": "Get List of EmailToken", "operationId": "getSystemEmailTokens", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EmailToken", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailToken" } } } } } } } }, "/system/emailTokens/{id}": { "get": { "tags": [ "EmailTokens" ], "summary": "Get EmailToken", "operationId": "getSystemEmailTokensById", "parameters": [ { "name": "id", "in": "path", "description": "emailTokenId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EmailToken", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EmailToken" } } } } } } }, "/system/emailTokens/count": { "get": { "tags": [ "EmailTokens" ], "summary": "Get Count of EmailToken", "operationId": "getSystemEmailTokensCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/ePayConfigurations": { "get": { "tags": [ "EPayConfigurations" ], "summary": "Get List of EPayConfiguration", "operationId": "getSystemEPayConfigurations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of EPayConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EPayConfiguration" } } } } } } }, "post": { "tags": [ "EPayConfigurations" ], "summary": "Post EPayConfiguration", "operationId": "postSystemEPayConfigurations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ePayConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EPayConfiguration" } } }, "required": true }, "responses": { "201": { "description": "EPayConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EPayConfiguration" } } } } } } }, "/system/ePayConfigurations/{id}": { "get": { "tags": [ "EPayConfigurations" ], "summary": "Get EPayConfiguration", "operationId": "getSystemEPayConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ePayConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "EPayConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EPayConfiguration" } } } } } }, "delete": { "tags": [ "EPayConfigurations" ], "summary": "Delete EPayConfiguration", "operationId": "deleteSystemEPayConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ePayConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "EPayConfigurations" ], "summary": "Put EPayConfiguration", "operationId": "putSystemEPayConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ePayConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ePayConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EPayConfiguration" } } }, "required": true }, "responses": { "200": { "description": "EPayConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EPayConfiguration" } } } } } }, "patch": { "tags": [ "EPayConfigurations" ], "summary": "Patch EPayConfiguration", "operationId": "patchSystemEPayConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ePayConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "EPayConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/EPayConfiguration" } } } } } } }, "/system/ePayConfigurations/count": { "get": { "tags": [ "EPayConfigurations" ], "summary": "Get Count of EPayConfiguration", "operationId": "getSystemEPayConfigurationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/experiments": { "get": { "tags": [ "Experiments" ], "summary": "Get List of Experiment", "operationId": "getSystemExperiments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Experiment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Experiment" } } } } } } } }, "/system/experiments/{id}": { "get": { "tags": [ "Experiments" ], "summary": "Get Experiment", "operationId": "getSystemExperimentsById", "parameters": [ { "name": "id", "in": "path", "description": "experimentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Experiment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Experiment" } } } } } } }, "/system/experiments/count": { "get": { "tags": [ "Experiments" ], "summary": "Get Count of Experiment", "operationId": "getSystemExperimentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/fileuploadsettings/": { "get": { "tags": [ "FileUploadSettings" ], "summary": "Get List of FileUploadSettings", "operationId": "getSystemFileuploadsettings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of fileUploadSettingses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileUploadSetting" } } } } } } } }, "/system/fileuploadsettings/{id}": { "get": { "tags": [ "FileUploadSettings" ], "summary": "Get FileUploadSettings", "operationId": "getSystemFileuploadsettingsById", "parameters": [ { "name": "id", "in": "path", "description": "FileUploadSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "FileUploadSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FileUploadSetting" } } } } } }, "put": { "tags": [ "FileUploadSettings" ], "summary": "Put FileUploadSettings", "operationId": "putSystemFileuploadsettingsById", "parameters": [ { "name": "id", "in": "path", "description": "FileUploadSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUploadSetting" } } }, "required": true }, "responses": { "200": { "description": "FileUploadSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FileUploadSetting" } } } } } }, "patch": { "tags": [ "FileUploadSettings" ], "summary": "Patch FileUploadSettings", "operationId": "patchSystemFileuploadsettingsById", "parameters": [ { "name": "id", "in": "path", "description": "FileUploadSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "FileUploadSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/FileUploadSetting" } } } } } } }, "/system/fileuploadsettings/count": { "get": { "tags": [ "FileUploadSettings" ], "summary": "Get Count of FileUploadSettings", "operationId": "getSystemFileuploadsettingsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/googleemailsetup/": { "get": { "tags": [ "GoogleEmailSetups" ], "summary": "Get List of GoogleEmailSetups", "operationId": "getSystemGoogleemailsetup", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of googleEmailSetupses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GoogleEmailSetup" } } } } } } }, "post": { "tags": [ "GoogleEmailSetups" ], "summary": "Post GoogleEmailSetups", "operationId": "postSystemGoogleemailsetup", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "GoogleEmailSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleEmailSetup" } } }, "required": true }, "responses": { "201": { "description": "GoogleEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GoogleEmailSetup" } } } } } } }, "/system/googleemailsetup/{id}": { "get": { "tags": [ "GoogleEmailSetups" ], "summary": "Get GoogleEmailSetups", "operationId": "getSystemGoogleemailsetupById", "parameters": [ { "name": "id", "in": "path", "description": "GoogleEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "GoogleEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GoogleEmailSetup" } } } } } }, "delete": { "tags": [ "GoogleEmailSetups" ], "summary": "Delete GoogleEmailSetups", "operationId": "deleteSystemGoogleemailsetupById", "parameters": [ { "name": "id", "in": "path", "description": "GoogleEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "GoogleEmailSetups" ], "summary": "Put GoogleEmailSetups", "operationId": "putSystemGoogleemailsetupById", "parameters": [ { "name": "id", "in": "path", "description": "GoogleEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoogleEmailSetup" } } }, "required": true }, "responses": { "200": { "description": "GoogleEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GoogleEmailSetup" } } } } } }, "patch": { "tags": [ "GoogleEmailSetups" ], "summary": "Patch GoogleEmailSetups", "operationId": "patchSystemGoogleemailsetupById", "parameters": [ { "name": "id", "in": "path", "description": "GoogleEmailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "GoogleEmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/GoogleEmailSetup" } } } } } } }, "/system/googleemailsetup/{id}/testConnection": { "post": { "tags": [ "GoogleEmailSetups" ], "summary": "Post SuccessResponse", "operationId": "postSystemGoogleemailsetupByIdTestConnection", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/googleemailsetup/count": { "get": { "tags": [ "GoogleEmailSetups" ], "summary": "Get Count of GoogleEmailSetups", "operationId": "getSystemGoogleemailsetupCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/imaps": { "get": { "tags": [ "Imaps" ], "summary": "Get List of Imap", "operationId": "getSystemImaps", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Imap", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Imap" } } } } } } }, "post": { "tags": [ "Imaps" ], "summary": "Post Imap", "operationId": "postSystemImaps", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "imap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Imap" } } }, "required": true }, "responses": { "201": { "description": "Imap", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Imap" } } } } } } }, "/system/imaps/{id}": { "get": { "tags": [ "Imaps" ], "summary": "Get Imap", "operationId": "getSystemImapsById", "parameters": [ { "name": "id", "in": "path", "description": "imapId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Imap", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Imap" } } } } } }, "delete": { "tags": [ "Imaps" ], "summary": "Delete Imap", "operationId": "deleteSystemImapsById", "parameters": [ { "name": "id", "in": "path", "description": "imapId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Imaps" ], "summary": "Put Imap", "operationId": "putSystemImapsById", "parameters": [ { "name": "id", "in": "path", "description": "imapId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "imap", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Imap" } } }, "required": true }, "responses": { "200": { "description": "Imap", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Imap" } } } } } }, "patch": { "tags": [ "Imaps" ], "summary": "Patch Imap", "operationId": "patchSystemImapsById", "parameters": [ { "name": "id", "in": "path", "description": "imapId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Imap", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Imap" } } } } } } }, "/system/imaps/{id}/info": { "get": { "tags": [ "ImapInfos" ], "summary": "Get ImapInfo", "operationId": "getSystemImapsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ImapInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ImapInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ImapInfo" } } } } } } }, "/system/imaps/count": { "get": { "tags": [ "Imaps" ], "summary": "Get Count of Imap", "operationId": "getSystemImapsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/imaps/info": { "get": { "tags": [ "ImapInfos" ], "summary": "Get List of ImapInfos", "operationId": "getSystemImapsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ImapInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImapInfo" } } } } } } } }, "/system/imaps/info/count": { "get": { "tags": [ "ImapInfos" ], "summary": "Get Count of ImapInfos", "operationId": "getSystemImapsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/importMassMaintenance/{id}": { "post": { "tags": [ "ImportsMassMaintenance" ], "summary": "Post ImportMassMaintenance", "operationId": "postSystemImportMassMaintenanceById", "parameters": [ { "name": "id", "in": "path", "description": "importMassMaintenanceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ImportMassMaintenance", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ImportMassMaintenance" } } } } } } }, "/system/info": { "get": { "tags": [ "Info" ], "summary": "Get Info", "operationId": "getSystemInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Info", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Info" } } } } } } }, "/system/info/departmentlocations": { "get": { "tags": [ "DepartmentLocationInfos" ], "summary": "Get List of DepartmentLocationInfo", "operationId": "getSystemInfoDepartmentlocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DepartmentLocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentLocationInfo" } } } } } } } }, "/system/info/departmentlocations/{id}": { "get": { "tags": [ "DepartmentLocationInfos" ], "summary": "Get DepartmentLocationInfo", "operationId": "getSystemInfoDepartmentlocationsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentlocationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DepartmentLocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DepartmentLocationInfo" } } } } } } }, "/system/info/departmentlocations/count": { "get": { "tags": [ "DepartmentLocationInfos" ], "summary": "Get Count of DepartmentLocationInfo", "operationId": "getSystemInfoDepartmentlocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/departments": { "get": { "tags": [ "DepartmentInfos" ], "summary": "Get List of DepartmentInfo", "operationId": "getSystemInfoDepartments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DepartmentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentInfo" } } } } } } } }, "/system/info/departments/{id}": { "get": { "tags": [ "DepartmentInfos" ], "summary": "Get DepartmentInfo", "operationId": "getSystemInfoDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DepartmentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DepartmentInfo" } } } } } } }, "/system/info/departments/count": { "get": { "tags": [ "DepartmentInfos" ], "summary": "Get Count of DepartmentInfo", "operationId": "getSystemInfoDepartmentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/links": { "get": { "tags": [ "LinkInfos" ], "summary": "Get List of LinkInfo", "operationId": "getSystemInfoLinks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LinkInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkInfo" } } } } } } } }, "/system/info/links/{id}": { "get": { "tags": [ "LinkInfos" ], "summary": "Get LinkInfo", "operationId": "getSystemInfoLinksById", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LinkInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LinkInfo" } } } } } } }, "/system/info/links/{id}/resolveurl": { "post": { "tags": [ "LinkInfos" ], "summary": "Post LinkResolveUrlInfo", "operationId": "postSystemInfoLinksByIdResolveurl", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "resolveInfo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkResolveUrlInfo" } } }, "required": true }, "responses": { "201": { "description": "LinkResolveUrlInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LinkResolveUrlInfo" } } } } } } }, "/system/info/links/count": { "get": { "tags": [ "LinkInfos" ], "summary": "Get Count of LinkInfo", "operationId": "getSystemInfoLinksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/locales": { "get": { "tags": [ "LocaleInfos" ], "summary": "Get List of LocaleInfo", "operationId": "getSystemInfoLocales", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LocaleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocaleInfo" } } } } } } } }, "/system/info/locales/{id}": { "get": { "tags": [ "LocaleInfos" ], "summary": "Get LocaleInfo", "operationId": "getSystemInfoLocalesById", "parameters": [ { "name": "id", "in": "path", "description": "localeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LocaleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LocaleInfo" } } } } } } }, "/system/info/locales/count": { "get": { "tags": [ "LocaleInfos" ], "summary": "Get Count of LocaleInfo", "operationId": "getSystemInfoLocalesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/locations": { "get": { "tags": [ "LocationInfos" ], "summary": "Get List of LocationInfo", "operationId": "getSystemInfoLocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationInfo" } } } } } } } }, "/system/info/locations/{id}": { "get": { "tags": [ "LocationInfos" ], "summary": "Get LocationInfo", "operationId": "getSystemInfoLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LocationInfo" } } } } } } }, "/system/info/locations/count": { "get": { "tags": [ "LocationInfos" ], "summary": "Get Count of LocationInfo", "operationId": "getSystemInfoLocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/members": { "get": { "tags": [ "MemberInfos" ], "summary": "Get List of MemberInfo", "operationId": "getSystemInfoMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "/system/info/members/{id}": { "get": { "tags": [ "MemberInfos" ], "summary": "Get MemberInfo", "operationId": "getSystemInfoMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberInfo" } } } } } } }, "/system/info/members/{memberIdentifier:regex(^(types. |(": { "get": { "tags": [ "MemberInfos" ], "summary": "Get MemberInfo", "operationId": "getSystemInfoMembersmemberIdentifierregextypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberInfo" } } } } } } }, "/system/info/members/count": { "get": { "tags": [ "MemberInfos" ], "summary": "Get Count of MemberInfo", "operationId": "getSystemInfoMembersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/personas": { "get": { "tags": [ "PersonasInfos" ], "summary": "Get List of PersonasInfo", "operationId": "getSystemInfoPersonas", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PersonasInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonasInfo" } } } } } } } }, "/system/info/personas/{id}": { "get": { "tags": [ "PersonasInfos" ], "summary": "Get PersonasInfo", "operationId": "getSystemInfoPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PersonasInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PersonasInfo" } } } } } } }, "/system/info/personas/count": { "get": { "tags": [ "PersonasInfos" ], "summary": "Get Count of PersonasInfo", "operationId": "getSystemInfoPersonasCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/standardNotes": { "get": { "tags": [ "StandardNoteInfos" ], "summary": "Get List of StandardNoteInfo", "operationId": "getSystemInfoStandardNotes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of StandardNoteInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StandardNoteInfo" } } } } } } } }, "/system/info/standardNotes/{id}": { "get": { "tags": [ "StandardNoteInfos" ], "summary": "Get StandardNoteInfo", "operationId": "getSystemInfoStandardNotesById", "parameters": [ { "name": "id", "in": "path", "description": "standardNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "StandardNoteInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StandardNoteInfo" } } } } } } }, "/system/info/standardNotes/count": { "get": { "tags": [ "StandardNoteInfos" ], "summary": "Get Count of StandardNoteInfo", "operationId": "getSystemInfoStandardNotesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/inOutBoards": { "get": { "tags": [ "InOutBoards" ], "summary": "Get List of InOutBoard", "operationId": "getSystemInOutBoards", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InOutBoard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InOutBoard" } } } } } } }, "post": { "tags": [ "InOutBoards" ], "summary": "Post InOutBoard", "operationId": "postSystemInOutBoards", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "inOutBoard", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InOutBoard" } } }, "required": true }, "responses": { "201": { "description": "InOutBoard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutBoard" } } } } } } }, "/system/inOutBoards/{id}": { "get": { "tags": [ "InOutBoards" ], "summary": "Get InOutBoard", "operationId": "getSystemInOutBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "inOutBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InOutBoard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutBoard" } } } } } }, "delete": { "tags": [ "InOutBoards" ], "summary": "Delete InOutBoard", "operationId": "deleteSystemInOutBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "inOutBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "InOutBoards" ], "summary": "Put InOutBoard", "operationId": "putSystemInOutBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "inOutBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "inOutBoard", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InOutBoard" } } }, "required": true }, "responses": { "200": { "description": "InOutBoard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutBoard" } } } } } }, "patch": { "tags": [ "InOutBoards" ], "summary": "Patch InOutBoard", "operationId": "patchSystemInOutBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "inOutBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InOutBoard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutBoard" } } } } } } }, "/system/inOutBoards/count": { "get": { "tags": [ "InOutBoards" ], "summary": "Get Count of InOutBoard", "operationId": "getSystemInOutBoardsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/inOutTypes": { "get": { "tags": [ "InOutTypes" ], "summary": "Get List of InOutType", "operationId": "getSystemInOutTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InOutType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InOutType" } } } } } } }, "post": { "tags": [ "InOutTypes" ], "summary": "Post InOutType", "operationId": "postSystemInOutTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "inOutType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InOutType" } } }, "required": true }, "responses": { "201": { "description": "InOutType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutType" } } } } } } }, "/system/inOutTypes/{id}": { "get": { "tags": [ "InOutTypes" ], "summary": "Get InOutType", "operationId": "getSystemInOutTypesById", "parameters": [ { "name": "id", "in": "path", "description": "inOutTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InOutType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutType" } } } } } }, "delete": { "tags": [ "InOutTypes" ], "summary": "Delete InOutType", "operationId": "deleteSystemInOutTypesById", "parameters": [ { "name": "id", "in": "path", "description": "inOutTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "InOutTypes" ], "summary": "Put InOutType", "operationId": "putSystemInOutTypesById", "parameters": [ { "name": "id", "in": "path", "description": "inOutTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "inOutType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InOutType" } } }, "required": true }, "responses": { "200": { "description": "InOutType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutType" } } } } } }, "patch": { "tags": [ "InOutTypes" ], "summary": "Patch InOutType", "operationId": "patchSystemInOutTypesById", "parameters": [ { "name": "id", "in": "path", "description": "inOutTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "InOutType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutType" } } } } } } }, "/system/inOutTypes/{id}/info": { "get": { "tags": [ "InOutTypesInfo" ], "summary": "Get InOutTypeInfo", "operationId": "getSystemInOutTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "inOutTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InOutTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/InOutTypeInfo" } } } } } } }, "/system/inOutTypes/count": { "get": { "tags": [ "InOutTypes" ], "summary": "Get Count of InOutType", "operationId": "getSystemInOutTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/inOutTypes/count/info": { "get": { "tags": [ "InOutTypesInfo" ], "summary": "Get Count of InOutTypeInfo", "operationId": "getSystemInOutTypesCountInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/inOutTypes/info": { "get": { "tags": [ "InOutTypesInfo" ], "summary": "Get List of InOutTypeInfo", "operationId": "getSystemInOutTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of InOutTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InOutTypeInfo" } } } } } } } }, "/system/integratorlogins": { "get": { "tags": [ "IntegratorLogins" ], "summary": "Get List of IntegratorLogin", "operationId": "getSystemIntegratorlogins", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of IntegratorLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorLogin" } } } } } } }, "post": { "tags": [ "IntegratorLogins" ], "summary": "Post IntegratorLogin", "operationId": "postSystemIntegratorlogins", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "integratorLogin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorLogin" } } }, "required": true }, "responses": { "201": { "description": "IntegratorLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorLogin" } } } } } } }, "/system/integratorlogins/{id}": { "get": { "tags": [ "IntegratorLogins" ], "summary": "Get IntegratorLogin", "operationId": "getSystemIntegratorloginsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorloginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "IntegratorLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorLogin" } } } } } }, "delete": { "tags": [ "IntegratorLogins" ], "summary": "Delete IntegratorLogin", "operationId": "deleteSystemIntegratorloginsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorloginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "IntegratorLogins" ], "summary": "Put IntegratorLogin", "operationId": "putSystemIntegratorloginsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorloginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "integratorLogin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorLogin" } } }, "required": true }, "responses": { "200": { "description": "IntegratorLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorLogin" } } } } } }, "patch": { "tags": [ "IntegratorLogins" ], "summary": "Patch IntegratorLogin", "operationId": "patchSystemIntegratorloginsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorloginId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "IntegratorLogin", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorLogin" } } } } } } }, "/system/integratorlogins/count": { "get": { "tags": [ "IntegratorLogins" ], "summary": "Get Count of IntegratorLogin", "operationId": "getSystemIntegratorloginsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/integratorTags": { "get": { "tags": [ "IntegratorTags" ], "summary": "Get List of IntegratorTag", "operationId": "getSystemIntegratorTags", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of IntegratorTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorTag" } } } } } } }, "post": { "tags": [ "IntegratorTags" ], "summary": "Post IntegratorTag", "operationId": "postSystemIntegratorTags", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorTag" } } }, "required": true }, "responses": { "201": { "description": "IntegratorTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorTag" } } } } } } }, "/system/integratorTags/{id}": { "get": { "tags": [ "IntegratorTags" ], "summary": "Get IntegratorTag", "operationId": "getSystemIntegratorTagsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "IntegratorTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorTag" } } } } } }, "delete": { "tags": [ "IntegratorTags" ], "summary": "Delete IntegratorTag", "operationId": "deleteSystemIntegratorTagsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "IntegratorTags" ], "summary": "Put IntegratorTag", "operationId": "putSystemIntegratorTagsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorTag" } } }, "required": true }, "responses": { "200": { "description": "IntegratorTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorTag" } } } } } }, "patch": { "tags": [ "IntegratorTags" ], "summary": "Patch IntegratorTag", "operationId": "patchSystemIntegratorTagsById", "parameters": [ { "name": "id", "in": "path", "description": "integratorTagId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "IntegratorTag", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/IntegratorTag" } } } } } } }, "/system/integratorTags/count": { "get": { "tags": [ "IntegratorTags" ], "summary": "Get Count of IntegratorTag", "operationId": "getSystemIntegratorTagsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/kpiCategories": { "get": { "tags": [ "KPICategories" ], "summary": "Get List of KPICategory", "operationId": "getSystemKpiCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KPICategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KPICategory" } } } } } } } }, "/system/kpiCategories/{id}": { "get": { "tags": [ "KPICategories" ], "summary": "Get KPICategory", "operationId": "getSystemKpiCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "kpiCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KPICategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KPICategory" } } } } } } }, "/system/kpiCategories/count": { "get": { "tags": [ "KPICategories" ], "summary": "Get Count of KPICategory", "operationId": "getSystemKpiCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/kpis": { "get": { "tags": [ "KPIs" ], "summary": "Get List of KPI", "operationId": "getSystemKpis", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KPI", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KPI" } } } } } } } }, "/system/kpis/{id}": { "get": { "tags": [ "KPIs" ], "summary": "Get KPI", "operationId": "getSystemKpisById", "parameters": [ { "name": "id", "in": "path", "description": "kpiId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KPI", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/KPI" } } } } } } }, "/system/kpis/count": { "get": { "tags": [ "KPIs" ], "summary": "Get Count of KPI", "operationId": "getSystemKpisCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/ldapConfigurations": { "get": { "tags": [ "LdapConfigurations" ], "summary": "Get List of LdapConfiguration", "operationId": "getSystemLdapConfigurations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LdapConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LdapConfiguration" } } } } } } }, "post": { "tags": [ "LdapConfigurations" ], "summary": "Post LdapConfiguration", "operationId": "postSystemLdapConfigurations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ldapConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapConfiguration" } } }, "required": true }, "responses": { "201": { "description": "LdapConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LdapConfiguration" } } } } } } }, "/system/ldapConfigurations/{id}": { "get": { "tags": [ "LdapConfigurations" ], "summary": "Get LdapConfiguration", "operationId": "getSystemLdapConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ldapConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LdapConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LdapConfiguration" } } } } } }, "delete": { "tags": [ "LdapConfigurations" ], "summary": "Delete LdapConfiguration", "operationId": "deleteSystemLdapConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ldapConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "LdapConfigurations" ], "summary": "Put LdapConfiguration", "operationId": "putSystemLdapConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ldapConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ldapConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapConfiguration" } } }, "required": true }, "responses": { "200": { "description": "LdapConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LdapConfiguration" } } } } } }, "patch": { "tags": [ "LdapConfigurations" ], "summary": "Patch LdapConfiguration", "operationId": "patchSystemLdapConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ldapConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "LdapConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LdapConfiguration" } } } } } } }, "/system/ldapConfigurations/{id}/info": { "get": { "tags": [ "LdapConfigurationInfos" ], "summary": "Get LdapConfigurationInfos", "operationId": "getSystemLdapConfigurationsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "LdapConfigurationInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LdapConfigurationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LdapConfigurationInfo" } } } } } } }, "/system/ldapConfigurations/count": { "get": { "tags": [ "LdapConfigurations" ], "summary": "Get Count of LdapConfiguration", "operationId": "getSystemLdapConfigurationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/ldapConfigurations/info": { "get": { "tags": [ "LdapConfigurationInfos" ], "summary": "Get List of LdapConfigurationInfos", "operationId": "getSystemLdapConfigurationsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ldapConfigurationInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LdapConfigurationInfo" } } } } } } } }, "/system/ldapConfigurations/info/count": { "get": { "tags": [ "LdapConfigurationInfos" ], "summary": "Get Count of LdapConfigurationInfos", "operationId": "getSystemLdapConfigurationsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/ldapConfigurations/testLink": { "post": { "tags": [ "LdapConfigurations" ], "summary": "Post SuccessResponse", "operationId": "postSystemLdapConfigurationsTestLink", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapConfigurationTestLink" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/links": { "get": { "tags": [ "Links" ], "summary": "Get List of Link", "operationId": "getSystemLinks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Link", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } } } } } } }, "post": { "tags": [ "Links" ], "summary": "Post Link", "operationId": "postSystemLinks", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "link", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Link" } } }, "required": true }, "responses": { "201": { "description": "Link", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Link" } } } } } } }, "/system/links/{id}": { "get": { "tags": [ "Links" ], "summary": "Get Link", "operationId": "getSystemLinksById", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Link", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Link" } } } } } }, "delete": { "tags": [ "Links" ], "summary": "Delete Link", "operationId": "deleteSystemLinksById", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Links" ], "summary": "Put Link", "operationId": "putSystemLinksById", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "link", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Link" } } }, "required": true }, "responses": { "200": { "description": "Link", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Link" } } } } } }, "patch": { "tags": [ "Links" ], "summary": "Patch Link", "operationId": "patchSystemLinksById", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Link", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Link" } } } } } } }, "/system/links/count": { "get": { "tags": [ "Links" ], "summary": "Get Count of Link", "operationId": "getSystemLinksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/locations": { "get": { "tags": [ "Locations" ], "summary": "Get List of Location", "operationId": "getSystemLocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Location", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } } } } } }, "post": { "tags": [ "Locations" ], "summary": "Post Location", "operationId": "postSystemLocations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } }, "required": true }, "responses": { "201": { "description": "Location", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/system/locations/{id}": { "get": { "tags": [ "Locations" ], "summary": "Get Location", "operationId": "getSystemLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Location", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "delete": { "tags": [ "Locations" ], "summary": "Delete Location", "operationId": "deleteSystemLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Locations" ], "summary": "Put Location", "operationId": "putSystemLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } }, "required": true }, "responses": { "200": { "description": "Location", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Location" } } } } } }, "patch": { "tags": [ "Locations" ], "summary": "Patch Location", "operationId": "patchSystemLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Location", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Location" } } } } } } }, "/system/locations/{id}/usages": { "get": { "tags": [ "Locations" ], "summary": "Get List of Usage Count", "operationId": "getSystemLocationsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/locations/{id}/usages/list": { "get": { "tags": [ "Locations" ], "summary": "Get List of Usage", "operationId": "getSystemLocationsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/locations/{parentId}/departments": { "get": { "tags": [ "LocationDepartments" ], "summary": "Get List of LocationDepartment", "operationId": "getSystemLocationsByParentIdDepartments", "parameters": [ { "name": "parentId", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LocationDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationDepartment" } } } } } } } }, "/system/locations/{parentId}/departments/{id}": { "get": { "tags": [ "LocationDepartments" ], "summary": "Get LocationDepartment", "operationId": "getSystemLocationsByParentIdDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LocationDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LocationDepartment" } } } } } } }, "/system/locations/{parentId}/departments/count": { "get": { "tags": [ "LocationDepartments" ], "summary": "Get Count of LocationDepartment", "operationId": "getSystemLocationsByParentIdDepartmentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/locations/{parentId}/workRoles": { "get": { "tags": [ "LocationWorkRoles" ], "summary": "Get List of LocationWorkRole", "operationId": "getSystemLocationsByParentIdWorkRoles", "parameters": [ { "name": "parentId", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LocationWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationWorkRole" } } } } } } } }, "/system/locations/{parentId}/workRoles/{id}": { "get": { "tags": [ "LocationWorkRoles" ], "summary": "Get LocationWorkRole", "operationId": "getSystemLocationsByParentIdWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LocationWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/LocationWorkRole" } } } } } } }, "/system/locations/{parentId}/workRoles/count": { "get": { "tags": [ "LocationWorkRoles" ], "summary": "Get Count of LocationWorkRole", "operationId": "getSystemLocationsByParentIdWorkRolesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/locations/count": { "get": { "tags": [ "Locations" ], "summary": "Get Count of Usage", "operationId": "getSystemLocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/m365contactsync/{id}/info": { "get": { "tags": [ "M365ContactSyncInfos" ], "summary": "Get M365ContactSyncInfos", "operationId": "getSystemM365contactsyncByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "M365ContactSyncInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "M365ContactSyncInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/M365ContactSyncInfo" } } } } } } }, "/system/m365contactsync/info": { "get": { "tags": [ "M365ContactSyncInfos" ], "summary": "Get List of M365ContactSyncInfos", "operationId": "getSystemM365contactsyncInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of m365ContactSyncInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/M365ContactSyncInfo" } } } } } } } }, "/system/m365contactsync/info/count": { "get": { "tags": [ "M365ContactSyncInfos" ], "summary": "Get Count of M365ContactSyncInfo", "operationId": "getSystemM365contactsyncInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/managementNetworkSecurities": { "get": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Get List of ManagementNetworkSecurity", "operationId": "getSystemManagementNetworkSecurities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementNetworkSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } } } } } }, "post": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Post ManagementNetworkSecurity", "operationId": "postSystemManagementNetworkSecurities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementNetworkSecurity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } }, "required": true }, "responses": { "201": { "description": "ManagementNetworkSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } } } } } }, "/system/managementNetworkSecurities/{id}": { "get": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Get ManagementNetworkSecurity", "operationId": "getSystemManagementNetworkSecuritiesById", "parameters": [ { "name": "id", "in": "path", "description": "managementNetworkSecurityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementNetworkSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } } } } }, "delete": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Delete ManagementNetworkSecurity", "operationId": "deleteSystemManagementNetworkSecuritiesById", "parameters": [ { "name": "id", "in": "path", "description": "managementNetworkSecurityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Put ManagementNetworkSecurity", "operationId": "putSystemManagementNetworkSecuritiesById", "parameters": [ { "name": "id", "in": "path", "description": "managementNetworkSecurityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementNetworkSecurity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } }, "required": true }, "responses": { "200": { "description": "ManagementNetworkSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } } } } }, "patch": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Patch ManagementNetworkSecurity", "operationId": "patchSystemManagementNetworkSecuritiesById", "parameters": [ { "name": "id", "in": "path", "description": "managementNetworkSecurityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementNetworkSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ManagementNetworkSecurity" } } } } } } }, "/system/managementNetworkSecurities/{id}/testCredentials": { "get": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Get SuccessResponse", "operationId": "getSystemManagementNetworkSecuritiesByIdTestCredentials", "parameters": [ { "name": "id", "in": "path", "description": "managementNetworkSecurityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/managementNetworkSecurities/count": { "get": { "tags": [ "ManagementNetworksSecurity" ], "summary": "Get Count of ManagementNetworkSecurity", "operationId": "getSystemManagementNetworkSecuritiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/marketplaceimport/getdefinition/{id}": { "get": { "tags": [ "MarketplaceImports" ], "summary": "Get MarketplaceImport", "operationId": "getSystemMarketplaceimportGetdefinitionById", "parameters": [ { "name": "id", "in": "path", "description": "getdefinitionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MarketplaceImport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketplaceImport" } } } } } } }, "/system/marketplaceimport/import": { "post": { "tags": [ "MarketplaceImports" ], "summary": "Post MarketplaceImport", "operationId": "postSystemMarketplaceimportImport", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "marketplaceImport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceImport" } } }, "required": true }, "responses": { "201": { "description": "MarketplaceImport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MarketplaceImport" } } } } } } }, "/system/members": { "get": { "tags": [ "Members" ], "summary": "Get List of Member", "operationId": "getSystemMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } } } } }, "post": { "tags": [ "Members" ], "summary": "Post Member", "operationId": "postSystemMembers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } }, "required": true }, "responses": { "201": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Member" } } } } } } }, "/system/members/{id}": { "get": { "tags": [ "Members" ], "summary": "Get Member", "operationId": "getSystemMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Member" } } } } } }, "put": { "tags": [ "Members" ], "summary": "Put Member", "operationId": "putSystemMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } }, "required": true }, "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Member" } } } } } }, "patch": { "tags": [ "Members" ], "summary": "Patch Member", "operationId": "patchSystemMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Member" } } } } } } }, "/system/members/{id}/deactivate": { "post": { "tags": [ "Members" ], "summary": "Post MemberDeactivation", "operationId": "postSystemMembersByIdDeactivate", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDeactivation" } } }, "required": true }, "responses": { "200": { "description": "MemberDeactivation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDeactivation" } } } } } } }, "/system/members/{id}/image": { "get": { "tags": [ "MemberImages" ], "summary": "Get", "operationId": "getSystemMembersByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "useDefaultFlag", "in": "path", "description": "useDefaultFlag", "required": true, "schema": { "type": "boolean" } }, { "name": "lastmodified", "in": "path", "description": "lastmodified", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/system/members/{id}/linkSsoUser": { "post": { "tags": [ "Members" ], "summary": "Post SuccessResponse", "operationId": "postSystemMembersByIdLinkSsoUser", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberLinkSsoUser" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/members/{id}/submit": { "post": { "tags": [ "Members" ], "summary": "Post SuccessResponse", "operationId": "postSystemMembersByIdSubmit", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSsoToken" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/members/{id}/unlinkSsoUser": { "post": { "tags": [ "Members" ], "summary": "Post SuccessResponse", "operationId": "postSystemMembersByIdUnlinkSsoUser", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/members/{id}/unusedTimeSheets": { "delete": { "tags": [ "Members" ], "summary": "Delete Member", "operationId": "deleteSystemMembersByIdUnusedTimeSheets", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/members/{id}/usages": { "get": { "tags": [ "Members" ], "summary": "Get List of Usage Count", "operationId": "getSystemMembersByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/members/{id}/usages/list": { "get": { "tags": [ "Members" ], "summary": "Get List of Usage", "operationId": "getSystemMembersByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/members/{memberIdentifier:regex(^(types. |(": { "get": { "tags": [ "Members" ], "summary": "Get Member", "operationId": "getSystemMembersmemberIdentifierregextypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "memberIdentifier", "in": "path", "description": "memberIdentifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Member" } } } } } } }, "/system/members/{memberIdentifier}/tokens": { "post": { "tags": [ "Members" ], "summary": "Post Token", "operationId": "postSystemMembersByMemberIdentifierTokens", "parameters": [ { "name": "memberIdentifier", "in": "path", "description": "memberIdentifier", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Token" } } } } } } }, "/system/members/{parentId}/accruals": { "get": { "tags": [ "MemberAccruals" ], "summary": "Get List of MemberAccrual", "operationId": "getSystemMembersByParentIdAccruals", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberAccrual" } } } } } } }, "post": { "tags": [ "MemberAccruals" ], "summary": "Post MemberAccrual", "operationId": "postSystemMembersByParentIdAccruals", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberAccrual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } }, "required": true }, "responses": { "201": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } } }, "/system/members/{parentId}/accruals/{id}": { "get": { "tags": [ "MemberAccruals" ], "summary": "Get MemberAccrual", "operationId": "getSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } }, "delete": { "tags": [ "MemberAccruals" ], "summary": "Delete MemberAccrual", "operationId": "deleteSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberAccruals" ], "summary": "Put MemberAccrual", "operationId": "putSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberAccrual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } }, "required": true }, "responses": { "200": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } }, "patch": { "tags": [ "MemberAccruals" ], "summary": "Patch MemberAccrual", "operationId": "patchSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } } }, "/system/members/{parentId}/accruals/count": { "get": { "tags": [ "MemberAccruals" ], "summary": "Get Count of MemberAccrual", "operationId": "getSystemMembersByParentIdAccrualsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/certifications": { "get": { "tags": [ "MemberCertifications" ], "summary": "Get List of MemberCertification", "operationId": "getSystemMembersByParentIdCertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "post": { "tags": [ "MemberCertifications" ], "summary": "Post MemberCertification", "operationId": "postSystemMembersByParentIdCertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "201": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/certifications/{id}": { "get": { "tags": [ "MemberCertifications" ], "summary": "Get MemberCertification", "operationId": "getSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "delete": { "tags": [ "MemberCertifications" ], "summary": "Delete MemberCertification", "operationId": "deleteSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberCertifications" ], "summary": "Put MemberCertification", "operationId": "putSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "patch": { "tags": [ "MemberCertifications" ], "summary": "Patch MemberCertification", "operationId": "patchSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/certifications/count": { "get": { "tags": [ "MemberCertifications" ], "summary": "Get Count of MemberCertification", "operationId": "getSystemMembersByParentIdCertificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/delegations": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get List of MemberDelegation", "operationId": "getSystemMembersByParentIdDelegations", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "post": { "tags": [ "MemberDelegations" ], "summary": "Post MemberDelegation", "operationId": "postSystemMembersByParentIdDelegations", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberDelegation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } }, "required": true }, "responses": { "201": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "/system/members/{parentId}/delegations/{id}": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get MemberDelegation", "operationId": "getSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } }, "delete": { "tags": [ "MemberDelegations" ], "summary": "Delete MemberDelegation", "operationId": "deleteSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberDelegations" ], "summary": "Put MemberDelegation", "operationId": "putSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberDelegation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } }, "required": true }, "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } }, "patch": { "tags": [ "MemberDelegations" ], "summary": "Patch MemberDelegation", "operationId": "patchSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "/system/members/{parentId}/delegations/count": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get Count of MemberDelegation", "operationId": "getSystemMembersByParentIdDelegationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/managedDeviceAccounts": { "get": { "tags": [ "ManagedDeviceAccounts" ], "summary": "Get List of ManagedDeviceAccount", "operationId": "getSystemMembersByParentIdManagedDeviceAccounts", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagedDeviceAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDeviceAccount" } } } } } } } }, "/system/members/{parentId}/managedDeviceAccounts/bulk": { "delete": { "tags": [ "ManagedDeviceAccounts" ], "summary": "Delete BulkResult", "operationId": "deleteSystemMembersByParentIdManagedDeviceAccountsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managedDeviceAccounts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdCollection" } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } }, "put": { "tags": [ "ManagedDeviceAccounts" ], "summary": "Put BulkResult", "operationId": "putSystemMembersByParentIdManagedDeviceAccountsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of ManagedDeviceAccount", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDeviceAccount" } } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } } }, "/system/members/{parentId}/mycertifications": { "get": { "tags": [ "MyMemberCertifications" ], "summary": "Get List of MemberCertification", "operationId": "getSystemMembersByParentIdMycertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "post": { "tags": [ "MyMemberCertifications" ], "summary": "Post MemberCertification", "operationId": "postSystemMembersByParentIdMycertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "201": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/mycertifications/{id}": { "get": { "tags": [ "MyMemberCertifications" ], "summary": "Get MemberCertification", "operationId": "getSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "delete": { "tags": [ "MyMemberCertifications" ], "summary": "Delete MemberCertification", "operationId": "deleteSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MyMemberCertifications" ], "summary": "Put MemberCertification", "operationId": "putSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "patch": { "tags": [ "MyMemberCertifications" ], "summary": "Patch MemberCertification", "operationId": "patchSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/mycertifications/count": { "get": { "tags": [ "MyMemberCertifications" ], "summary": "Get Count of MemberCertification", "operationId": "getSystemMembersByParentIdMycertificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/notificationSettings": { "get": { "tags": [ "MemberNotificationSettings" ], "summary": "Get List of MemberNotificationSetting", "operationId": "getSystemMembersByParentIdNotificationSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } } }, "post": { "tags": [ "MemberNotificationSettings" ], "summary": "Post MemberNotificationSetting", "operationId": "postSystemMembersByParentIdNotificationSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberNotificationSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } }, "required": true }, "responses": { "201": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } } }, "/system/members/{parentId}/notificationSettings/{id}": { "get": { "tags": [ "MemberNotificationSettings" ], "summary": "Get MemberNotificationSetting", "operationId": "getSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } }, "delete": { "tags": [ "MemberNotificationSettings" ], "summary": "Delete MemberNotificationSetting", "operationId": "deleteSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberNotificationSettings" ], "summary": "Put MemberNotificationSetting", "operationId": "putSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberNotificationSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } }, "required": true }, "responses": { "200": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } }, "patch": { "tags": [ "MemberNotificationSettings" ], "summary": "Patch MemberNotificationSetting", "operationId": "patchSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } } }, "/system/members/{parentId}/notificationSettings/count": { "get": { "tags": [ "MemberNotificationSettings" ], "summary": "Get Count of MemberNotificationSetting", "operationId": "getSystemMembersByParentIdNotificationSettingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/personas": { "get": { "tags": [ "MemberPersonas" ], "summary": "Get List of MemberPersona", "operationId": "getSystemMembersByParentIdPersonas", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberPersona" } } } } } } }, "post": { "tags": [ "MemberPersonas" ], "summary": "Post MemberPersona", "operationId": "postSystemMembersByParentIdPersonas", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberPersona", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } }, "required": true }, "responses": { "201": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } } }, "/system/members/{parentId}/personas/{id}": { "get": { "tags": [ "MemberPersonas" ], "summary": "Get MemberPersona", "operationId": "getSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } }, "delete": { "tags": [ "MemberPersonas" ], "summary": "Delete MemberPersona", "operationId": "deleteSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberPersonas" ], "summary": "Put MemberPersona", "operationId": "putSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberPersona", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } }, "required": true }, "responses": { "200": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } }, "patch": { "tags": [ "MemberPersonas" ], "summary": "Patch MemberPersona", "operationId": "patchSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } } }, "/system/members/{parentId}/personas/count": { "get": { "tags": [ "MemberPersonas" ], "summary": "Get Count of MemberPersona", "operationId": "getSystemMembersByParentIdPersonasCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/skills": { "get": { "tags": [ "MemberSkills" ], "summary": "Get List of MemberSkill", "operationId": "getSystemMembersByParentIdSkills", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "post": { "tags": [ "MemberSkills" ], "summary": "Post MemberSkill", "operationId": "postSystemMembersByParentIdSkills", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberSkill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } }, "required": true }, "responses": { "201": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "/system/members/{parentId}/skills/{id}": { "get": { "tags": [ "MemberSkills" ], "summary": "Get MemberSkill", "operationId": "getSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } }, "delete": { "tags": [ "MemberSkills" ], "summary": "Delete MemberSkill", "operationId": "deleteSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberSkills" ], "summary": "Put MemberSkill", "operationId": "putSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberSkill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } }, "required": true }, "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } }, "patch": { "tags": [ "MemberSkills" ], "summary": "Patch MemberSkill", "operationId": "patchSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "/system/members/{parentId}/skills/count": { "get": { "tags": [ "MemberSkills" ], "summary": "Get Count of MemberSkill", "operationId": "getSystemMembersByParentIdSkillsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{ssoid}/deactivateIamMember": { "post": { "tags": [ "Members" ], "summary": "Delete Member Via IAM", "operationId": "postSystemMembersBySsoidDeactivateIamMember", "parameters": [ { "name": "ssoid", "in": "path", "description": "ssoId", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/members/calendarsync": { "get": { "tags": [ "Members" ], "summary": "Get List of Member to be use for calendar sync subscriptions", "operationId": "getSystemMembersCalendarsync", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Member for calendar sync", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberForCalSync" } } } } } } } }, "/system/members/count": { "get": { "tags": [ "Members" ], "summary": "Get Count of Usage", "operationId": "getSystemMembersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/types": { "get": { "tags": [ "MemberTypes" ], "summary": "Get List of MemberType", "operationId": "getSystemMembersTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberType" } } } } } } }, "post": { "tags": [ "MemberTypes" ], "summary": "Post MemberType", "operationId": "postSystemMembersTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberType" } } }, "required": true }, "responses": { "201": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } } }, "/system/members/types/{id}": { "get": { "tags": [ "MemberTypes" ], "summary": "Get MemberType", "operationId": "getSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } }, "delete": { "tags": [ "MemberTypes" ], "summary": "Delete MemberType", "operationId": "deleteSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberTypes" ], "summary": "Put MemberType", "operationId": "putSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberType" } } }, "required": true }, "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } }, "patch": { "tags": [ "MemberTypes" ], "summary": "Patch MemberType", "operationId": "patchSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } } }, "/system/members/types/{id}/info": { "get": { "tags": [ "MemberTypes" ], "summary": "Get MemberType", "operationId": "getSystemMembersTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberTypeInfo" } } } } } } }, "/system/members/types/count": { "get": { "tags": [ "MemberTypes" ], "summary": "Get Count of MemberType", "operationId": "getSystemMembersTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/types/info": { "get": { "tags": [ "MemberTypes" ], "summary": "Get List of MemberType", "operationId": "getSystemMembersTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberTypeInfo" } } } } } } } }, "/system/members/types/info/count": { "get": { "tags": [ "MemberTypes" ], "summary": "Get Count of MemberType", "operationId": "getSystemMembersTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/withSso": { "get": { "tags": [ "Members" ], "summary": "Get List of Member", "operationId": "getSystemMembersWithSso", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Member", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } } } } } }, "/system/membertemplates/": { "get": { "tags": [ "MemberTemplates" ], "summary": "Get List of MemberTemplates", "operationId": "getSystemMembertemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of memberTemplateses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberTemplate" } } } } } } }, "post": { "tags": [ "MemberTemplates" ], "summary": "Post MemberTemplates", "operationId": "postSystemMembertemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "MemberTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberTemplate" } } }, "required": true }, "responses": { "201": { "description": "MemberTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberTemplate" } } } } } } }, "/system/membertemplates/{id}": { "get": { "tags": [ "MemberTemplates" ], "summary": "Get MemberTemplates", "operationId": "getSystemMembertemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "MemberTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberTemplate" } } } } } }, "patch": { "tags": [ "MemberTemplates" ], "summary": "Patch MemberTemplates", "operationId": "patchSystemMembertemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "MemberTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberTemplate" } } } } } } }, "/system/membertemplates/count": { "get": { "tags": [ "MemberTemplates" ], "summary": "Get Count of MemberTemplates", "operationId": "getSystemMembertemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/menuentries": { "get": { "tags": [ "MenuEntries" ], "summary": "Get List of MenuEntry", "operationId": "getSystemMenuentries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MenuEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MenuEntry" } } } } } } }, "post": { "tags": [ "MenuEntries" ], "summary": "Post MenuEntry", "operationId": "postSystemMenuentries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "menuEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuEntry" } } }, "required": true }, "responses": { "201": { "description": "MenuEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MenuEntry" } } } } } } }, "/system/menuentries/{id}": { "get": { "tags": [ "MenuEntries" ], "summary": "Get MenuEntry", "operationId": "getSystemMenuentriesById", "parameters": [ { "name": "id", "in": "path", "description": "menuentryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MenuEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MenuEntry" } } } } } }, "delete": { "tags": [ "MenuEntries" ], "summary": "Delete MenuEntry", "operationId": "deleteSystemMenuentriesById", "parameters": [ { "name": "id", "in": "path", "description": "menuentryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MenuEntries" ], "summary": "Put MenuEntry", "operationId": "putSystemMenuentriesById", "parameters": [ { "name": "id", "in": "path", "description": "menuentryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "menuEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuEntry" } } }, "required": true }, "responses": { "200": { "description": "MenuEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MenuEntry" } } } } } }, "patch": { "tags": [ "MenuEntries" ], "summary": "Patch MenuEntry", "operationId": "patchSystemMenuentriesById", "parameters": [ { "name": "id", "in": "path", "description": "menuentryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MenuEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MenuEntry" } } } } } } }, "/system/menuentries/{id}/image": { "get": { "tags": [ "MenuEntries" ], "summary": "Get MenuEntry", "operationId": "getSystemMenuentriesByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "menuentryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "lastmodified", "in": "path", "description": "lastmodified", "required": true, "schema": { "type": "string" } }, { "name": "largeFlag", "in": "path", "description": "largeFlag", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } }, "post": { "tags": [ "MenuEntries" ], "summary": "Post MenuEntry", "operationId": "postSystemMenuentriesByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "menuentryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/menuEntries/{parentId}/locations": { "get": { "tags": [ "MenuEntryLocations" ], "summary": "Get List of MenuEntryLocation", "operationId": "getSystemMenuEntriesByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "menuEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MenuEntryLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MenuEntryLocation" } } } } } } }, "post": { "tags": [ "MenuEntryLocations" ], "summary": "Post MenuEntryLocation", "operationId": "postSystemMenuEntriesByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "menuEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "menuEntryLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuEntryLocation" } } }, "required": true }, "responses": { "201": { "description": "MenuEntryLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MenuEntryLocation" } } } } } } }, "/system/menuEntries/{parentId}/locations/{id}": { "get": { "tags": [ "MenuEntryLocations" ], "summary": "Get MenuEntryLocation", "operationId": "getSystemMenuEntriesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "menuEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MenuEntryLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MenuEntryLocation" } } } } } }, "delete": { "tags": [ "MenuEntryLocations" ], "summary": "Delete MenuEntryLocation", "operationId": "deleteSystemMenuEntriesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "menuEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/menuEntries/{parentId}/locations/count": { "get": { "tags": [ "MenuEntryLocations" ], "summary": "Get Count of MenuEntryLocation", "operationId": "getSystemMenuEntriesByParentIdLocationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "menuEntryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/menuentries/count": { "get": { "tags": [ "MenuEntries" ], "summary": "Get Count of MenuEntry", "operationId": "getSystemMenuentriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myAccount/{id}": { "get": { "tags": [ "MyAccounts" ], "summary": "Get MyAccount", "operationId": "getSystemMyAccountById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MyAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MyAccount" } } } } } }, "put": { "tags": [ "MyAccounts" ], "summary": "Put MyAccount", "operationId": "putSystemMyAccountById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "myAccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyAccount" } } }, "required": true }, "responses": { "200": { "description": "MyAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MyAccount" } } } } } }, "patch": { "tags": [ "MyAccounts" ], "summary": "Patch MyAccount", "operationId": "patchSystemMyAccountById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MyAccount", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MyAccount" } } } } } } }, "/system/myAccount/{parentId}/delegations": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get List of MemberDelegation", "operationId": "getSystemMyAccountByParentIdDelegations", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "post": { "tags": [ "MemberDelegations" ], "summary": "Post MemberDelegation", "operationId": "postSystemMyAccountByParentIdDelegations", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberDelegation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } }, "required": true }, "responses": { "201": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "/system/myAccount/{parentId}/delegations/{id}": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get MemberDelegation", "operationId": "getSystemMyAccountByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } }, "delete": { "tags": [ "MemberDelegations" ], "summary": "Delete MemberDelegation", "operationId": "deleteSystemMyAccountByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberDelegations" ], "summary": "Put MemberDelegation", "operationId": "putSystemMyAccountByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberDelegation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } }, "required": true }, "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } }, "patch": { "tags": [ "MemberDelegations" ], "summary": "Patch MemberDelegation", "operationId": "patchSystemMyAccountByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "/system/myAccount/{parentId}/delegations/count": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get Count of MemberDelegation", "operationId": "getSystemMyAccountByParentIdDelegationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myAccount/{parentId}/skills": { "get": { "tags": [ "MemberSkills" ], "summary": "Get List of MemberSkill", "operationId": "getSystemMyAccountByParentIdSkills", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "post": { "tags": [ "MemberSkills" ], "summary": "Post MemberSkill", "operationId": "postSystemMyAccountByParentIdSkills", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberSkill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } }, "required": true }, "responses": { "201": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "/system/myAccount/{parentId}/skills/{id}": { "get": { "tags": [ "MemberSkills" ], "summary": "Get MemberSkill", "operationId": "getSystemMyAccountByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } }, "delete": { "tags": [ "MemberSkills" ], "summary": "Delete MemberSkill", "operationId": "deleteSystemMyAccountByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberSkills" ], "summary": "Put MemberSkill", "operationId": "putSystemMyAccountByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberSkill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } }, "required": true }, "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } }, "patch": { "tags": [ "MemberSkills" ], "summary": "Patch MemberSkill", "operationId": "patchSystemMyAccountByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "/system/myAccount/{parentId}/skills/count": { "get": { "tags": [ "MemberSkills" ], "summary": "Get Count of MemberSkill", "operationId": "getSystemMyAccountByParentIdSkillsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myCompany/corporateStructure": { "get": { "tags": [ "CorporateStructures" ], "summary": "Get List of CorporateStructure", "operationId": "getSystemMyCompanyCorporateStructure", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CorporateStructure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateStructure" } } } } } } } }, "/system/myCompany/corporateStructure/{id}": { "get": { "tags": [ "CorporateStructures" ], "summary": "Get CorporateStructure", "operationId": "getSystemMyCompanyCorporateStructureById", "parameters": [ { "name": "id", "in": "path", "description": "corporateStructureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CorporateStructure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CorporateStructure" } } } } } }, "put": { "tags": [ "CorporateStructures" ], "summary": "Put CorporateStructure", "operationId": "putSystemMyCompanyCorporateStructureById", "parameters": [ { "name": "id", "in": "path", "description": "corporateStructureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "corporateStructure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorporateStructure" } } }, "required": true }, "responses": { "200": { "description": "CorporateStructure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CorporateStructure" } } } } } }, "patch": { "tags": [ "CorporateStructures" ], "summary": "Patch CorporateStructure", "operationId": "patchSystemMyCompanyCorporateStructureById", "parameters": [ { "name": "id", "in": "path", "description": "corporateStructureId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CorporateStructure", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CorporateStructure" } } } } } } }, "/system/myCompany/corporateStructure/{id}/info": { "get": { "tags": [ "CorporateStructureInfos" ], "summary": "Get CorporateStructureInfos", "operationId": "getSystemMyCompanyCorporateStructureByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "CorporateStructureInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CorporateStructureInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CorporateStructureInfo" } } } } } } }, "/system/myCompany/corporateStructure/count": { "get": { "tags": [ "CorporateStructures" ], "summary": "Get Count of CorporateStructure", "operationId": "getSystemMyCompanyCorporateStructureCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myCompany/corporateStructure/info": { "get": { "tags": [ "CorporateStructureInfos" ], "summary": "Get List of CorporateStructureInfos", "operationId": "getSystemMyCompanyCorporateStructureInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of corporateStructureInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateStructureInfo" } } } } } } } }, "/system/myCompany/corporateStructure/info/count": { "get": { "tags": [ "CorporateStructureInfos" ], "summary": "Get Count of CorporateStructureInfos", "operationId": "getSystemMyCompanyCorporateStructureInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myCompany/corporateStructureLevels": { "get": { "tags": [ "CorporateStructureLevels" ], "summary": "Get List of CorporateStructureLevel", "operationId": "getSystemMyCompanyCorporateStructureLevels", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CorporateStructureLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CorporateStructureLevel" } } } } } } } }, "/system/myCompany/corporateStructureLevels/{id}": { "get": { "tags": [ "CorporateStructureLevels" ], "summary": "Get CorporateStructureLevel", "operationId": "getSystemMyCompanyCorporateStructureLevelsById", "parameters": [ { "name": "id", "in": "path", "description": "corporateStructureLevelId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CorporateStructureLevel", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CorporateStructureLevel" } } } } } } }, "/system/myCompany/corporateStructureLevels/count": { "get": { "tags": [ "CorporateStructureLevels" ], "summary": "Get Count of CorporateStructureLevel", "operationId": "getSystemMyCompanyCorporateStructureLevelsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myCompany/crm": { "get": { "tags": [ "Crms" ], "summary": "Get List of Crm", "operationId": "getSystemMyCompanyCrm", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Crm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Crm" } } } } } } } }, "/system/myCompany/crm/{id}": { "get": { "tags": [ "Crms" ], "summary": "Get Crm", "operationId": "getSystemMyCompanyCrmById", "parameters": [ { "name": "id", "in": "path", "description": "crmId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Crm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Crm" } } } } } }, "put": { "tags": [ "Crms" ], "summary": "Put Crm", "operationId": "putSystemMyCompanyCrmById", "parameters": [ { "name": "id", "in": "path", "description": "crmId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "crm", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Crm" } } }, "required": true }, "responses": { "200": { "description": "Crm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Crm" } } } } } }, "patch": { "tags": [ "Crms" ], "summary": "Patch Crm", "operationId": "patchSystemMyCompanyCrmById", "parameters": [ { "name": "id", "in": "path", "description": "crmId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Crm", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Crm" } } } } } } }, "/system/myCompany/crm/{id}/info": { "get": { "tags": [ "CrmInfos" ], "summary": "Get CrmInfos", "operationId": "getSystemMyCompanyCrmByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "CrmInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CrmInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/CrmInfo" } } } } } } }, "/system/myCompany/crm/count": { "get": { "tags": [ "Crms" ], "summary": "Get Count of Crm", "operationId": "getSystemMyCompanyCrmCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myCompany/crm/info": { "get": { "tags": [ "CrmInfos" ], "summary": "Get List of CrmInfos", "operationId": "getSystemMyCompanyCrmInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of crmInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CrmInfo" } } } } } } } }, "/system/myCompany/crm/info/count": { "get": { "tags": [ "CrmInfos" ], "summary": "Get Count of CrmInfos", "operationId": "getSystemMyCompanyCrmInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/mycompany/documents": { "get": { "tags": [ "MyCompanyDocumentSetup" ], "summary": "Get List of DocumentSetup", "operationId": "getSystemMycompanyDocuments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSetup" } } } } } } } }, "/system/mycompany/documents/{id}": { "get": { "tags": [ "MyCompanyDocumentSetup" ], "summary": "Get DocumentSetup", "operationId": "getSystemMycompanyDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DocumentSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentSetup" } } } } } }, "put": { "tags": [ "MyCompanyDocumentSetup" ], "summary": "Put DocumentSetup", "operationId": "putSystemMycompanyDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "document", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentSetup" } } }, "required": true }, "responses": { "200": { "description": "DocumentSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentSetup" } } } } } }, "patch": { "tags": [ "MyCompanyDocumentSetup" ], "summary": "Patch DocumentSetup", "operationId": "patchSystemMycompanyDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "DocumentSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/DocumentSetup" } } } } } } }, "/system/mycompany/info/services": { "get": { "tags": [ "MyCompanyServiceInfos" ], "summary": "Get List of ServiceInfo", "operationId": "getSystemMycompanyInfoServices", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceInfo" } } } } } } } }, "/system/mycompany/info/services/{id}": { "get": { "tags": [ "MyCompanyServiceInfos" ], "summary": "Get ServiceInfo", "operationId": "getSystemMycompanyInfoServicesById", "parameters": [ { "name": "id", "in": "path", "description": "serviceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ServiceInfo" } } } } } } }, "/system/myCompany/other": { "get": { "tags": [ "Others" ], "summary": "Get List of Other", "operationId": "getSystemMyCompanyOther", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Other", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Other" } } } } } } } }, "/system/myCompany/other/{id}": { "get": { "tags": [ "Others" ], "summary": "Get Other", "operationId": "getSystemMyCompanyOtherById", "parameters": [ { "name": "id", "in": "path", "description": "otherId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Other", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Other" } } } } } }, "put": { "tags": [ "Others" ], "summary": "Put Other", "operationId": "putSystemMyCompanyOtherById", "parameters": [ { "name": "id", "in": "path", "description": "otherId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "other", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Other" } } }, "required": true }, "responses": { "200": { "description": "Other", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Other" } } } } } }, "patch": { "tags": [ "Others" ], "summary": "Patch Other", "operationId": "patchSystemMyCompanyOtherById", "parameters": [ { "name": "id", "in": "path", "description": "otherId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Other", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Other" } } } } } } }, "/system/myCompany/other/count": { "get": { "tags": [ "Others" ], "summary": "Get Count of Other", "operationId": "getSystemMyCompanyOtherCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/mycompany/reportingServices": { "get": { "tags": [ "ReportingServices" ], "summary": "Get List of ReportingService", "operationId": "getSystemMycompanyReportingServices", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ReportingService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportingService" } } } } } } } }, "/system/mycompany/reportingServices/{id}": { "get": { "tags": [ "ReportingServices" ], "summary": "Get ReportingService", "operationId": "getSystemMycompanyReportingServicesById", "parameters": [ { "name": "id", "in": "path", "description": "reportingServiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ReportingService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportingService" } } } } } }, "put": { "tags": [ "ReportingServices" ], "summary": "Put ReportingService", "operationId": "putSystemMycompanyReportingServicesById", "parameters": [ { "name": "id", "in": "path", "description": "reportingServiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportingService" } } }, "required": true }, "responses": { "200": { "description": "ReportingService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportingService" } } } } } }, "patch": { "tags": [ "ReportingServices" ], "summary": "Patch ReportingService", "operationId": "patchSystemMycompanyReportingServicesById", "parameters": [ { "name": "id", "in": "path", "description": "reportingServiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ReportingService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportingService" } } } } } } }, "/system/mycompany/reportingServices/{id}/testConnection": { "post": { "tags": [ "ReportingServices" ], "summary": "Post SuccessResponse", "operationId": "postSystemMycompanyReportingServicesByIdTestConnection", "parameters": [ { "name": "id", "in": "path", "description": "reportingServiceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/mycompany/services": { "get": { "tags": [ "MyCompanyServices" ], "summary": "Get List of MyCompanyService", "operationId": "getSystemMycompanyServices", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MyCompanyService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Service" } } } } } } } }, "/system/mycompany/services/{id}": { "get": { "tags": [ "MyCompanyServices" ], "summary": "Get MyCompanyService", "operationId": "getSystemMycompanyServicesById", "parameters": [ { "name": "id", "in": "path", "description": "serviceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MyCompanyService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Service" } } } } } }, "put": { "tags": [ "MyCompanyServices" ], "summary": "Put MyCompanyService", "operationId": "putSystemMycompanyServicesById", "parameters": [ { "name": "id", "in": "path", "description": "serviceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Service" } } }, "required": true }, "responses": { "200": { "description": "MyCompanyService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Service" } } } } } }, "patch": { "tags": [ "MyCompanyServices" ], "summary": "Patch MyCompanyService", "operationId": "patchSystemMycompanyServicesById", "parameters": [ { "name": "id", "in": "path", "description": "serviceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MyCompanyService", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Service" } } } } } } }, "/system/myCompany/timeExpense": { "get": { "tags": [ "TimeExpenses" ], "summary": "Get List of TimeExpense", "operationId": "getSystemMyCompanyTimeExpense", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeExpense", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeExpense" } } } } } } } }, "/system/myCompany/timeExpense/{id}": { "get": { "tags": [ "TimeExpenses" ], "summary": "Get TimeExpense", "operationId": "getSystemMyCompanyTimeExpenseById", "parameters": [ { "name": "id", "in": "path", "description": "timeExpenseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeExpense", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeExpense" } } } } } }, "put": { "tags": [ "TimeExpenses" ], "summary": "Put TimeExpense", "operationId": "putSystemMyCompanyTimeExpenseById", "parameters": [ { "name": "id", "in": "path", "description": "timeExpenseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeExpense", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeExpense" } } }, "required": true }, "responses": { "200": { "description": "TimeExpense", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeExpense" } } } } } }, "patch": { "tags": [ "TimeExpenses" ], "summary": "Patch TimeExpense", "operationId": "patchSystemMyCompanyTimeExpenseById", "parameters": [ { "name": "id", "in": "path", "description": "timeExpenseId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimeExpense", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeExpense" } } } } } } }, "/system/myCompany/timeExpense/count": { "get": { "tags": [ "TimeExpenses" ], "summary": "Get Count of TimeExpense", "operationId": "getSystemMyCompanyTimeExpenseCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/myMembers": { "get": { "tags": [ "MyMembers" ], "summary": "Get MyMember", "operationId": "getSystemMyMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MyMember", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MyMember" } } } } } } }, "/system/myMembers/info": { "get": { "tags": [ "MyMemberInfos" ], "summary": "Get MyMemberInfo", "operationId": "getSystemMyMembersInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MyMemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/MyMemberInfo" } } } } } } }, "/system/mySecurity": { "get": { "tags": [ "MySecuritys" ], "summary": "Get List of MySecurity", "operationId": "getSystemMySecurity", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MySecurity", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MySecurity" } } } } } } } }, "/system/mySecurity/customizeItems/": { "get": { "tags": [ "MySecurityCustomizeItems" ], "summary": "Get List of MySecurityCustomizeItems", "operationId": "getSystemMySecurityCustomizeItems", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of mySecurityCustomizeItemses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MySecurityCustomizeItem" } } } } } } } }, "/system/notificationRecipients": { "get": { "tags": [ "NotificationRecipients" ], "summary": "Get List of NotificationRecipient", "operationId": "getSystemNotificationRecipients", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of NotificationRecipient", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationRecipient" } } } } } } } }, "/system/notificationRecipients/{id}": { "get": { "tags": [ "NotificationRecipients" ], "summary": "Get NotificationRecipient", "operationId": "getSystemNotificationRecipientsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationRecipientId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "NotificationRecipient", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/NotificationRecipient" } } } } } } }, "/system/notificationRecipients/count": { "get": { "tags": [ "NotificationRecipients" ], "summary": "Get Count of NotificationRecipient", "operationId": "getSystemNotificationRecipientsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/office365/application/{id}/info": { "get": { "tags": [ "Office365EmailApplicationInfos" ], "summary": "Get Office365EmailApplicationInfos", "operationId": "getSystemOffice365ApplicationByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "Office365EmailApplicationInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Office365EmailApplicationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Office365EmailApplicationInfo" } } } } } } }, "/system/office365/application/info": { "get": { "tags": [ "Office365EmailApplicationInfos" ], "summary": "Get List of Office365EmailApplicationInfos", "operationId": "getSystemOffice365ApplicationInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of office365EmailApplicationInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office365EmailApplicationInfo" } } } } } } } }, "/system/office365/application/info/count": { "get": { "tags": [ "Office365EmailApplicationInfos" ], "summary": "Get Count of Office365EmailApplicationInfos", "operationId": "getSystemOffice365ApplicationInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/office365/emailSetups": { "get": { "tags": [ "Office365EmailSetups" ], "summary": "Get List of Office365EmailSetup", "operationId": "getSystemOffice365EmailSetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Office365EmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Office365EmailSetup" } } } } } } }, "post": { "tags": [ "Office365EmailSetups" ], "summary": "Post Office365EmailSetup", "operationId": "postSystemOffice365EmailSetups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Office365EmailSetup" } } }, "required": true }, "responses": { "201": { "description": "Office365EmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Office365EmailSetup" } } } } } } }, "/system/office365/emailSetups/{id}": { "get": { "tags": [ "Office365EmailSetups" ], "summary": "Get Office365EmailSetup", "operationId": "getSystemOffice365EmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Office365EmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Office365EmailSetup" } } } } } }, "delete": { "tags": [ "Office365EmailSetups" ], "summary": "Delete Office365EmailSetup", "operationId": "deleteSystemOffice365EmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Office365EmailSetups" ], "summary": "Put Office365EmailSetup", "operationId": "putSystemOffice365EmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Office365EmailSetup" } } }, "required": true }, "responses": { "200": { "description": "Office365EmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Office365EmailSetup" } } } } } }, "patch": { "tags": [ "Office365EmailSetups" ], "summary": "Patch Office365EmailSetup", "operationId": "patchSystemOffice365EmailSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Office365EmailSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Office365EmailSetup" } } } } } } }, "/system/office365/emailSetups/{id}/authorize": { "post": { "tags": [ "Office365EmailSetups" ], "summary": "Post SuccessResponse", "operationId": "postSystemOffice365EmailSetupsByIdAuthorize", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/office365/emailSetups/{id}/getEmails/": { "get": { "tags": [ "Office365EmailSetups" ], "summary": "Get List of UserEmails from inbound ticket service", "operationId": "getSystemOffice365EmailSetupsByIdGetEmails", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UserEmail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserEmail" } } } } } } } }, "/system/office365/emailSetups/{id}/testConnection": { "post": { "tags": [ "Office365EmailSetups" ], "summary": "Post SuccessResponse", "operationId": "postSystemOffice365EmailSetupsByIdTestConnection", "parameters": [ { "name": "id", "in": "path", "description": "emailSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/office365/emailSetups/count": { "get": { "tags": [ "Office365EmailSetups" ], "summary": "Get Count of Office365EmailSetup", "operationId": "getSystemOffice365EmailSetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/onPremiseSearchSetting/": { "get": { "tags": [ "OnPremiseSearchSettings" ], "summary": "Get List of OnPremiseSearchSettings", "operationId": "getSystemOnPremiseSearchSetting", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of onPremiseSearchSettings", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OnPremiseSearchSetting" } } } } } } } }, "/system/onPremiseSearchSetting/{id}": { "get": { "tags": [ "OnPremiseSearchSettings" ], "summary": "Get OnPremiseSearchSettings", "operationId": "getSystemOnPremiseSearchSettingById", "parameters": [ { "name": "id", "in": "path", "description": "OnPremiseSearchSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OnPremiseSearchSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OnPremiseSearchSetting" } } } } } }, "put": { "tags": [ "OnPremiseSearchSettings" ], "summary": "Put OnPremiseSearchSettings\r\n This does not update Solr. This allows you to set Manage to the Solr password.", "operationId": "putSystemOnPremiseSearchSettingById", "parameters": [ { "name": "id", "in": "path", "description": "OnPremiseSearchSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "onPremiseSearchSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnPremiseSearchSetting" } } }, "required": true }, "responses": { "200": { "description": "OnPremiseSearchSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OnPremiseSearchSetting" } } } } } }, "patch": { "tags": [ "OnPremiseSearchSettings" ], "summary": "Patch OnPremiseSearchSettings", "operationId": "patchSystemOnPremiseSearchSettingById", "parameters": [ { "name": "id", "in": "path", "description": "OnPremiseSearchSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OnPremiseSearch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OnPremiseSearchSetting" } } } } } } }, "/system/onPremiseSearchSetting/count": { "get": { "tags": [ "OnPremiseSearchSettings" ], "summary": "Get Count of OnPremiseSearchSettings", "operationId": "getSystemOnPremiseSearchSettingCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/osgradeweights": { "get": { "tags": [ "OsGradeWeights" ], "summary": "Get List of OsGradeWeight", "operationId": "getSystemOsgradeweights", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of OsGradeWeight", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OsGradeWeight" } } } } } } } }, "/system/osgradeweights/{id}": { "get": { "tags": [ "OsGradeWeights" ], "summary": "Get OsGradeWeight", "operationId": "getSystemOsgradeweightsById", "parameters": [ { "name": "id", "in": "path", "description": "osgradeweightId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OsGradeWeight", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OsGradeWeight" } } } } } }, "put": { "tags": [ "OsGradeWeights" ], "summary": "Put OsGradeWeight", "operationId": "putSystemOsgradeweightsById", "parameters": [ { "name": "id", "in": "path", "description": "osgradeweightId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "osGradeWeight", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OsGradeWeight" } } }, "required": true }, "responses": { "200": { "description": "OsGradeWeight", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OsGradeWeight" } } } } } }, "patch": { "tags": [ "OsGradeWeights" ], "summary": "Patch OsGradeWeight", "operationId": "patchSystemOsgradeweightsById", "parameters": [ { "name": "id", "in": "path", "description": "osgradeweightId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "OsGradeWeight", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/OsGradeWeight" } } } } } } }, "/system/osgradeweights/count": { "get": { "tags": [ "OsGradeWeights" ], "summary": "Get Count of OsGradeWeight", "operationId": "getSystemOsgradeweightsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/parsingTypes": { "get": { "tags": [ "ParsingTypes" ], "summary": "Get List of ParsingType", "operationId": "getSystemParsingTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ParsingType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ParsingType" } } } } } } } }, "/system/parsingTypes/{id}": { "get": { "tags": [ "ParsingTypes" ], "summary": "Get ParsingType", "operationId": "getSystemParsingTypesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ParsingType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ParsingType" } } } } } } }, "/system/parsingTypes/count": { "get": { "tags": [ "ParsingTypes" ], "summary": "Get Count of ParsingType", "operationId": "getSystemParsingTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/parsingVariables": { "get": { "tags": [ "ParsingVariables" ], "summary": "Get List of ParsingVariable", "operationId": "getSystemParsingVariables", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ParsingVariable", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ParsingVariable" } } } } } } } }, "/system/parsingVariables/{id}": { "get": { "tags": [ "ParsingVariables" ], "summary": "Get ParsingVariable", "operationId": "getSystemParsingVariablesById", "parameters": [ { "name": "id", "in": "path", "description": "parsingVariableId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ParsingVariable", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ParsingVariable" } } } } } } }, "/system/parsingVariables/count": { "get": { "tags": [ "ParsingVariables" ], "summary": "Get Count of ParsingVariable", "operationId": "getSystemParsingVariablesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/portalReports": { "get": { "tags": [ "PortalReports" ], "summary": "Get List of PortalReport", "operationId": "getSystemPortalReports", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalReport" } } } } } } }, "post": { "tags": [ "PortalReports" ], "summary": "Post PortalReport", "operationId": "postSystemPortalReports", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalReport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalReport" } } }, "required": true }, "responses": { "201": { "description": "PortalReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalReport" } } } } } } }, "/system/portalReports/{id}": { "get": { "tags": [ "PortalReports" ], "summary": "Get PortalReport", "operationId": "getSystemPortalReportsById", "parameters": [ { "name": "id", "in": "path", "description": "portalReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PortalReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalReport" } } } } } }, "delete": { "tags": [ "PortalReports" ], "summary": "Delete PortalReport", "operationId": "deleteSystemPortalReportsById", "parameters": [ { "name": "id", "in": "path", "description": "portalReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PortalReports" ], "summary": "Put PortalReport", "operationId": "putSystemPortalReportsById", "parameters": [ { "name": "id", "in": "path", "description": "portalReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "portalReport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalReport" } } }, "required": true }, "responses": { "200": { "description": "PortalReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalReport" } } } } } }, "patch": { "tags": [ "PortalReports" ], "summary": "Patch PortalReport", "operationId": "patchSystemPortalReportsById", "parameters": [ { "name": "id", "in": "path", "description": "portalReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PortalReport", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/PortalReport" } } } } } } }, "/system/portalReports/count": { "get": { "tags": [ "PortalReports" ], "summary": "Get Count of PortalReport", "operationId": "getSystemPortalReportsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/quoteLinkSetup": { "get": { "tags": [ "QuoteLinks" ], "summary": "Get List of QuoteLink", "operationId": "getSystemQuoteLinkSetup", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of QuoteLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteLink" } } } } } } }, "post": { "tags": [ "QuoteLinks" ], "summary": "Post QuoteLink", "operationId": "postSystemQuoteLinkSetup", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "quoteLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteLink" } } }, "required": true }, "responses": { "201": { "description": "QuoteLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/QuoteLink" } } } } } } }, "/system/quoteLinkSetup/{id}": { "get": { "tags": [ "QuoteLinks" ], "summary": "Get QuoteLink", "operationId": "getSystemQuoteLinkSetupById", "parameters": [ { "name": "id", "in": "path", "description": "quoteLinkSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "QuoteLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/QuoteLink" } } } } } }, "delete": { "tags": [ "QuoteLinks" ], "summary": "Delete QuoteLink", "operationId": "deleteSystemQuoteLinkSetupById", "parameters": [ { "name": "id", "in": "path", "description": "quoteLinkSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "QuoteLinks" ], "summary": "Put QuoteLink", "operationId": "putSystemQuoteLinkSetupById", "parameters": [ { "name": "id", "in": "path", "description": "quoteLinkSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "quoteLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteLink" } } }, "required": true }, "responses": { "200": { "description": "QuoteLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/QuoteLink" } } } } } }, "patch": { "tags": [ "QuoteLinks" ], "summary": "Patch QuoteLink", "operationId": "patchSystemQuoteLinkSetupById", "parameters": [ { "name": "id", "in": "path", "description": "quoteLinkSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "QuoteLink", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/QuoteLink" } } } } } } }, "/system/quoteLinkSetup/count": { "get": { "tags": [ "QuoteLinks" ], "summary": "Get Count of QuoteLink", "operationId": "getSystemQuoteLinkSetupCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/quoteLinkSetup/testConnection": { "get": { "tags": [ "QuoteLinks" ], "summary": "Get SuccessResponse", "operationId": "getSystemQuoteLinkSetupTestConnection", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "url", "in": "path", "description": "url", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/reportCards": { "get": { "tags": [ "ReportCards" ], "summary": "Get List of ReportCard", "operationId": "getSystemReportCards", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ReportCard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCard" } } } } } } }, "post": { "tags": [ "ReportCards" ], "summary": "Post ReportCard", "operationId": "postSystemReportCards", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "reportCard", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCard" } } }, "required": true }, "responses": { "201": { "description": "ReportCard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCard" } } } } } } }, "/system/reportCards/{id}": { "get": { "tags": [ "ReportCards" ], "summary": "Get ReportCard", "operationId": "getSystemReportCardsById", "parameters": [ { "name": "id", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ReportCard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCard" } } } } } }, "delete": { "tags": [ "ReportCards" ], "summary": "Delete ReportCard", "operationId": "deleteSystemReportCardsById", "parameters": [ { "name": "id", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ReportCards" ], "summary": "Put ReportCard", "operationId": "putSystemReportCardsById", "parameters": [ { "name": "id", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "reportCard", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCard" } } }, "required": true }, "responses": { "200": { "description": "ReportCard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCard" } } } } } }, "patch": { "tags": [ "ReportCards" ], "summary": "Patch ReportCard", "operationId": "patchSystemReportCardsById", "parameters": [ { "name": "id", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ReportCard", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCard" } } } } } } }, "/system/reportCards/{id}/info": { "get": { "tags": [ "ReportCardInfos" ], "summary": "Get ReportCardInfo", "operationId": "getSystemReportCardsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ReportCardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCardInfo" } } } } } } }, "/system/reportCards/{parentId}/details": { "get": { "tags": [ "ReportCardDetails" ], "summary": "Get List of ReportCardDetail", "operationId": "getSystemReportCardsByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ReportCardDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCardDetail" } } } } } } }, "post": { "tags": [ "ReportCardDetails" ], "summary": "Post ReportCardDetail", "operationId": "postSystemReportCardsByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "reportCardDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCardDetail" } } }, "required": true }, "responses": { "201": { "description": "ReportCardDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCardDetail" } } } } } } }, "/system/reportCards/{parentId}/details/{id}": { "get": { "tags": [ "ReportCardDetails" ], "summary": "Get ReportCardDetail", "operationId": "getSystemReportCardsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ReportCardDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCardDetail" } } } } } }, "delete": { "tags": [ "ReportCardDetails" ], "summary": "Delete ReportCardDetail", "operationId": "deleteSystemReportCardsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ReportCardDetails" ], "summary": "Put ReportCardDetail", "operationId": "putSystemReportCardsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "reportCardDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCardDetail" } } }, "required": true }, "responses": { "200": { "description": "ReportCardDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCardDetail" } } } } } }, "patch": { "tags": [ "ReportCardDetails" ], "summary": "Patch ReportCardDetail", "operationId": "patchSystemReportCardsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ReportCardDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportCardDetail" } } } } } } }, "/system/reportCards/{parentId}/details/count": { "get": { "tags": [ "ReportCardDetails" ], "summary": "Get Count of ReportCardDetail", "operationId": "getSystemReportCardsByParentIdDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "reportCardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/reportCards/count": { "get": { "tags": [ "ReportCards" ], "summary": "Get Count of ReportCard", "operationId": "getSystemReportCardsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/reportCards/info": { "get": { "tags": [ "ReportCardInfos" ], "summary": "Get List of ReportCardInfo", "operationId": "getSystemReportCardsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ReportCardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCardInfo" } } } } } } } }, "/system/reportCards/info/count": { "get": { "tags": [ "ReportCardInfos" ], "summary": "Get Count of ReportCardInfo", "operationId": "getSystemReportCardsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/reports": { "get": { "tags": [ "Reports" ], "summary": "Get List of Report", "operationId": "getSystemReports", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Report", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } } } } } }, "/system/reports/{reportName}": { "get": { "tags": [ "Reports" ], "summary": "Get ReportDataResponse", "operationId": "getSystemReportsByReportName", "parameters": [ { "name": "reportName", "in": "path", "description": "reportName", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ReportDataResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ReportDataResponse" } } } } } } }, "/system/reports/{reportName}/columns": { "get": { "tags": [ "Reports" ], "summary": "Get List of JObject", "operationId": "getSystemReportsByReportNameColumns", "parameters": [ { "name": "reportName", "in": "path", "description": "reportName", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of columns", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReportColumnDefinition" } } } } } } } } }, "/system/reports/{reportName}/count": { "get": { "tags": [ "Reports" ], "summary": "Get Count of ReportDataResponse", "operationId": "getSystemReportsByReportNameCount", "parameters": [ { "name": "reportName", "in": "path", "description": "reportName", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/securityroles": { "get": { "tags": [ "SecurityRoles" ], "summary": "Get List of SecurityRole", "operationId": "getSystemSecurityroles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRole" } } } } } } }, "post": { "tags": [ "SecurityRoles" ], "summary": "Post SecurityRole", "operationId": "postSystemSecurityroles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "securityRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecurityRole" } } }, "required": true }, "responses": { "201": { "description": "SecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SecurityRole" } } } } } } }, "/system/securityroles/{id}": { "get": { "tags": [ "SecurityRoles" ], "summary": "Get SecurityRole", "operationId": "getSystemSecurityrolesById", "parameters": [ { "name": "id", "in": "path", "description": "securityroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SecurityRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SecurityRole" } } } } } }, "delete": { "tags": [ "SecurityRoles" ], "summary": "Delete SecurityRole", "operationId": "deleteSystemSecurityrolesById", "parameters": [ { "name": "id", "in": "path", "description": "securityroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/securityroles/{id}/info": { "get": { "tags": [ "SecurityRoleInfos" ], "summary": "Get SecurityRoleInfo", "operationId": "getSystemSecurityrolesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "securityroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SecurityRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SecurityRoleInfo" } } } } } } }, "/system/securityRoles/{parentId}/settings": { "get": { "tags": [ "SecurityRoleSettings" ], "summary": "Get List of SecurityRoleSetting", "operationId": "getSystemSecurityRolesByParentIdSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SecurityRoleSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRoleSetting" } } } } } } } }, "/system/securityRoles/{parentId}/settings/{id}": { "get": { "tags": [ "SecurityRoleSettings" ], "summary": "Get SecurityRoleSetting", "operationId": "getSystemSecurityRolesByParentIdSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SecurityRoleSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SecurityRoleSetting" } } } } } } }, "/system/securityRoles/{parentId}/settings/count": { "get": { "tags": [ "SecurityRoleSettings" ], "summary": "Get Count of SecurityRoleSetting", "operationId": "getSystemSecurityRolesByParentIdSettingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "securityRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/securityroles/count": { "get": { "tags": [ "SecurityRoles" ], "summary": "Get Count of SecurityRole", "operationId": "getSystemSecurityrolesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/securityroles/info": { "get": { "tags": [ "SecurityRoleInfos" ], "summary": "Get List of SecurityRoleInfo", "operationId": "getSystemSecurityrolesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SecurityRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRoleInfo" } } } } } } } }, "/system/securityroles/info/count": { "get": { "tags": [ "SecurityRoleInfos" ], "summary": "Get Count of SecurityRoleInfo", "operationId": "getSystemSecurityrolesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/settings": { "get": { "tags": [ "SystemSettings" ], "summary": "Get List of SystemSetting", "operationId": "getSystemSettings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SystemSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SystemSetting" } } } } } } } }, "/system/settings/{id}": { "get": { "tags": [ "SystemSettings" ], "summary": "Get SystemSetting", "operationId": "getSystemSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SystemSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SystemSetting" } } } } } }, "put": { "tags": [ "SystemSettings" ], "summary": "Put SystemSetting", "operationId": "putSystemSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "systemSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemSetting" } } }, "required": true }, "responses": { "200": { "description": "SystemSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SystemSetting" } } } } } }, "patch": { "tags": [ "SystemSettings" ], "summary": "Patch SystemSetting", "operationId": "patchSystemSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "settingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SystemSetting", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SystemSetting" } } } } } } }, "/system/settings/count": { "get": { "tags": [ "SystemSettings" ], "summary": "Get Count of SystemSetting", "operationId": "getSystemSettingsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/setupScreens": { "get": { "tags": [ "SetupScreens" ], "summary": "Get List of SetupScreen", "operationId": "getSystemSetupScreens", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SetupScreen", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetupScreen" } } } } } } } }, "/system/setupScreens/{id}": { "get": { "tags": [ "SetupScreens" ], "summary": "Get SetupScreen", "operationId": "getSystemSetupScreensById", "parameters": [ { "name": "id", "in": "path", "description": "setupScreenId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SetupScreen", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SetupScreen" } } } } } } }, "/system/setupScreens/count": { "get": { "tags": [ "SetupScreens" ], "summary": "Get Count of SetupScreen", "operationId": "getSystemSetupScreensCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/skillCategories": { "get": { "tags": [ "SkillCategories" ], "summary": "Get List of SkillCategory", "operationId": "getSystemSkillCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SkillCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkillCategory" } } } } } } }, "post": { "tags": [ "SkillCategories" ], "summary": "Post SkillCategory", "operationId": "postSystemSkillCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "skillCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCategory" } } }, "required": true }, "responses": { "201": { "description": "SkillCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SkillCategory" } } } } } } }, "/system/skillCategories/{id}": { "get": { "tags": [ "SkillCategories" ], "summary": "Get SkillCategory", "operationId": "getSystemSkillCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "skillCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SkillCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SkillCategory" } } } } } }, "delete": { "tags": [ "SkillCategories" ], "summary": "Delete SkillCategory", "operationId": "deleteSystemSkillCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "skillCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SkillCategories" ], "summary": "Put SkillCategory", "operationId": "putSystemSkillCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "skillCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "skillCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCategory" } } }, "required": true }, "responses": { "200": { "description": "SkillCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SkillCategory" } } } } } }, "patch": { "tags": [ "SkillCategories" ], "summary": "Patch SkillCategory", "operationId": "patchSystemSkillCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "skillCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SkillCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SkillCategory" } } } } } } }, "/system/skillCategories/count": { "get": { "tags": [ "SkillCategories" ], "summary": "Get Count of SkillCategory", "operationId": "getSystemSkillCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/skills": { "get": { "tags": [ "Skills" ], "summary": "Get List of Skill", "operationId": "getSystemSkills", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Skill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } } } } } } }, "post": { "tags": [ "Skills" ], "summary": "Post Skill", "operationId": "postSystemSkills", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "skill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Skill" } } }, "required": true }, "responses": { "201": { "description": "Skill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Skill" } } } } } } }, "/system/skills/{id}": { "get": { "tags": [ "Skills" ], "summary": "Get Skill", "operationId": "getSystemSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Skill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Skill" } } } } } }, "delete": { "tags": [ "Skills" ], "summary": "Delete Skill", "operationId": "deleteSystemSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Skills" ], "summary": "Put Skill", "operationId": "putSystemSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "skill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Skill" } } }, "required": true }, "responses": { "200": { "description": "Skill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Skill" } } } } } }, "patch": { "tags": [ "Skills" ], "summary": "Patch Skill", "operationId": "patchSystemSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Skill", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Skill" } } } } } } }, "/system/skills/{id}/info": { "get": { "tags": [ "SkillInfos" ], "summary": "Get SkillInfos", "operationId": "getSystemSkillsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SkillInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SkillInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SkillInfo" } } } } } } }, "/system/skills/count": { "get": { "tags": [ "Skills" ], "summary": "Get Count of Skill", "operationId": "getSystemSkillsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/skills/info": { "get": { "tags": [ "SkillInfos" ], "summary": "Get List of SkillInfos", "operationId": "getSystemSkillsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of skillInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkillInfo" } } } } } } } }, "/system/skills/info/count": { "get": { "tags": [ "SkillInfos" ], "summary": "Get Count of SkillInfos", "operationId": "getSystemSkillsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/ssoConfigurations": { "get": { "tags": [ "SsoConfigurations" ], "summary": "Get List of SsoConfiguration", "operationId": "getSystemSsoConfigurations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } } }, "post": { "tags": [ "SsoConfigurations" ], "summary": "Post SsoConfiguration", "operationId": "postSystemSsoConfigurations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ssoConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } }, "required": true }, "responses": { "201": { "description": "SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } } }, "/system/ssoConfigurations/{id}": { "get": { "tags": [ "SsoConfigurations" ], "summary": "Get SsoConfiguration", "operationId": "getSystemSsoConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ssoConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } }, "put": { "tags": [ "SsoConfigurations" ], "summary": "Put SsoConfiguration", "operationId": "putSystemSsoConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ssoConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ssoConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } }, "required": true }, "responses": { "200": { "description": "SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } }, "patch": { "tags": [ "SsoConfigurations" ], "summary": "Patch SsoConfiguration", "operationId": "patchSystemSsoConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ssoConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } }, "delete": { "tags": [ "SsoConfigurations" ], "summary": "Delete SsoConfiguration", "operationId": "deleteSystemSsoConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ssoConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/ssoConfigurations/{id}/registertoken": { "post": { "tags": [ "SsoConfigurations" ], "summary": "Post SsoConfiguration", "operationId": "postSystemSsoConfigurationsByIdRegistertoken", "parameters": [ { "name": "id", "in": "path", "description": "ssoConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ssoConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } }, "required": true }, "responses": { "201": { "description": "SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } } }, "/system/ssoConfigurations/{id}/submitmembers": { "post": { "tags": [ "SsoConfigurations" ], "summary": "Post SsoConfiguration", "operationId": "postSystemSsoConfigurationsByIdSubmitmembers", "parameters": [ { "name": "id", "in": "path", "description": "ssoConfigurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ssoConfiguration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } }, "required": true }, "responses": { "201": { "description": "SsoConfiguration", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoConfiguration" } } } } } } }, "/system/ssoConfigurations/count": { "get": { "tags": [ "SsoConfigurations" ], "summary": "Get Count of SsoConfiguration", "operationId": "getSystemSsoConfigurationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/ssoUsers": { "get": { "tags": [ "SsoUsers" ], "summary": "Get List of SsoUser", "operationId": "getSystemSsoUsers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SsoUser", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SsoUser" } } } } } } } }, "/system/ssoUsers/{externalId}": { "get": { "tags": [ "SsoUsers" ], "summary": "Get SsoUser", "operationId": "getSystemSsoUsersByExternalId", "parameters": [ { "name": "externalId", "in": "path", "description": "externalId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SsoUser", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SsoUser" } } } } } } }, "/system/ssoUsers/count": { "get": { "tags": [ "SsoUsers" ], "summary": "Get Count of SsoUser", "operationId": "getSystemSsoUsersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/standardNotes": { "get": { "tags": [ "StandardNotes" ], "summary": "Get List of StandardNote", "operationId": "getSystemStandardNotes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of StandardNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StandardNote" } } } } } } }, "post": { "tags": [ "StandardNotes" ], "summary": "Post StandardNote", "operationId": "postSystemStandardNotes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "standardNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardNote" } } }, "required": true }, "responses": { "201": { "description": "StandardNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StandardNote" } } } } } } }, "/system/standardNotes/{id}": { "get": { "tags": [ "StandardNotes" ], "summary": "Get StandardNote", "operationId": "getSystemStandardNotesById", "parameters": [ { "name": "id", "in": "path", "description": "standardNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "StandardNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StandardNote" } } } } } }, "delete": { "tags": [ "StandardNotes" ], "summary": "Delete StandardNote", "operationId": "deleteSystemStandardNotesById", "parameters": [ { "name": "id", "in": "path", "description": "standardNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "StandardNotes" ], "summary": "Put StandardNote", "operationId": "putSystemStandardNotesById", "parameters": [ { "name": "id", "in": "path", "description": "standardNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "standardNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StandardNote" } } }, "required": true }, "responses": { "200": { "description": "StandardNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StandardNote" } } } } } }, "patch": { "tags": [ "StandardNotes" ], "summary": "Patch StandardNote", "operationId": "patchSystemStandardNotesById", "parameters": [ { "name": "id", "in": "path", "description": "standardNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "StandardNote", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/StandardNote" } } } } } } }, "/system/standardNotes/count": { "get": { "tags": [ "StandardNotes" ], "summary": "Get Count of StandardNote", "operationId": "getSystemStandardNotesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/surveys": { "get": { "tags": [ "Surveys" ], "summary": "Get List of Survey", "operationId": "getSystemSurveys", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Survey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Survey" } } } } } } }, "post": { "tags": [ "Surveys" ], "summary": "Post Survey", "operationId": "postSystemSurveys", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "survey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } } }, "required": true }, "responses": { "201": { "description": "Survey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Survey" } } } } } } }, "/system/surveys/{grandparentId}/questions/{parentId}/values": { "get": { "tags": [ "SurveyQuestionValues" ], "summary": "Get List of SurveyQuestionValue", "operationId": "getSystemSurveysByGrandparentIdQuestionsByParentIdValues", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyQuestionValue" } } } } } } }, "post": { "tags": [ "SurveyQuestionValues" ], "summary": "Post SurveyQuestionValue", "operationId": "postSystemSurveysByGrandparentIdQuestionsByParentIdValues", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyQuestionValue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyQuestionValue" } } }, "required": true }, "responses": { "201": { "description": "SurveyQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestionValue" } } } } } } }, "/system/surveys/{grandparentId}/questions/{parentId}/values/{id}": { "get": { "tags": [ "SurveyQuestionValues" ], "summary": "Get SurveyQuestionValue", "operationId": "getSystemSurveysByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestionValue" } } } } } }, "delete": { "tags": [ "SurveyQuestionValues" ], "summary": "Delete SurveyQuestionValue", "operationId": "deleteSystemSurveysByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SurveyQuestionValues" ], "summary": "Put SurveyQuestionValue", "operationId": "putSystemSurveysByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyQuestionValue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyQuestionValue" } } }, "required": true }, "responses": { "200": { "description": "SurveyQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestionValue" } } } } } }, "patch": { "tags": [ "SurveyQuestionValues" ], "summary": "Patch SurveyQuestionValue", "operationId": "patchSystemSurveysByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SurveyQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestionValue" } } } } } } }, "/system/surveys/{id}": { "get": { "tags": [ "Surveys" ], "summary": "Get Survey", "operationId": "getSystemSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Survey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Survey" } } } } } }, "delete": { "tags": [ "Surveys" ], "summary": "Delete Survey", "operationId": "deleteSystemSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Surveys" ], "summary": "Put Survey", "operationId": "putSystemSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "survey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } } }, "required": true }, "responses": { "200": { "description": "Survey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Survey" } } } } } }, "patch": { "tags": [ "Surveys" ], "summary": "Patch Survey", "operationId": "patchSystemSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Survey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Survey" } } } } } } }, "/system/surveys/{id}/copy": { "post": { "tags": [ "Surveys" ], "summary": "Post Survey", "operationId": "postSystemSurveysByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Survey", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Survey" } } } } } } }, "/system/surveys/{id}/info": { "get": { "tags": [ "SurveyInfos" ], "summary": "Get Survey", "operationId": "getSystemSurveysByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyInfo" } } } } } } }, "/system/surveys/{parentId}/questions": { "get": { "tags": [ "SurveyQuestions" ], "summary": "Get List of SurveyQuestion", "operationId": "getSystemSurveysByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyQuestion" } } } } } } }, "post": { "tags": [ "SurveyQuestions" ], "summary": "Post SurveyQuestion", "operationId": "postSystemSurveysByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyQuestion" } } }, "required": true }, "responses": { "201": { "description": "SurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestion" } } } } } } }, "/system/surveys/{parentId}/questions/{id}": { "get": { "tags": [ "SurveyQuestions" ], "summary": "Get SurveyQuestion", "operationId": "getSystemSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestion" } } } } } }, "delete": { "tags": [ "SurveyQuestions" ], "summary": "Delete SurveyQuestion", "operationId": "deleteSystemSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SurveyQuestions" ], "summary": "Put SurveyQuestion", "operationId": "putSystemSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyQuestion" } } }, "required": true }, "responses": { "200": { "description": "SurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestion" } } } } } }, "patch": { "tags": [ "SurveyQuestions" ], "summary": "Patch SurveyQuestion", "operationId": "patchSystemSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SurveyQuestion" } } } } } } }, "/system/surveys/{parentId}/questions/count": { "get": { "tags": [ "SurveyQuestions" ], "summary": "Get Count of SurveyQuestion", "operationId": "getSystemSurveysByParentIdQuestionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/surveys/count": { "get": { "tags": [ "Surveys" ], "summary": "Get Count of Survey", "operationId": "getSystemSurveysCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/surveys/info": { "get": { "tags": [ "SurveyInfos" ], "summary": "Get List of SurveyInfos", "operationId": "getSystemSurveysInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyInfos", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyInfo" } } } } } } } }, "/system/surveys/info/count": { "get": { "tags": [ "SurveyInfos" ], "summary": "Get Count of SurveyInfos", "operationId": "getSystemSurveysInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/timeZoneSetups": { "get": { "tags": [ "TimeZoneSetups" ], "summary": "Get List of TimeZoneSetup", "operationId": "getSystemTimeZoneSetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeZoneSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZoneSetup" } } } } } } }, "post": { "tags": [ "TimeZoneSetups" ], "summary": "Post TimeZoneSetup", "operationId": "postSystemTimeZoneSetups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeZoneSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeZoneSetup" } } }, "required": true }, "responses": { "201": { "description": "TimeZoneSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeZoneSetup" } } } } } } }, "/system/timeZoneSetups/{id}": { "get": { "tags": [ "TimeZoneSetups" ], "summary": "Get TimeZoneSetup", "operationId": "getSystemTimeZoneSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timeZoneSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeZoneSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeZoneSetup" } } } } } }, "put": { "tags": [ "TimeZoneSetups" ], "summary": "Put TimeZoneSetup", "operationId": "putSystemTimeZoneSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timeZoneSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeZoneSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeZoneSetup" } } }, "required": true }, "responses": { "200": { "description": "TimeZoneSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeZoneSetup" } } } } } }, "patch": { "tags": [ "TimeZoneSetups" ], "summary": "Patch TimeZoneSetup", "operationId": "patchSystemTimeZoneSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timeZoneSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimeZoneSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeZoneSetup" } } } } } }, "delete": { "tags": [ "TimeZoneSetups" ], "summary": "Delete TimeZoneSetup", "operationId": "deleteSystemTimeZoneSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timeZoneSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/timeZoneSetups/{id}/info": { "get": { "tags": [ "TimeZoneSetupInfos" ], "summary": "Get TimeZoneSetupInfos", "operationId": "getSystemTimeZoneSetupsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "TimeZoneSetupInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeZoneSetupInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeZoneSetupInfo" } } } } } } }, "/system/timeZoneSetups/count": { "get": { "tags": [ "TimeZoneSetups" ], "summary": "Get Count of TimeZoneSetup", "operationId": "getSystemTimeZoneSetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/timeZoneSetups/info": { "get": { "tags": [ "TimeZoneSetupInfos" ], "summary": "Get List of TimeZoneSetupInfos", "operationId": "getSystemTimeZoneSetupsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of timeZoneSetupInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeZoneSetupInfo" } } } } } } } }, "/system/timeZoneSetups/info/count": { "get": { "tags": [ "TimeZoneSetupInfos" ], "summary": "Get Count of TimeZoneSetupInfos", "operationId": "getSystemTimeZoneSetupsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/todayPageCategories": { "get": { "tags": [ "TodayPageCategories" ], "summary": "Get List of TodayPageCategory", "operationId": "getSystemTodayPageCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TodayPageCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TodayPageCategory" } } } } } } }, "post": { "tags": [ "TodayPageCategories" ], "summary": "Post TodayPageCategory", "operationId": "postSystemTodayPageCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "todayPageCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodayPageCategory" } } }, "required": true }, "responses": { "201": { "description": "TodayPageCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TodayPageCategory" } } } } } } }, "/system/todayPageCategories/{id}": { "get": { "tags": [ "TodayPageCategories" ], "summary": "Get TodayPageCategory", "operationId": "getSystemTodayPageCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "todayPageCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TodayPageCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TodayPageCategory" } } } } } }, "delete": { "tags": [ "TodayPageCategories" ], "summary": "Delete TodayPageCategory", "operationId": "deleteSystemTodayPageCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "todayPageCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TodayPageCategories" ], "summary": "Put TodayPageCategory", "operationId": "putSystemTodayPageCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "todayPageCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "todayPageCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodayPageCategory" } } }, "required": true }, "responses": { "200": { "description": "TodayPageCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TodayPageCategory" } } } } } }, "patch": { "tags": [ "TodayPageCategories" ], "summary": "Patch TodayPageCategory", "operationId": "patchSystemTodayPageCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "todayPageCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TodayPageCategory", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TodayPageCategory" } } } } } } }, "/system/todayPageCategories/count": { "get": { "tags": [ "TodayPageCategories" ], "summary": "Get Count of TodayPageCategory", "operationId": "getSystemTodayPageCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/userDefinedFields": { "get": { "tags": [ "UserDefinedFields" ], "summary": "Get List of UserDefinedField", "operationId": "getSystemUserDefinedFields", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of UserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedField" } } } } } } }, "post": { "tags": [ "UserDefinedFields" ], "summary": "Post UserDefinedField", "operationId": "postSystemUserDefinedFields", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "userDefinedField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDefinedField" } } }, "required": true }, "responses": { "201": { "description": "UserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UserDefinedField" } } } } } } }, "/system/userDefinedFields/{id}": { "get": { "tags": [ "UserDefinedFields" ], "summary": "Get UserDefinedField", "operationId": "getSystemUserDefinedFieldsById", "parameters": [ { "name": "id", "in": "path", "description": "userDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UserDefinedField" } } } } } }, "delete": { "tags": [ "UserDefinedFields" ], "summary": "Delete UserDefinedField", "operationId": "deleteSystemUserDefinedFieldsById", "parameters": [ { "name": "id", "in": "path", "description": "userDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "UserDefinedFields" ], "summary": "Put UserDefinedField", "operationId": "putSystemUserDefinedFieldsById", "parameters": [ { "name": "id", "in": "path", "description": "userDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "userDefinedField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDefinedField" } } }, "required": true }, "responses": { "200": { "description": "UserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UserDefinedField" } } } } } }, "patch": { "tags": [ "UserDefinedFields" ], "summary": "Patch UserDefinedField", "operationId": "patchSystemUserDefinedFieldsById", "parameters": [ { "name": "id", "in": "path", "description": "userDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "UserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UserDefinedField" } } } } } } }, "/system/userDefinedFields/{id}/info": { "get": { "tags": [ "UserDefinedFieldInfos" ], "summary": "Get UserDefinedFieldInfos", "operationId": "getSystemUserDefinedFieldsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "UserDefinedFieldInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "UserDefinedFieldInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/UserDefinedFieldInfo" } } } } } } }, "/system/userDefinedFields/count": { "get": { "tags": [ "UserDefinedFields" ], "summary": "Get Count of UserDefinedField", "operationId": "getSystemUserDefinedFieldsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/userDefinedFields/info": { "get": { "tags": [ "UserDefinedFieldInfos" ], "summary": "Get List of UserDefinedFieldInfos", "operationId": "getSystemUserDefinedFieldsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of userDefinedFieldInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldInfo" } } } } } } } }, "/system/userDefinedFields/info/count": { "get": { "tags": [ "UserDefinedFieldInfos" ], "summary": "Get Count of UserDefinedFieldInfos", "operationId": "getSystemUserDefinedFieldsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflowActions/{parentId}/automateParameters": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get List of WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsByParentIdAutomateParameters", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "post": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Post WorkflowActionAutomateParameter", "operationId": "postSystemWorkflowActionsByParentIdAutomateParameters", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionAutomateParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } }, "required": true }, "responses": { "201": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "/system/workflowActions/{parentId}/automateParameters/{id}": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } }, "delete": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Delete WorkflowActionAutomateParameter", "operationId": "deleteSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Put WorkflowActionAutomateParameter", "operationId": "putSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionAutomateParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } }, "patch": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Patch WorkflowActionAutomateParameter", "operationId": "patchSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "/system/workflowActions/{parentId}/automateParameters/count": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get Count of WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsByParentIdAutomateParametersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflowActions/automateParameters": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get List of WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsAutomateParameters", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } } }, "/system/workflowActions/automateParameters/{id}": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "/system/workflows": { "get": { "tags": [ "Workflows" ], "summary": "Get List of Workflow", "operationId": "getSystemWorkflows", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "post": { "tags": [ "Workflows" ], "summary": "Post Workflow", "operationId": "postSystemWorkflows", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "required": true }, "responses": { "201": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "/system/workflows/{grandparentId}/events/{parentId}/actions": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get List of WorkflowAction", "operationId": "getSystemWorkflowsByGrandparentIdEventsByParentIdActions", "parameters": [ { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "post": { "tags": [ "WorkflowActions" ], "summary": "Post WorkflowAction", "operationId": "postSystemWorkflowsByGrandparentIdEventsByParentIdActions", "parameters": [ { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } }, "required": true }, "responses": { "201": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "/system/workflows/{grandparentId}/events/{parentId}/actions/{id}": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get WorkflowAction", "operationId": "getSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } }, "delete": { "tags": [ "WorkflowActions" ], "summary": "Delete WorkflowAction", "operationId": "deleteSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkflowActions" ], "summary": "Put WorkflowAction", "operationId": "putSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } }, "required": true }, "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } }, "patch": { "tags": [ "WorkflowActions" ], "summary": "Patch WorkflowAction", "operationId": "patchSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "/system/workflows/{grandparentId}/events/{parentId}/actions/count": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get Count of WorkflowAction", "operationId": "getSystemWorkflowsByGrandparentIdEventsByParentIdActionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{grandparentId}/triggers/{parentId}/options": { "get": { "tags": [ "WorkflowTriggerOptions" ], "summary": "Get List of WorkflowTriggerOption", "operationId": "getSystemWorkflowsByGrandparentIdTriggersByParentIdOptions", "parameters": [ { "name": "parentId", "in": "path", "description": "triggerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTriggerOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTriggerOption" } } } } } } } }, "/system/workflows/{grandparentId}/triggers/{parentId}/options/count": { "get": { "tags": [ "WorkflowTriggerOptions" ], "summary": "Get Count of WorkflowTriggerOption", "operationId": "getSystemWorkflowsByGrandparentIdTriggersByParentIdOptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "triggerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{id}": { "get": { "tags": [ "Workflows" ], "summary": "Get Workflow", "operationId": "getSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } }, "delete": { "tags": [ "Workflows" ], "summary": "Delete Workflow", "operationId": "deleteSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Workflows" ], "summary": "Put Workflow", "operationId": "putSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "required": true }, "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } }, "patch": { "tags": [ "Workflows" ], "summary": "Patch Workflow", "operationId": "patchSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "/system/workflows/{id}/copy": { "post": { "tags": [ "Workflows" ], "summary": "Post Workflow", "operationId": "postSystemWorkflowsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "/system/workflows/{parentId}/attachments": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get List of WorkflowAttachment", "operationId": "getSystemWorkflowsByParentIdAttachments", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } } }, "/system/workflows/{parentId}/attachments/{id}": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get WorkflowAttachment", "operationId": "getSystemWorkflowsByParentIdAttachmentsById", "parameters": [ { "name": "id", "in": "path", "description": "attachmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } }, "/system/workflows/{parentId}/attachments/count": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get Count of WorkflowAttachment", "operationId": "getSystemWorkflowsByParentIdAttachmentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/events": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get List of WorkflowEvent", "operationId": "getSystemWorkflowsByParentIdEvents", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "post": { "tags": [ "WorkflowEvents" ], "summary": "Post WorkflowEvent", "operationId": "postSystemWorkflowsByParentIdEvents", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowEvent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } }, "required": true }, "responses": { "201": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/{parentId}/events/{id}": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get WorkflowEvent", "operationId": "getSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } }, "delete": { "tags": [ "WorkflowEvents" ], "summary": "Delete WorkflowEvent", "operationId": "deleteSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkflowEvents" ], "summary": "Put WorkflowEvent", "operationId": "putSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowEvent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } }, "required": true }, "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } }, "patch": { "tags": [ "WorkflowEvents" ], "summary": "Patch WorkflowEvent", "operationId": "patchSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/{parentId}/events/{id}/copy": { "post": { "tags": [ "WorkflowEvents" ], "summary": "Post WorkflowEvent", "operationId": "postSystemWorkflowsByParentIdEventsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/{parentId}/events/{id}/test": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get workflow test results", "operationId": "getSystemWorkflowsByParentIdEventsByIdTest", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of test results", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } } }, "/system/workflows/{parentId}/events/count": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get Count of WorkflowEvent", "operationId": "getSystemWorkflowsByParentIdEventsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/notifyTypes": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get List of WorkflowNotifyType", "operationId": "getSystemWorkflowsByParentIdNotifyTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } } }, "/system/workflows/{parentId}/notifyTypes/{id}": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get WorkflowNotifyType", "operationId": "getSystemWorkflowsByParentIdNotifyTypesById", "parameters": [ { "name": "id", "in": "path", "description": "notifyTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } }, "/system/workflows/{parentId}/notifyTypes/{id}/info": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get WorkflowNotifyTypeInfo", "operationId": "getSystemWorkflowsByParentIdNotifyTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "notifyTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowNotifyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowNotifyTypeInfo" } } } } } } }, "/system/workflows/{parentId}/notifyTypes/count": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get Count of WorkflowNotifyType", "operationId": "getSystemWorkflowsByParentIdNotifyTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/notifyTypes/info": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get List of WorkflowNotifyTypeInfo", "operationId": "getSystemWorkflowsByParentIdNotifyTypesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyTypeInfo" } } } } } } } }, "/system/workflows/{parentId}/notifyTypes/info/count": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get Count of WorkflowNotifyTypeInfo", "operationId": "getSystemWorkflowsByParentIdNotifyTypesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/triggers": { "get": { "tags": [ "WorkflowTriggers" ], "summary": "Get List of WorkflowTrigger", "operationId": "getSystemWorkflowsByParentIdTriggers", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTrigger", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTrigger" } } } } } } } }, "/system/workflows/{parentId}/triggers/count": { "get": { "tags": [ "WorkflowTriggers" ], "summary": "Get Count of WorkflowTrigger", "operationId": "getSystemWorkflowsByParentIdTriggersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/attachments": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get List of WorkflowAttachment", "operationId": "getSystemWorkflowsAttachments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } } }, "/system/workflows/attachments/{id}": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get WorkflowAttachment", "operationId": "getSystemWorkflowsAttachmentsById", "parameters": [ { "name": "id", "in": "path", "description": "attachmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } } }, "/system/workflows/count": { "get": { "tags": [ "Workflows" ], "summary": "Get Count of Workflow", "operationId": "getSystemWorkflowsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/events": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get List of WorkflowEvent", "operationId": "getSystemWorkflowsEvents", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } } }, "/system/workflows/events/{id}": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get WorkflowEvent", "operationId": "getSystemWorkflowsEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/events/actions": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get List of WorkflowAction", "operationId": "getSystemWorkflowsEventsActions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } } }, "/system/workflows/events/actions/{id}": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get WorkflowAction", "operationId": "getSystemWorkflowsEventsActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "/system/workflows/notifyTypes": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get List of WorkflowNotifyType", "operationId": "getSystemWorkflowsNotifyTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } } }, "/system/workflows/notifyTypes/{id}": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get WorkflowNotifyType", "operationId": "getSystemWorkflowsNotifyTypesById", "parameters": [ { "name": "id", "in": "path", "description": "notifyTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } } }, "/system/workflows/tableTypes": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get List of WorkflowTableType", "operationId": "getSystemWorkflowsTableTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTableType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTableType" } } } } } } } }, "/system/workflows/tableTypes/{id}": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get WorkflowTableType", "operationId": "getSystemWorkflowsTableTypesById", "parameters": [ { "name": "id", "in": "path", "description": "tableTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowTableType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowTableType" } } } } } } }, "/system/workflows/tableTypes/{id}/info": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get WorkflowTableTypeInfo", "operationId": "getSystemWorkflowsTableTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "tableTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowTableTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowTableTypeInfo" } } } } } } }, "/system/workflows/tableTypes/count": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get Count of WorkflowTableType", "operationId": "getSystemWorkflowsTableTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/tableTypes/info": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get List of WorkflowTableTypeInfo", "operationId": "getSystemWorkflowsTableTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTableTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTableTypeInfo" } } } } } } } }, "/system/workflows/tableTypes/info/count": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get Count of WorkflowTableTypeInfo", "operationId": "getSystemWorkflowsTableTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/triggers": { "get": { "tags": [ "WorkflowTriggers" ], "summary": "Get List of WorkflowTrigger", "operationId": "getSystemWorkflowsTriggers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTrigger", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTrigger" } } } } } } } }, "/system/workflows/triggers/options": { "get": { "tags": [ "WorkflowTriggerOptions" ], "summary": "Get List of WorkflowTriggerOption", "operationId": "getSystemWorkflowsTriggersOptions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTriggerOption", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTriggerOption" } } } } } } } }, "/system/workflows/userdefinedfields/{id}": { "put": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Put WorkflowActionUserDefinedField", "operationId": "putSystemWorkflowsUserdefinedfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowActionUserDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionUserDefinedField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } }, "patch": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Patch WorkflowActionUserDefinedField", "operationId": "patchSystemWorkflowsUserdefinedfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowActionUserDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } }, "/system/workflows/userdefinedfields/actions/{parentId}": { "delete": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Delete WorkflowActionUserDefinedField", "operationId": "deleteSystemWorkflowsUserdefinedfieldsActionsByParentId", "parameters": [ { "name": "parentId", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/workflows/userdefinedfields/events/{grandparentId}": { "post": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Post WorkflowActionUserDefinedField", "operationId": "postSystemWorkflowsUserdefinedfieldsEventsByGrandparentId", "parameters": [ { "name": "grandparentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionUserDefinedField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } }, "required": true }, "responses": { "201": { "description": "WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } }, "/system/workflows/userdefinedfields/events/{grandparentId}/actions/{parentId}": { "get": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Get List of WorkflowActionUserDefinedField", "operationId": "getSystemWorkflowsUserdefinedfieldsEventsByGrandparentIdActionsByParentId", "parameters": [ { "name": "parentId", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "evnetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } } }, "/system/workflows/userdefinedfields/events/actions": { "get": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Get List of WorkflowActionUserDefinedField", "operationId": "getSystemWorkflowsUserdefinedfieldsEventsActions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } } }, "/time/accruals": { "get": { "tags": [ "TimeAccruals" ], "summary": "Get List of TimeAccrual", "operationId": "getTimeAccruals", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeAccrual" } } } } } } }, "post": { "tags": [ "TimeAccruals" ], "summary": "Post TimeAccrual", "operationId": "postTimeAccruals", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeAccrual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeAccrual" } } }, "required": true }, "responses": { "201": { "description": "TimeAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrual" } } } } } } }, "/time/accruals/{id}": { "get": { "tags": [ "TimeAccruals" ], "summary": "Get TimeAccrual", "operationId": "getTimeAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrual" } } } } } }, "delete": { "tags": [ "TimeAccruals" ], "summary": "Delete TimeAccrual", "operationId": "deleteTimeAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TimeAccruals" ], "summary": "Put TimeAccrual", "operationId": "putTimeAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeAccrual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeAccrual" } } }, "required": true }, "responses": { "200": { "description": "TimeAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrual" } } } } } }, "patch": { "tags": [ "TimeAccruals" ], "summary": "Patch TimeAccrual", "operationId": "patchTimeAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimeAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrual" } } } } } } }, "/time/accruals/{parentId}/details": { "get": { "tags": [ "TimeAccrualDetails" ], "summary": "Get List of TimeAccrualDetail", "operationId": "getTimeAccrualsByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeAccrualDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeAccrualDetail" } } } } } } } }, "/time/accruals/{parentId}/details/": { "post": { "tags": [ "TimeAccrualDetails" ], "summary": "Post TimeAccrualDetail", "operationId": "postTimeAccrualsByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeAccrualDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeAccrualDetail" } } }, "required": true }, "responses": { "201": { "description": "TimeAccrualDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrualDetail" } } } } } } }, "/time/accruals/{parentId}/details/{id}": { "get": { "tags": [ "TimeAccrualDetails" ], "summary": "Get TimeAccrualDetail", "operationId": "getTimeAccrualsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeAccrualDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrualDetail" } } } } } }, "delete": { "tags": [ "TimeAccrualDetails" ], "summary": "Delete TimeAccrualDetail", "operationId": "deleteTimeAccrualsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TimeAccrualDetails" ], "summary": "Put TimeAccrualDetail", "operationId": "putTimeAccrualsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeAccrualDetail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeAccrualDetail" } } }, "required": true }, "responses": { "200": { "description": "TimeAccrualDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrualDetail" } } } } } }, "patch": { "tags": [ "TimeAccrualDetails" ], "summary": "Patch TimeAccrualDetail", "operationId": "patchTimeAccrualsByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimeAccrualDetail", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeAccrualDetail" } } } } } } }, "/time/accruals/{parentId}/details/count": { "get": { "tags": [ "TimeAccrualDetails" ], "summary": "Get Count of TimeAccrualDetail", "operationId": "getTimeAccrualsByParentIdDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/accruals/count": { "get": { "tags": [ "TimeAccruals" ], "summary": "Get Count of TimeAccrual", "operationId": "getTimeAccrualsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/activitystopwatches": { "get": { "tags": [ "ActivityStopwatches" ], "summary": "Get List of ActivityStopwatch", "operationId": "getTimeActivitystopwatches", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStopwatch" } } } } } } }, "post": { "tags": [ "ActivityStopwatches" ], "summary": "Post ActivityStopwatch", "operationId": "postTimeActivitystopwatches", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityStopwatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStopwatch" } } }, "required": true }, "responses": { "201": { "description": "ActivityStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStopwatch" } } } } } } }, "/time/activitystopwatches/{id}": { "get": { "tags": [ "ActivityStopwatches" ], "summary": "Get ActivityStopwatch", "operationId": "getTimeActivitystopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "activitystopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStopwatch" } } } } } }, "delete": { "tags": [ "ActivityStopwatches" ], "summary": "Delete ActivityStopwatch", "operationId": "deleteTimeActivitystopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "activitystopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ActivityStopwatches" ], "summary": "Put ActivityStopwatch", "operationId": "putTimeActivitystopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "activitystopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityStopwatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStopwatch" } } }, "required": true }, "responses": { "200": { "description": "ActivityStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStopwatch" } } } } } }, "patch": { "tags": [ "ActivityStopwatches" ], "summary": "Patch ActivityStopwatch", "operationId": "patchTimeActivitystopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "activitystopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ActivityStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ActivityStopwatch" } } } } } } }, "/time/activitystopwatches/count": { "get": { "tags": [ "ActivityStopwatches" ], "summary": "Get Count of ActivityStopwatch", "operationId": "getTimeActivitystopwatchesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/changelogs": { "get": { "tags": [ "TimeEntryChangeLog" ], "summary": "Get List of Time Entry Change Logs", "operationId": "getTimeChangelogs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryChangeLog", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryChangeLog" } } } } } } }, "delete": { "tags": [ "TimeEntriesChangeLog" ], "summary": "Delete Time Entry Change Logs", "operationId": "deleteTimeChangelogs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/time/chargeCodes": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of ChargeCode", "operationId": "getTimeChargeCodes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCode" } } } } } } }, "post": { "tags": [ "ChargeCodes" ], "summary": "Post ChargeCode", "operationId": "postTimeChargeCodes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCode", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } }, "required": true }, "responses": { "201": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } } }, "/time/chargeCodes/{id}": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get ChargeCode", "operationId": "getTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } }, "delete": { "tags": [ "ChargeCodes" ], "summary": "Delete ChargeCode", "operationId": "deleteTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ChargeCodes" ], "summary": "Put ChargeCode", "operationId": "putTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCode", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } }, "required": true }, "responses": { "200": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } }, "patch": { "tags": [ "ChargeCodes" ], "summary": "Patch ChargeCode", "operationId": "patchTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } } }, "/time/chargeCodes/{id}/info": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get ChargeCodeInfo", "operationId": "getTimeChargeCodesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ChargeCodeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCodeInfo" } } } } } } }, "/time/chargeCodes/{id}/usages": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of Usage Count", "operationId": "getTimeChargeCodesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/chargeCodes/{id}/usages/list": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of Usage", "operationId": "getTimeChargeCodesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/chargeCodes/{parentId}/expenseTypes": { "get": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Get List of ChargeCodeExpenseType", "operationId": "getTimeChargeCodesByParentIdExpenseTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } }, "post": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Post ChargeCodeExpenseType", "operationId": "postTimeChargeCodesByParentIdExpenseTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCodeExpenseType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } }, "required": true }, "responses": { "201": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } }, "/time/chargeCodes/{parentId}/expenseTypes/{id}": { "get": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Get ChargeCodeExpenseType", "operationId": "getTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } }, "delete": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Delete ChargeCodeExpenseType", "operationId": "deleteTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Put ChargeCodeExpenseType", "operationId": "putTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCodeExpenseType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } }, "required": true }, "responses": { "200": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } }, "patch": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Patch ChargeCodeExpenseType", "operationId": "patchTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } }, "/time/chargeCodes/{parentId}/expenseTypes/count": { "get": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Get Count of ChargeCodeExpenseType", "operationId": "getTimeChargeCodesByParentIdExpenseTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/chargeCodes/count": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get Count of ChargeCode", "operationId": "getTimeChargeCodesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/chargeCodes/info": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of ChargeCodeInfo", "operationId": "getTimeChargeCodesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCodeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCodeInfo" } } } } } } } }, "/time/chargeCodes/info/count": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get Count of ChargeCodeInfo", "operationId": "getTimeChargeCodesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/entries": { "get": { "tags": [ "TimeEntries" ], "summary": "Get List of TimeEntry", "operationId": "getTimeEntries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "post": { "tags": [ "TimeEntries" ], "summary": "Post TimeEntry", "operationId": "postTimeEntries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "201": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/time/entries/{id}": { "get": { "tags": [ "TimeEntries" ], "summary": "Get TimeEntry", "operationId": "getTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "delete": { "tags": [ "TimeEntries" ], "summary": "Delete TimeEntry", "operationId": "deleteTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TimeEntries" ], "summary": "Put TimeEntry", "operationId": "putTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "patch": { "tags": [ "TimeEntries" ], "summary": "Patch TimeEntry", "operationId": "patchTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/time/entries/{parentId}/audits": { "get": { "tags": [ "TimeEntryAudits" ], "summary": "Get List of TimeEntryAudit", "operationId": "getTimeEntriesByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryAudit" } } } } } } } }, "/time/entries/{parentId}/audits/{id}": { "get": { "tags": [ "TimeEntryAudits" ], "summary": "Get TimeEntryAudit", "operationId": "getTimeEntriesByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeEntryAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeEntryAudit" } } } } } } }, "/time/entries/{parentId}/audits/count": { "get": { "tags": [ "TimeEntryAudits" ], "summary": "Get Count of TimeEntryAudit", "operationId": "getTimeEntriesByParentIdAuditsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/entries/count": { "get": { "tags": [ "TimeEntries" ], "summary": "Get Count of TimeEntry", "operationId": "getTimeEntriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/entries/defaults": { "post": { "tags": [ "TimeEntries" ], "summary": "Post TimeEntry", "operationId": "postTimeEntriesDefaults", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/time/info/chargeCodeExpenseTypes": { "get": { "tags": [ "ChargeCodeExpenseTypeInfos" ], "summary": "Get List of ChargeCodeExpenseType", "operationId": "getTimeInfoChargeCodeExpenseTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } } }, "/time/info/chargeCodeExpenseTypes/count": { "get": { "tags": [ "ChargeCodeExpenseTypeInfos" ], "summary": "Get Count of ChargeCodeExpenseType", "operationId": "getTimeInfoChargeCodeExpenseTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/schedulestopwatches": { "get": { "tags": [ "ScheduleStopwatch" ], "summary": "Get List of ScheduleStopwatch", "operationId": "getTimeSchedulestopwatches", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleStopwatch" } } } } } } }, "post": { "tags": [ "ScheduleStopwatch" ], "summary": "Post ScheduleStopwatch", "operationId": "postTimeSchedulestopwatches", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleStopwatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleStopwatch" } } }, "required": true }, "responses": { "201": { "description": "ScheduleStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStopwatch" } } } } } } }, "/time/schedulestopwatches/{id}": { "get": { "tags": [ "ScheduleStopwatch" ], "summary": "Get ScheduleStopwatch", "operationId": "getTimeSchedulestopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "schedulestopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStopwatch" } } } } } }, "delete": { "tags": [ "ScheduleStopwatch" ], "summary": "Delete ScheduleStopwatch", "operationId": "deleteTimeSchedulestopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "schedulestopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ScheduleStopwatch" ], "summary": "Put ScheduleStopwatch", "operationId": "putTimeSchedulestopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "schedulestopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleStopwatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleStopwatch" } } }, "required": true }, "responses": { "200": { "description": "ScheduleStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStopwatch" } } } } } }, "patch": { "tags": [ "ScheduleStopwatch" ], "summary": "Patch ScheduleStopwatch", "operationId": "patchTimeSchedulestopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "schedulestopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/ScheduleStopwatch" } } } } } } }, "/time/schedulestopwatches/count": { "get": { "tags": [ "ScheduleStopwatch" ], "summary": "Get Count of ScheduleStopwatch", "operationId": "getTimeSchedulestopwatchesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/sheets": { "get": { "tags": [ "TimeSheets" ], "summary": "Get List of TimeSheet", "operationId": "getTimeSheets", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeSheet", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeSheet" } } } } } } } }, "/time/sheets/{id}": { "get": { "tags": [ "TimeSheets" ], "summary": "Get TimeSheet", "operationId": "getTimeSheetsById", "parameters": [ { "name": "id", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeSheet", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeSheet" } } } } } }, "delete": { "tags": [ "TimeSheets" ], "summary": "Delete TimeSheet", "operationId": "deleteTimeSheetsById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/time/sheets/{id}/approve": { "post": { "tags": [ "TimeSheets" ], "summary": "Post SuccessResponse", "operationId": "postTimeSheetsByIdApprove", "parameters": [ { "name": "id", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sheetId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeSheetTierUpdate" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/time/sheets/{id}/reject": { "post": { "tags": [ "TimeSheets" ], "summary": "Post SuccessResponse", "operationId": "postTimeSheetsByIdReject", "parameters": [ { "name": "id", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/time/sheets/{id}/reverse": { "post": { "tags": [ "TimeSheets" ], "summary": "Post SuccessResponse", "operationId": "postTimeSheetsByIdReverse", "parameters": [ { "name": "id", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/time/sheets/{id}/submit": { "post": { "tags": [ "TimeSheets" ], "summary": "Post SuccessResponse", "operationId": "postTimeSheetsByIdSubmit", "parameters": [ { "name": "id", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/time/sheets/{parentId}/audits": { "get": { "tags": [ "TimeSheetAudits" ], "summary": "Get List of TimeSheetAudit", "operationId": "getTimeSheetsByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeSheetAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeSheetAudit" } } } } } } } }, "/time/sheets/{parentId}/audits/{id}": { "get": { "tags": [ "TimeSheetAudits" ], "summary": "Get TimeSheetAudit", "operationId": "getTimeSheetsByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeSheetAudit", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimeSheetAudit" } } } } } } }, "/time/sheets/{parentId}/audits/count": { "get": { "tags": [ "TimeSheetAudits" ], "summary": "Get Count of TimeSheetAudit", "operationId": "getTimeSheetsByParentIdAuditsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "sheetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/sheets/count": { "get": { "tags": [ "TimeSheets" ], "summary": "Get Count of TimeSheet", "operationId": "getTimeSheetsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/ticketstopwatches": { "get": { "tags": [ "TicketStopwatches" ], "summary": "Get List of TicketStopwatch", "operationId": "getTimeTicketstopwatches", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketStopwatch" } } } } } } }, "post": { "tags": [ "TicketStopwatches" ], "summary": "Post TicketStopwatch", "operationId": "postTimeTicketstopwatches", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketStopwatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketStopwatch" } } }, "required": true }, "responses": { "201": { "description": "TicketStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketStopwatch" } } } } } } }, "/time/ticketstopwatches/{id}": { "get": { "tags": [ "TicketStopwatches" ], "summary": "Get TicketStopwatch", "operationId": "getTimeTicketstopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "ticketstopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketStopwatch" } } } } } }, "delete": { "tags": [ "TicketStopwatches" ], "summary": "Delete TicketStopwatch", "operationId": "deleteTimeTicketstopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "ticketstopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketStopwatches" ], "summary": "Put TicketStopwatch", "operationId": "putTimeTicketstopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "ticketstopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketStopwatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketStopwatch" } } }, "required": true }, "responses": { "200": { "description": "TicketStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketStopwatch" } } } } } }, "patch": { "tags": [ "TicketStopwatches" ], "summary": "Patch TicketStopwatch", "operationId": "patchTimeTicketstopwatchesById", "parameters": [ { "name": "id", "in": "path", "description": "ticketstopwatcheId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketStopwatch", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TicketStopwatch" } } } } } } }, "/time/ticketstopwatches/count": { "get": { "tags": [ "TicketStopwatches" ], "summary": "Get Count of TicketStopwatch", "operationId": "getTimeTicketstopwatchesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/timePeriodSetups": { "get": { "tags": [ "TimePeriodSetups" ], "summary": "Get List of TimePeriodSetup", "operationId": "getTimeTimePeriodSetups", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimePeriodSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimePeriodSetup" } } } } } } }, "post": { "tags": [ "TimePeriodSetups" ], "summary": "Post TimePeriodSetup", "operationId": "postTimeTimePeriodSetups", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timePeriodSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimePeriodSetup" } } }, "required": true }, "responses": { "201": { "description": "TimePeriodSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimePeriodSetup" } } } } } } }, "/time/timePeriodSetups/{id}": { "get": { "tags": [ "TimePeriodSetups" ], "summary": "Get TimePeriodSetup", "operationId": "getTimeTimePeriodSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimePeriodSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimePeriodSetup" } } } } } }, "delete": { "tags": [ "TimePeriodSetups" ], "summary": "Delete TimePeriodSetup", "operationId": "deleteTimeTimePeriodSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TimePeriodSetups" ], "summary": "Put TimePeriodSetup", "operationId": "putTimeTimePeriodSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timePeriodSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimePeriodSetup" } } }, "required": true }, "responses": { "200": { "description": "TimePeriodSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimePeriodSetup" } } } } } }, "patch": { "tags": [ "TimePeriodSetups" ], "summary": "Patch TimePeriodSetup", "operationId": "patchTimeTimePeriodSetupsById", "parameters": [ { "name": "id", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimePeriodSetup", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimePeriodSetup" } } } } } } }, "/time/timePeriodSetups/{parentId}/periods": { "get": { "tags": [ "TimePeriods" ], "summary": "Get List of TimePeriod", "operationId": "getTimeTimePeriodSetupsByParentIdPeriods", "parameters": [ { "name": "parentId", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimePeriod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimePeriod" } } } } } } } }, "/time/timePeriodSetups/{parentId}/periods/{id}": { "get": { "tags": [ "TimePeriods" ], "summary": "Get TimePeriod", "operationId": "getTimeTimePeriodSetupsByParentIdPeriodsById", "parameters": [ { "name": "id", "in": "path", "description": "periodId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimePeriod", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimePeriod" } } } } } } }, "/time/timePeriodSetups/{parentId}/periods/count": { "get": { "tags": [ "TimePeriods" ], "summary": "Get Count of TimePeriod", "operationId": "getTimeTimePeriodSetupsByParentIdPeriodsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "timePeriodSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/timePeriodSetups/count": { "get": { "tags": [ "TimePeriodSetups" ], "summary": "Get Count of TimePeriodSetup", "operationId": "getTimeTimePeriodSetupsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/timePeriodSetups/default": { "get": { "tags": [ "TimePeriodSetups" ], "summary": "Get TimePeriodSetupDefaults", "operationId": "getTimeTimePeriodSetupsDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimePeriodSetupDefaults", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/TimePeriodSetupDefaults" } } } } } } }, "/time/workRoles": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of WorkRole", "operationId": "getTimeWorkRoles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRole" } } } } } } }, "post": { "tags": [ "WorkRoles" ], "summary": "Post WorkRole", "operationId": "postTimeWorkRoles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRole" } } }, "required": true }, "responses": { "201": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } } }, "/time/workRoles/{id}": { "get": { "tags": [ "WorkRoles" ], "summary": "Get WorkRole", "operationId": "getTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } }, "delete": { "tags": [ "WorkRoles" ], "summary": "Delete Usage", "operationId": "deleteTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkRoles" ], "summary": "Put WorkRole", "operationId": "putTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRole" } } }, "required": true }, "responses": { "200": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } }, "patch": { "tags": [ "WorkRoles" ], "summary": "Patch WorkRole", "operationId": "patchTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } } }, "/time/workRoles/{id}/info": { "get": { "tags": [ "WorkRoles" ], "summary": "Get WorkRoleInfo", "operationId": "getTimeWorkRolesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleInfo" } } } } } } }, "/time/workRoles/{id}/usages": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of Usage Count", "operationId": "getTimeWorkRolesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workRoles/{id}/usages/list": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of Usage", "operationId": "getTimeWorkRolesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workRoles/{parentId}/locations": { "get": { "tags": [ "WorkRoleLocations" ], "summary": "Get List of WorkRoleLocation", "operationId": "getTimeWorkRolesByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } } }, "post": { "tags": [ "WorkRoleLocations" ], "summary": "Post WorkRoleLocation", "operationId": "postTimeWorkRolesByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } }, "required": true }, "responses": { "201": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } } }, "/time/workRoles/{parentId}/locations/{id}": { "get": { "tags": [ "WorkRoleLocations" ], "summary": "Get WorkRoleLocation", "operationId": "getTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } }, "delete": { "tags": [ "WorkRoleLocations" ], "summary": "Delete WorkRoleLocation", "operationId": "deleteTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkRoleLocations" ], "summary": "Put WorkRoleLocation", "operationId": "putTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } }, "required": true }, "responses": { "200": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } }, "patch": { "tags": [ "WorkRoleLocations" ], "summary": "Patch WorkRoleLocation", "operationId": "patchTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } } }, "/time/workRoles/{parentId}/locations/count": { "get": { "tags": [ "WorkRoleLocations" ], "summary": "Get Count of WorkRoleLocation", "operationId": "getTimeWorkRolesByParentIdLocationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workRoles/count": { "get": { "tags": [ "WorkRoles" ], "summary": "Get Count of WorkRole", "operationId": "getTimeWorkRolesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workRoles/info": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of WorkRoleInfo", "operationId": "getTimeWorkRolesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRoleInfo" } } } } } } } }, "/time/workRoles/info/count": { "get": { "tags": [ "WorkRoles" ], "summary": "Get Count of WorkRoleInfo", "operationId": "getTimeWorkRolesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workTypes": { "get": { "tags": [ "WorkTypes" ], "summary": "Get List of WorkType", "operationId": "getTimeWorkTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkType" } } } } } } }, "post": { "tags": [ "WorkTypes" ], "summary": "Post WorkType", "operationId": "postTimeWorkTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkType" } } }, "required": true }, "responses": { "201": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } } }, "/time/workTypes/{id}": { "get": { "tags": [ "WorkTypes" ], "summary": "Get WorkType", "operationId": "getTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } }, "delete": { "tags": [ "WorkTypes" ], "summary": "Delete WorkType", "operationId": "deleteTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkTypes" ], "summary": "Put WorkType", "operationId": "putTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkType" } } }, "required": true }, "responses": { "200": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } }, "patch": { "tags": [ "WorkTypes" ], "summary": "Patch WorkType", "operationId": "patchTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } } }, "/time/workTypes/{id}/info": { "get": { "tags": [ "WorkTypeInfos" ], "summary": "Get WorkTypeInfos", "operationId": "getTimeWorkTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "WorkTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/WorkTypeInfo" } } } } } } }, "/time/workTypes/{id}/usages": { "get": { "tags": [ "WorkTypes" ], "summary": "Get List of Usage Count", "operationId": "getTimeWorkTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workTypes/{id}/usages/list": { "get": { "tags": [ "WorkTypes" ], "summary": "Get List of Usage", "operationId": "getTimeWorkTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workTypes/count": { "get": { "tags": [ "WorkTypes" ], "summary": "Get Count of WorkType", "operationId": "getTimeWorkTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workTypes/info": { "get": { "tags": [ "WorkTypeInfos" ], "summary": "Get List of WorkTypeInfos", "operationId": "getTimeWorkTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of workTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTypeInfo" } } } } } } } }, "/time/workTypes/info/count": { "get": { "tags": [ "WorkTypeInfos" ], "summary": "Get Count of WorkTypeInfos", "operationId": "getTimeWorkTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.1": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } } }, "components": { "schemas": { "AccountingBatch": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "batchIdentifier": { "type": "string" }, "exportInvoicesFlag": { "type": "boolean", "nullable": true }, "exportExpensesFlag": { "type": "boolean", "nullable": true }, "exportProductsFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AccountingPackage": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" } } }, "AccountingPackageReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "enum": [ "QB99", "Mas200", "GPlains", "SBA", "Mas200v4", "Other" ], "type": "string", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AccountingPackageSetup": { "required": [ "accountingPackage" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "accountingPackage": { "$ref": "#/components/schemas/AccountingPackageReference" }, "directTransferFlag": { "type": "boolean", "nullable": true }, "includeInvoicesFlag": { "type": "boolean", "nullable": true }, "invoiceFormat": { "enum": [ "Default", "Condensed", "Detailed" ], "type": "string", "nullable": true }, "includeExpensesFlag": { "type": "boolean", "nullable": true }, "transferExpensesAsBillFlag": { "type": "boolean", "nullable": true }, "expenseFormat": { "enum": [ "Default", "Condensed" ], "type": "string", "nullable": true }, "suppressMemoFlag": { "type": "boolean", "nullable": true }, "syncPaymentInfoFlag": { "type": "boolean", "nullable": true }, "syncWisePayPaymentInfoFlag": { "type": "boolean", "nullable": true }, "includeSalesTaxFlag": { "type": "boolean", "nullable": true }, "enableTaxGroupsFlag": { "type": "boolean", "nullable": true }, "zeroDollarTaxAmountsFlag": { "type": "boolean", "nullable": true }, "includeItemsFlag": { "type": "boolean", "nullable": true }, "inventorySOHFlag": { "type": "boolean", "nullable": true }, "sendComponentAmountFlag": { "type": "boolean", "nullable": true }, "sendUomFlag": { "type": "boolean", "nullable": true }, "includeCogsEntriesFlag": { "type": "boolean", "nullable": true }, "includeCogsDropShipFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Activity": { "required": [ "name", "assignTo" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "type": { "$ref": "#/components/schemas/ActivityTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "phoneNumber": { "type": "string", "description": " Max length: 30;" }, "email": { "type": "string", "description": " Max length: 250;" }, "status": { "$ref": "#/components/schemas/ActivityStatusReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "campaign": { "$ref": "#/components/schemas/CampaignReference" }, "notes": { "type": "string" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "assignedBy": { "$ref": "#/components/schemas/MemberReference" }, "assignTo": { "$ref": "#/components/schemas/MemberReference" }, "scheduleStatus": { "$ref": "#/components/schemas/ScheduleStatusReference" }, "reminder": { "$ref": "#/components/schemas/ReminderReference" }, "where": { "$ref": "#/components/schemas/ServiceLocationReference" }, "notifyFlag": { "type": "boolean", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ActivityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "spawnFollowupFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityStopwatch": { "required": [ "activityId", "member", "status" ], "type": "object", "properties": { "activityId": { "type": "integer", "format": "int32", "nullable": true }, "activityMobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "dateEntered": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "internalNotes": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "notes": { "type": "string", "description": " Max length: 4000;" }, "startTime": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Reset", "Running", "Paused", "Stopped" ], "type": "string", "nullable": true }, "totalPauseTime": { "type": "integer", "format": "int32", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "points": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "emailFlag": { "type": "boolean", "nullable": true }, "memoFlag": { "type": "boolean", "nullable": true }, "historyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Addition": { "required": [ "product", "billCustomer" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/components/schemas/IvItemReference" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "lessIncluded": { "type": "number", "format": "double", "nullable": true }, "unitPrice": { "type": "number", "format": "double", "nullable": true }, "unitCost": { "type": "number", "format": "double", "nullable": true }, "billCustomer": { "enum": [ "Billable", "DoNotBill", "NoCharge" ], "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time" }, "cancelledDate": { "type": "string", "format": "date-time" }, "taxableFlag": { "type": "boolean", "nullable": true }, "serialNumber": { "type": "string", "description": " Max length: 50;" }, "invoiceDescription": { "type": "string", "description": " Max length: 6000;" }, "purchaseItemFlag": { "type": "boolean", "nullable": true }, "specialOrderFlag": { "type": "boolean", "nullable": true }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "billedQuantity": { "type": "number", "format": "double", "nullable": true }, "uom": { "type": "string" }, "extPrice": { "type": "number", "format": "double", "nullable": true }, "extCost": { "type": "number", "format": "double", "nullable": true }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "prorateCost": { "type": "number", "format": "double", "nullable": true }, "proratePrice": { "type": "number", "format": "double", "nullable": true }, "extendedProrateCost": { "type": "number", "format": "double", "nullable": true }, "extendedProratePrice": { "type": "number", "format": "double", "nullable": true }, "prorateCurrentPeriodFlag": { "type": "boolean", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreementStatus": { "enum": [ "Active", "Cancelled", "Expired", "Inactive" ], "type": "string", "nullable": true }, "invoiceGrouping": { "$ref": "#/components/schemas/InvoiceGroupingReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "AddressFormat": { "required": [ "name", "format" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "format": { "type": "string", "description": " Max length: 250;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "countryIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllCountries": { "type": "boolean", "nullable": true }, "removeAllCountries": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AddressFormatInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AddressFormatReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AdjustmentDetail": { "required": [ "catalogItem", "warehouse", "warehouseBin", "quantityAdjusted" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "description": { "type": "string", "description": " Max length: 50;" }, "quantityOnHand": { "type": "number", "format": "double", "nullable": true }, "unitCost": { "type": "number", "format": "double", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "quantityAdjusted": { "type": "integer", "format": "int32", "nullable": true }, "serialNumber": { "type": "string", "description": " Max length: 1000;" }, "adjustment": { "$ref": "#/components/schemas/AdjustmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AdjustmentDetailReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AdjustmentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AdjustmentType": { "required": [ "identifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 50;" }, "name": { "type": "string", "description": " Max length: 100;" }, "auditTrailFlag": { "type": "boolean", "nullable": true }, "dateCreated": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AdjustmentTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AdjustmentTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Agreement": { "required": [ "name", "type", "company", "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "subContractCompany": { "$ref": "#/components/schemas/CompanyReference" }, "subContractContact": { "$ref": "#/components/schemas/ContactReference" }, "parentAgreement": { "$ref": "#/components/schemas/AgreementReference" }, "customerPO": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "noEndingDateFlag": { "type": "boolean", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "cancelledFlag": { "type": "boolean", "nullable": true }, "dateCancelled": { "type": "string", "format": "date-time" }, "reasonCancelled": { "type": "string", "description": " Max length: 100;" }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "workOrder": { "type": "string", "description": " Max length: 20;" }, "internalNotes": { "type": "string" }, "applicationUnits": { "enum": [ "Amount", "Hours", "Incidents" ], "type": "string", "nullable": true }, "applicationLimit": { "type": "number", "format": "double", "nullable": true }, "applicationCycle": { "enum": [ "Contract2Weeks", "Contract4Weeks", "ContractYear", "CalendarMonth", "CalendarQuarter", "CalendarWeek", "ContractQuarter", "CalendarYear" ], "type": "string", "nullable": true }, "applicationUnlimitedFlag": { "type": "boolean", "nullable": true }, "oneTimeFlag": { "type": "boolean", "nullable": true }, "coverAgreementTime": { "type": "boolean", "nullable": true }, "coverAgreementProduct": { "type": "boolean", "nullable": true }, "coverAgreementExpense": { "type": "boolean", "nullable": true }, "coverSalesTax": { "type": "boolean", "nullable": true }, "carryOverUnused": { "type": "boolean", "nullable": true }, "allowOverruns": { "type": "boolean", "nullable": true }, "expiredDays": { "type": "integer", "format": "int32", "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "expireWhenZero": { "type": "boolean", "nullable": true }, "chargeToFirm": { "type": "boolean", "nullable": true }, "employeeCompRate": { "enum": [ "Actual", "Hourly" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "employeeCompNotExceed": { "enum": [ "Billing", "Amount", "Percent" ], "type": "string", "nullable": true }, "compHourlyRate": { "type": "number", "format": "double", "nullable": true }, "compLimitAmount": { "type": "number", "format": "double", "nullable": true }, "billingCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "billOneTimeFlag": { "type": "boolean", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "invoicingCycle": { "enum": [ "ContractYear", "CalendarYear" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "billAmount": { "type": "number", "format": "double", "nullable": true }, "taxable": { "type": "boolean", "nullable": true }, "prorateFirstBill": { "type": "number", "format": "double", "nullable": true }, "billStartDate": { "type": "string", "format": "date-time" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "restrictDownPayment": { "type": "boolean", "nullable": true }, "prorateFlag": { "type": "boolean", "nullable": true }, "invoiceProratedAdditionsFlag": { "type": "boolean", "nullable": true }, "invoiceDescription": { "type": "string" }, "topComment": { "type": "boolean", "nullable": true }, "bottomComment": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "projectType": { "$ref": "#/components/schemas/ProjectTypeReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billableTimeInvoice": { "type": "boolean", "nullable": true }, "billableExpenseInvoice": { "type": "boolean", "nullable": true }, "billableProductInvoice": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "periodType": { "enum": [ "Current", "Future", "Both", "Undefined" ], "type": "string", "nullable": true }, "autoInvoiceFlag": { "type": "boolean", "nullable": true }, "nextInvoiceDate": { "type": "string" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "agreementStatus": { "enum": [ "Active", "Cancelled", "Expired", "Inactive" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Agreement.Adjustment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "description": " Max length: 1000;" }, "effectiveDate": { "type": "string", "format": "date-time" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "AgreementApplicationAviablePer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementApplicationBillingCycle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementApplicationLimit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementApplicationParameters": { "type": "object", "properties": { "applicationUnit": { "$ref": "#/components/schemas/AgreementApplicationUnit" }, "applicationLimit": { "$ref": "#/components/schemas/AgreementApplicationLimit" }, "applicationLimitAmount": { "type": "number", "format": "double" }, "availablePer": { "$ref": "#/components/schemas/AgreementApplicationAviablePer" }, "coversTimeFlag": { "type": "boolean" }, "coversExpensesFlag": { "type": "boolean" }, "coversProductsFlag": { "type": "boolean" }, "coversTaxFlag": { "type": "boolean" }, "carryoverUnusedFlag": { "type": "boolean" }, "carryOverDays": { "type": "integer", "format": "int32", "nullable": true }, "allowOverrunsFlag": { "type": "boolean" }, "overrunLimit": { "type": "integer", "format": "int32", "nullable": true }, "agreementExpiresFlag": { "type": "boolean" }, "chargeAdjustmentsFlag": { "type": "boolean" }, "prepayFlag": { "type": "boolean" }, "agrBillingCycle": { "$ref": "#/components/schemas/AgreementApplicationBillingCycle" }, "userDefinedFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldValueModel" } } } }, "AgreementApplicationUnit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementBatchSetup": { "required": [ "nextRunDate", "daysInAdvance" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "nextRunDate": { "type": "string", "format": "date-time" }, "daysInAdvance": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementBillingInfo": { "type": "object", "properties": { "agreementName": { "type": "string" }, "agreementType": { "type": "string" }, "agreementAmount": { "type": "number", "format": "double" }, "agreementRecId": { "type": "integer", "format": "int32" }, "parentRecId": { "type": "integer", "format": "int32" } } }, "AgreementRecap": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "adjustmentAmount": { "type": "number", "format": "double" }, "agreementStatus": { "type": "string" }, "name": { "type": "string" }, "availableAmount": { "type": "number", "format": "double" }, "companyName": { "type": "string" }, "isUnlimited": { "type": "string" }, "lastInvoiceAmount": { "type": "string" }, "lastInvoiceDate": { "type": "string" }, "lastInvoiceNumber": { "type": "string" }, "nextInvoiceAmount": { "type": "number", "format": "double" }, "nextInvoiceDate": { "type": "string" }, "overrunAmount": { "type": "number", "format": "double" }, "remainingAmount": { "type": "number", "format": "double" }, "startingAmount": { "type": "number", "format": "double" }, "unbilledOverageAmount": { "type": "number", "format": "double" }, "unbilledPeriods": { "type": "integer", "format": "int32" }, "usedAmount": { "type": "number", "format": "double" } } }, "AgreementRecurringParameters": { "type": "object", "properties": { "billingCycle": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "cycleBase": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "aGRAmount": { "type": "number", "format": "double", "nullable": true }, "taxable": { "type": "boolean" }, "childrenAmount": { "type": "number", "format": "double" }, "additionsAmount": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double" }, "aGRProrate": { "type": "number", "format": "double", "nullable": true }, "billStartDate": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "terms": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "prorateFlag": { "type": "boolean" }, "invoiceProratedAdditionsFlag": { "type": "boolean" }, "restrictDownpayment": { "type": "boolean" }, "currency": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "autoInvoiceFlag": { "type": "boolean" }, "userDefinedFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldValueModel" } } } }, "AgreementReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "type": { "type": "string" }, "chargeFirmFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementSite": { "required": [ "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "AgreementTabsCount": { "type": "object" }, "AgreementType": { "required": [ "name", "employeeCompRate", "employeeCompNotExceed", "invoicingCycle", "billTime", "billExpenses", "billProducts" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "prefixSuffixOption": { "enum": [ "Prefix", "Suffix" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "prePaymentFlag": { "type": "boolean", "nullable": true }, "invoicePreSuffix": { "type": "string", "description": " Max length: 5;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "applicationUnits": { "enum": [ "Amount", "Hours", "Incidents" ], "type": "string", "nullable": true }, "applicationLimit": { "type": "number", "format": "double", "nullable": true }, "applicationCycle": { "enum": [ "Contract2Weeks", "Contract4Weeks", "ContractYear", "CalendarMonth", "CalendarQuarter", "CalendarWeek", "ContractQuarter", "CalendarYear" ], "type": "string", "nullable": true }, "applicationUnlimitedFlag": { "type": "boolean", "nullable": true }, "oneTimeFlag": { "type": "boolean", "nullable": true }, "coverAgreementTimeFlag": { "type": "boolean", "nullable": true }, "coverAgreementProductFlag": { "type": "boolean", "nullable": true }, "coverAgreementExpenseFlag": { "type": "boolean", "nullable": true }, "coverSalesTaxFlag": { "type": "boolean", "nullable": true }, "carryOverUnusedFlag": { "type": "boolean", "nullable": true }, "allowOverrunsFlag": { "type": "boolean", "nullable": true }, "expiredDays": { "type": "integer", "format": "int32", "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "expireWhenZero": { "type": "boolean", "nullable": true }, "chargeToFirmFlag": { "type": "boolean", "nullable": true }, "employeeCompRate": { "enum": [ "Actual", "Hourly" ], "type": "string", "nullable": true }, "employeeCompNotExceed": { "enum": [ "Billing", "Amount", "Percent" ], "type": "string", "nullable": true }, "compHourlyRate": { "type": "number", "format": "double", "nullable": true }, "compLimitAmount": { "type": "number", "format": "double", "nullable": true }, "billingCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "billOneTimeFlag": { "type": "boolean", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "invoicingCycle": { "enum": [ "ContractYear", "CalendarYear" ], "type": "string", "nullable": true }, "billAmount": { "type": "number", "format": "double", "nullable": true }, "taxableFlag": { "type": "boolean", "nullable": true }, "restrictDownPaymentFlag": { "type": "boolean", "nullable": true }, "invoiceDescription": { "type": "string", "description": " Max length: 4000;" }, "topCommentFlag": { "type": "boolean", "nullable": true }, "bottomCommentFlag": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "projectType": { "$ref": "#/components/schemas/ProjectTypeReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billableTimeInvoiceFlag": { "type": "boolean", "nullable": true }, "billableExpenseInvoiceFlag": { "type": "boolean", "nullable": true }, "billableProductInvoiceFlag": { "type": "boolean", "nullable": true }, "copyWorkRolesFlag": { "type": "boolean", "nullable": true }, "copyWorkTypesFlag": { "type": "boolean", "nullable": true }, "exclusionWorkRoleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllWorkRoleExclusions": { "type": "boolean", "nullable": true }, "removeAllWorkRoleExclusions": { "type": "boolean", "nullable": true }, "exclusionWorkTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllWorkTypeExclusions": { "type": "boolean", "nullable": true }, "removeAllWorkTypeExclusions": { "type": "boolean", "nullable": true }, "integrationXRef": { "type": "string", "description": " Max length: 50;" }, "prorateFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/EmailTemplateReference" }, "autoInvoiceFlag": { "type": "boolean", "nullable": true }, "invoiceProratedAdditionsFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeBoardDefault": { "required": [ "location" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "applicationUnits": { "enum": [ "Amount", "Hours", "Incidents" ], "type": "string", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeWorkRole": { "required": [ "rateType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "effectiveDate": { "type": "string", "format": "date-time" }, "endingDate": { "type": "string", "format": "date-time" }, "rate": { "type": "number", "format": "double", "nullable": true }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "limitTo": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeWorkRoleExclusion": { "required": [ "workRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeWorkRoleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeWorkType": { "required": [ "rateType", "billTime", "overageRateType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "effectiveDate": { "type": "string", "format": "date-time" }, "endingDate": { "type": "string", "format": "date-time" }, "rate": { "type": "number", "format": "double", "nullable": true }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "hoursMin": { "type": "number", "format": "double", "nullable": true }, "hoursMax": { "type": "number", "format": "double", "nullable": true }, "roundBillHours": { "type": "number", "format": "double", "nullable": true }, "overageRate": { "type": "number", "format": "double", "nullable": true }, "overageRateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "limitTo": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeWorkTypeExclusion": { "required": [ "workType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkRole": { "required": [ "rateType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "limitTo": { "type": "number", "format": "double", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time" }, "endingDate": { "type": "string", "format": "date-time" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkRoleExclusion": { "required": [ "workRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkType": { "required": [ "rateType", "billTime" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "hoursMax": { "type": "number", "format": "double", "nullable": true }, "hoursMin": { "type": "number", "format": "double", "nullable": true }, "roundBillHours": { "type": "number", "format": "double", "nullable": true }, "overageRate": { "type": "number", "format": "double", "nullable": true }, "overageRateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "agreementLimit": { "type": "number", "format": "double", "nullable": true }, "site": { "$ref": "#/components/schemas/SiteReference" }, "effectiveDate": { "type": "string", "format": "date-time" }, "endingDate": { "type": "string", "format": "date-time" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkTypeExclusion": { "required": [ "workType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AllowedFileType": { "required": [ "fileType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fileType": { "type": "string" }, "sizeLimit": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AllowedOrigin": { "required": [ "origin", "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "origin": { "type": "string", "description": " Max length: 2000;" }, "description": { "type": "string", "description": " Max length: 2000;" }, "lastUpdateUtc": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ApiMember": { "required": [ "identifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "name": { "type": "string", "description": " Max length: 30; Required On Updates;" }, "emailAddress": { "type": "string", "description": " Max length: 250;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "inactiveDate": { "type": "string", "format": "date-time" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "securityRole": { "$ref": "#/components/schemas/SecurityRoleReference" }, "structureLevel": { "$ref": "#/components/schemas/StructureReference" }, "securityLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "notes": { "type": "string" }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blockPriceFlag": { "type": "boolean", "nullable": true }, "blockCostFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ApiRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "externalId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "entity": { "$ref": "#/components/schemas/IRestIdentifiedItem" }, "filters": { "$ref": "#/components/schemas/FilterValues" }, "page": { "$ref": "#/components/schemas/PageValues" }, "fields": { "type": "string" }, "miscProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "memberContext": { "type": "string" }, "updateOnlyCesProperties": { "type": "boolean" } } }, "AuditTrailEntry": { "type": "object", "properties": { "text": { "type": "string" }, "enteredDate": { "type": "string" }, "enteredBy": { "type": "string" }, "auditType": { "type": "string" }, "auditSubType": { "type": "string" }, "auditSource": { "type": "string" } } }, "AuthAnvil": { "required": [ "serverLocationUrl", "siteId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serverLocationUrl": { "type": "string" }, "siteId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AutomateScriptReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AutoSyncTime": { "required": [ "syncTime", "timeZone" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "syncTime": { "type": "string" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BatchEntry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "debit": { "type": "number", "format": "double", "nullable": true }, "credit": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double" }, "item": { "type": "string" }, "salesCode": { "type": "string" }, "costOfGoodsSoldAccountNumber": { "type": "string" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrderReference" }, "lineItem": { "$ref": "#/components/schemas/PurchaseOrderLineItemReference" }, "transfer": { "type": "string" }, "expense": { "$ref": "#/components/schemas/ExpenseDetailReference" }, "adjustmentDetail": { "$ref": "#/components/schemas/AdjustmentDetailReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BatchReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillableOptionsInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "optionId": { "type": "string" }, "billableFlag": { "type": "boolean" }, "invoiceFlag": { "type": "boolean" }, "timeFlag": { "type": "boolean" }, "expenseFlag": { "type": "boolean" }, "productFlag": { "type": "boolean" }, "defaultFlag": { "type": "boolean" }, "includeNoDefaultFlag": { "type": "boolean" }, "name": { "type": "string" }, "enumId": { "type": "string" } } }, "BillingCycle": { "required": [ "identifier", "name", "billingOptions" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 5;" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean" }, "billingOptions": { "enum": [ "BiMonthly", "BiWeekly", "Monthly", "NotRecurring", "Quarterly", "SemiAnnual", "Weekly", "Yearly" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingCycleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingCycleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingDeliveryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingSetup": { "required": [ "remitName", "location", "invoiceTitle", "payableName", "overallInvoiceDefault", "emailTemplate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "remitName": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "addressOne": { "type": "string", "description": " Max length: 50;" }, "addressTwo": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "state": { "$ref": "#/components/schemas/StateReference" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "phone": { "type": "string", "description": " Max length: 15;" }, "invoiceTitle": { "type": "string", "description": " Max length: 50;" }, "payableName": { "type": "string", "description": " Max length: 50;" }, "topcomment": { "type": "string", "description": " Max length: 4000;" }, "invoiceFooter": { "type": "string", "description": " Max length: 500;" }, "quoteFooter": { "type": "string", "description": " Max length: 1000;" }, "overallInvoiceDefault": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "standardInvoiceActual": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "standardInvoiceFixed": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "progressInvoice": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "agreementInvoice": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "creditMemoInvoice": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "downPaymentInvoice": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "miscInvoice": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "salesOrderInvoice": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "excludeDoNotBillTimeFlag": { "type": "boolean", "nullable": true }, "excludeDoNotBillExpenseFlag": { "type": "boolean", "nullable": true }, "excludeDoNotBillProductFlag": { "type": "boolean", "nullable": true }, "prefixSuffixFlag": { "enum": [ "Prefix", "Suffix" ], "type": "string", "nullable": true }, "prefixSuffixText": { "type": "string", "description": " Max length: 5;" }, "chargeAdjToFirmFlag": { "type": "boolean", "nullable": true }, "noWatermarkFlag": { "type": "boolean", "nullable": true }, "displayTaxFlag": { "type": "boolean", "nullable": true }, "allowRestrictedDeptOnRoutingFlag": { "type": "boolean", "nullable": true }, "billTicketSeparatelyFlag": { "type": "boolean", "nullable": true }, "billTicketCompleteFlag": { "type": "boolean", "nullable": true }, "billTicketUnapprovedFlag": { "type": "boolean", "nullable": true }, "billProjectCompleteFlag": { "type": "boolean", "nullable": true }, "billProjectUnapprovedFlag": { "type": "boolean", "nullable": true }, "progressTimeFlag": { "type": "boolean", "nullable": true }, "restrictProjectDownpaymentFlag": { "type": "boolean", "nullable": true }, "billSalesOrderCompleteFlag": { "type": "boolean", "nullable": true }, "billProductAfterShipFlag": { "type": "boolean", "nullable": true }, "restrictDownpaymentFlag": { "type": "boolean", "nullable": true }, "copyNonServiceProductsFlag": { "type": "boolean", "nullable": true }, "copyServiceProductsFlag": { "type": "boolean", "nullable": true }, "copyAgreementProductsFlag": { "type": "boolean", "nullable": true }, "printLogoFlag": { "type": "boolean", "nullable": true }, "readReceiptFlag": { "type": "boolean", "nullable": true }, "deliveryReceiptFlag": { "type": "boolean", "nullable": true }, "attachXmlInvoiceFlag": { "type": "boolean", "nullable": true }, "disableRoutingEmailFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/EmailTemplateReference" }, "localizedCountry": { "$ref": "#/components/schemas/CountryReference" }, "businessNumber": { "type": "string", "description": " Max length: 50;" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "customLabel": { "type": "string", "description": " Max length: 50;" }, "customText": { "type": "string", "description": " Max length: 500;" }, "companyCode": { "type": "string", "description": " Max length: 250;" }, "excludeAvalaraFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingSetupInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "remitName": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingSetupRouting": { "required": [ "sequenceNumber", "invoiceRule", "routingRule" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "invoiceRule": { "enum": [ "All", "Standard", "Project", "Agreement" ], "type": "string", "nullable": true }, "routingRule": { "enum": [ "Account", "Territory", "Creator", "Department", "Location", "Member", "Project", "Sales" ], "type": "string", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "sentFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "isClosed": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingTerm": { "required": [ "name", "dueDays" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "dueDays": { "type": "integer", "format": "int32", "nullable": true }, "termsXref": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingTermInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingTermsReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingUnitReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Board": { "required": [ "name", "location", "department" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "signOffTemplate": { "$ref": "#/components/schemas/ServiceSignoffReference" }, "sendToContactFlag": { "type": "boolean", "nullable": true }, "contactTemplate": { "$ref": "#/components/schemas/ServiceEmailTemplateReference" }, "sendToResourceFlag": { "type": "boolean", "nullable": true }, "resourceTemplate": { "$ref": "#/components/schemas/ServiceEmailTemplateReference" }, "projectFlag": { "type": "boolean", "nullable": true }, "showDependenciesFlag": { "type": "boolean", "description": "This field only shows if it is Project Board.", "nullable": true }, "showEstimatesFlag": { "type": "boolean", "description": "This field only shows if it is Project Board.", "nullable": true }, "boardIcon": { "$ref": "#/components/schemas/DocumentReference" }, "billTicketsAfterClosedFlag": { "type": "boolean", "nullable": true }, "billTicketSeparatelyFlag": { "type": "boolean", "nullable": true }, "billUnapprovedTimeExpenseFlag": { "type": "boolean", "nullable": true }, "overrideBillingSetupFlag": { "type": "boolean", "nullable": true }, "dispatchMember": { "$ref": "#/components/schemas/MemberReference" }, "serviceManagerMember": { "$ref": "#/components/schemas/MemberReference" }, "dutyManagerMember": { "$ref": "#/components/schemas/MemberReference" }, "oncallMember": { "$ref": "#/components/schemas/MemberReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpense": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProduct": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "autoCloseStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "autoAssignNewTicketsFlag": { "type": "boolean", "nullable": true }, "autoAssignNewECTicketsFlag": { "type": "boolean", "nullable": true }, "autoAssignNewPortalTicketsFlag": { "type": "boolean", "nullable": true }, "discussionsLockedFlag": { "type": "boolean", "nullable": true }, "timeEntryLockedFlag": { "type": "boolean", "nullable": true }, "notifyEmailFrom": { "type": "string", "description": " Max length: 50;" }, "notifyEmailFromName": { "type": "string", "description": " Max length: 60;" }, "closedLoopDiscussionsFlag": { "type": "boolean", "nullable": true }, "closedLoopResolutionFlag": { "type": "boolean", "nullable": true }, "closedLoopInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "timeEntryDiscussionFlag": { "type": "boolean", "nullable": true }, "timeEntryResolutionFlag": { "type": "boolean", "nullable": true }, "timeEntryInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "problemSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "resolutionSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "internalAnalysisSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "emailConnectorAllowReopenClosedFlag": { "type": "boolean", "nullable": true }, "emailConnectorReopenStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "emailConnectorReopenResourcesFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorNewTicketNoMatchFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorNeverReopenByDaysFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorReopenDaysLimit": { "type": "integer", "description": "This field can only be set when emailConnectorNeverReopenByDaysFlag and emailConnectorAllowReopenClosed are both true\n This field is required when emailConnectorNeverReopenByDaysFlag is true.", "format": "int32", "nullable": true }, "emailConnectorNeverReopenByDaysClosedFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorReopenDaysClosedLimit": { "type": "integer", "description": "This field can only be set when emailConnectorNeverReopenByDaysClosedFlag and emailConnectorAllowReopenClosed are both true\n This field is required when emailConnectorNeverReopenByDaysClosedFlag is true.", "format": "int32", "nullable": true }, "useMemberDisplayNameFlag": { "type": "boolean", "nullable": true }, "sendToCCFlag": { "type": "boolean", "nullable": true }, "autoAssignTicketOwnerFlag": { "type": "boolean", "nullable": true }, "autoAssignLimitFlag": { "type": "boolean", "nullable": true }, "autoAssignLimitAmount": { "type": "integer", "description": "This field can only be set when autoAssignLimitFlag is true", "format": "int32", "nullable": true }, "closedLoopAllFlag": { "type": "boolean", "nullable": true }, "percentageCalculation": { "enum": [ "ActualHours", "Manual", "ClosedPhases", "ClosedTickets" ], "type": "string", "nullable": true }, "allSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "markFirstNoteIssueFlag": { "type": "boolean", "nullable": true }, "restrictBoardByDefaultFlag": { "type": "boolean", "nullable": true }, "sendToBundledFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardAutoAssignResource": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardAutoTemplate": { "required": [ "type", "subtype", "item", "serviceTemplate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subtype": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "serviceTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "summarySetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "discussionSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "internalAnalysisSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "resolutionSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "tasksSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "documentsSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "resourcesSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "budgetHoursSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "financeInformationSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "sendNotesAsEmailSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "impactUrgencySetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "templatePrioritySetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "autoApplyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardCopy": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" } } }, "BoardDefault": { "required": [ "board" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardExcludedMember": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "memberId": { "type": "integer", "format": "int32" }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "closedLoopDiscussionsFlag": { "type": "boolean", "nullable": true }, "closedLoopInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "closedLoopResolutionFlag": { "type": "boolean", "nullable": true }, "closedLoopAllFlag": { "type": "boolean", "nullable": true }, "overrideBillingSetupFlag": { "type": "boolean", "nullable": true }, "billTicketsAfterClosedFlag": { "type": "boolean", "nullable": true }, "billUnapprovedTimeExpenseFlag": { "type": "boolean", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpense": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProduct": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "problemSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "internalAnalysisSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "resolutionSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "allSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardItem": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardItemAssociation": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "subTypeAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "If addAllSubTypesFlag and removeAllSubTypesFlag are both false, this field is required." }, "addAllSubTypesFlag": { "type": "boolean", "nullable": true }, "removeAllSubTypesFlag": { "type": "boolean", "nullable": true }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardSkillMapping": { "required": [ "type", "skillCategory", "skill" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "skillCategory": { "$ref": "#/components/schemas/SkillCategoryReference" }, "skill": { "$ref": "#/components/schemas/SkillReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "displayOnBoard": { "type": "boolean", "nullable": true }, "inactive": { "type": "boolean", "nullable": true }, "closedStatus": { "type": "boolean", "nullable": true }, "timeEntryNotAllowed": { "type": "boolean", "nullable": true }, "roundRobinCatchall": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "escalationStatus": { "enum": [ "NotResponded", "Responded", "ResolutionPlan", "Resolved", "NoEscalation" ], "type": "string", "nullable": true }, "customerPortalDescription": { "type": "string", "description": " Max length: 500;" }, "customerPortalFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/ServiceEmailTemplateReference" }, "statusIndicator": { "$ref": "#/components/schemas/StatusIndicatorReference" }, "customStatusIndicatorName": { "type": "string", "description": " Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "saveTimeAsNote": { "type": "boolean", "nullable": true } } }, "BoardStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardStatusNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": "Service Status Notification email must be entered if the notify type is \"Email Address\". Max length: 255;" }, "workflowStep": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardSubType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "typeAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllTypesFlag": { "type": "boolean", "nullable": true }, "removeAllTypesFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardSubTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "typeAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardTeam": { "required": [ "name", "teamLeader" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "teamLeader": { "$ref": "#/components/schemas/MemberReference" }, "members": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "defaultFlag": { "type": "boolean", "nullable": true }, "notifyOnTicketDelete": { "type": "boolean", "nullable": true }, "defaultRoundRobinFlag": { "type": "boolean", "nullable": true }, "roundRobinFlag": { "type": "boolean", "nullable": true }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardTeamInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "category": { "enum": [ "Reactive", "Proactive" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "requestForChangeFlag": { "type": "boolean", "nullable": true }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "skillCategory": { "$ref": "#/components/schemas/SkillCategoryReference" }, "skill": { "$ref": "#/components/schemas/SkillReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardTypeSubTypeItemAssociation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BulkResult": { "type": "object", "properties": { "payload": { "type": "array", "items": { "$ref": "#/components/schemas/ResultInfo" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BundleRequest": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32" }, "resourceType": { "type": "string" }, "version": { "type": "string" }, "apiRequest": { "$ref": "#/components/schemas/ApiRequest" } } }, "BundleRequestsCollection": { "required": [ "requests" ], "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/BundleRequest" } } } }, "BundleResult": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32" }, "resourceType": { "type": "string" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/IRestIdentifiedItem" } }, "count": { "type": "integer", "format": "int32" }, "version": { "type": "string" }, "success": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "error": { "$ref": "#/components/schemas/ErrorResponseMessage" } } }, "BundleResultsCollection": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BundleResult" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Calendar": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "holidayList": { "$ref": "#/components/schemas/HolidayListReference" }, "mondayStartTime": { "type": "string" }, "mondayEndTime": { "type": "string" }, "tuesdayStartTime": { "type": "string" }, "tuesdayEndTime": { "type": "string" }, "wednesdayStartTime": { "type": "string" }, "wednesdayEndTime": { "type": "string" }, "thursdayStartTime": { "type": "string" }, "thursdayEndTime": { "type": "string" }, "fridayStartTime": { "type": "string" }, "fridayEndTime": { "type": "string" }, "saturdayStartTime": { "type": "string" }, "saturdayEndTime": { "type": "string" }, "sundayStartTime": { "type": "string" }, "sundayEndTime": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CalendarInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "holidayList": { "$ref": "#/components/schemas/HolidayListReference" }, "mondayStartTime": { "type": "string" }, "mondayEndTime": { "type": "string" }, "tuesdayStartTime": { "type": "string" }, "tuesdayEndTime": { "type": "string" }, "wednesdayStartTime": { "type": "string" }, "wednesdayEndTime": { "type": "string" }, "thursdayStartTime": { "type": "string" }, "thursdayEndTime": { "type": "string" }, "fridayStartTime": { "type": "string" }, "fridayEndTime": { "type": "string" }, "saturdayStartTime": { "type": "string" }, "saturdayEndTime": { "type": "string" }, "sundayStartTime": { "type": "string" }, "sundayEndTime": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CalendarReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CalendarSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CallbackEntry": { "required": [ "url", "objectId", "type", "level" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 100;" }, "url": { "type": "string", "description": " Required Reference" }, "objectId": { "type": "integer", "description": " Required Reference", "format": "int32", "nullable": true }, "type": { "type": "string", "description": " Required Reference" }, "level": { "type": "string", "description": " Required Reference" }, "memberId": { "type": "integer", "format": "int32", "nullable": true }, "payloadVersion": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "isSoapCallbackFlag": { "type": "boolean", "nullable": true }, "isSelfSuppressedFlag": { "type": "boolean", "nullable": true }, "connectWiseID": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Campaign": { "required": [ "name", "type", "subType", "startDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "type": { "$ref": "#/components/schemas/CampaignTypeReference" }, "subType": { "$ref": "#/components/schemas/CampaignSubTypeReference" }, "status": { "$ref": "#/components/schemas/CampaignStatusReference" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "inactive": { "type": "boolean", "nullable": true }, "inactiveDaysAfterEnd": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "defaultGroup": { "$ref": "#/components/schemas/GroupReference" }, "marketingManagerDefaultTrackId": { "type": "integer", "format": "int32", "nullable": true }, "opportunityDefaultTrackId": { "type": "integer", "format": "int32", "nullable": true }, "impressions": { "type": "integer", "format": "int32", "nullable": true }, "budgetRevenue": { "type": "number", "format": "double", "nullable": true }, "budgetCost": { "type": "number", "format": "double", "nullable": true }, "actualCost": { "type": "number", "format": "double", "nullable": true }, "budgetGrossMargin": { "type": "number", "format": "double", "nullable": true }, "budgetROI": { "type": "number", "format": "double", "nullable": true }, "actualRevenue": { "type": "number", "format": "double", "nullable": true }, "actualGrossMargin": { "type": "number", "format": "double", "nullable": true }, "actualROI": { "type": "number", "format": "double", "nullable": true }, "emailsSent": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Campaign.SubType.CampaignSubType": { "required": [ "type", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CampaignTypeReference" }, "name": { "type": "string", "description": " Max length: 100;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignAudit": { "required": [ "emailsSent" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "emailsSent": { "type": "integer", "format": "int32", "nullable": true }, "emailsUnsent": { "type": "integer", "format": "int32", "nullable": true }, "documentsCreated": { "type": "integer", "format": "int32", "nullable": true }, "emailSubject": { "type": "string", "description": " Max length: 1000;" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "campaignId": { "type": "integer", "format": "int32", "nullable": true }, "createdBy": { "type": "string" }, "dateCreated": { "type": "string" } } }, "CampaignReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignSubTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CatalogComponent": { "required": [ "quantity", "catalogItem" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "hidePriceFlag": { "type": "boolean", "nullable": true }, "hideItemIdentifierFlag": { "type": "boolean", "nullable": true }, "hideDescriptionFlag": { "type": "boolean", "nullable": true }, "hideQuantityFlag": { "type": "boolean", "nullable": true }, "hideExtendedPriceFlag": { "type": "boolean", "nullable": true }, "parentCatalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "price": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CatalogInventory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "onHand": { "type": "integer", "format": "int32", "nullable": true }, "serialNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OnHandSerialNumberReference" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CatalogItem": { "required": [ "identifier", "description", "subcategory", "type", "customerDescription" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 75;" }, "description": { "type": "string", "description": " Max length: 60;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "subcategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "type": { "$ref": "#/components/schemas/ProductTypeReference" }, "productClass": { "enum": [ "Agreement", "Bundle", "Inventory", "NonInventory", "Service" ], "type": "string", "description": "Defaults to Non-Inventory.", "nullable": true }, "serializedFlag": { "type": "boolean", "nullable": true }, "serializedCostFlag": { "type": "boolean", "nullable": true }, "phaseProductFlag": { "type": "boolean", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "minStockLevel": { "type": "integer", "format": "int32", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "priceAttribute": { "enum": [ "FixedFee", "NotToExceed", "OverrideRate", "TimeAndMaterials" ], "type": "string", "nullable": true }, "taxableFlag": { "type": "boolean", "nullable": true }, "dropShipFlag": { "type": "boolean", "nullable": true }, "specialOrderFlag": { "type": "boolean", "nullable": true }, "customerDescription": { "type": "string", "description": " Max length: 6000;" }, "manufacturer": { "$ref": "#/components/schemas/ManufacturerReference" }, "manufacturerPartNumber": { "type": "string", "description": " Max length: 50;" }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "vendorSku": { "type": "string", "description": " Max length: 50;" }, "notes": { "type": "string" }, "integrationXRef": { "type": "string", "description": " Max length: 50;" }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "entityType": { "$ref": "#/components/schemas/EntityTypeReference" }, "recurringFlag": { "type": "boolean", "nullable": true }, "recurringRevenue": { "type": "number", "format": "double", "nullable": true }, "recurringCost": { "type": "number", "format": "double", "nullable": true }, "recurringOneTimeFlag": { "type": "boolean", "nullable": true }, "recurringBillCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "recurringCycleType": { "enum": [ "ContractYear", "CalendarYear" ], "type": "string", "nullable": true }, "calculatedPriceFlag": { "type": "boolean", "nullable": true }, "calculatedCostFlag": { "type": "boolean", "nullable": true }, "category": { "$ref": "#/components/schemas/ProductCategoryReference" }, "calculatedPrice": { "type": "number", "format": "double", "nullable": true }, "calculatedCost": { "type": "number", "format": "double", "nullable": true }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "connectWiseID": { "type": "string" }, "agreementType": { "$ref": "#/components/schemas/AgreementTypeReference" }, "markupPercentage": { "type": "number", "format": "double", "nullable": true }, "markupFlag": { "type": "boolean", "nullable": true }, "autoUpdateUnitCostFlag": { "type": "boolean", "nullable": true }, "autoUpdateUnitPriceFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "CatalogItemInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "productClass": { "enum": [ "Agreement", "Bundle", "Inventory", "NonInventory", "Service" ], "type": "string", "nullable": true }, "serializedCostFlag": { "type": "boolean", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "taxableFlag": { "type": "boolean", "nullable": true }, "dropShipFlag": { "type": "boolean", "nullable": true }, "specialOrderFlag": { "type": "boolean", "nullable": true }, "customerDescription": { "type": "string" }, "manufacturerPartNumber": { "type": "string" }, "vendorSku": { "type": "string" }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CatalogItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CatalogPricing": { "type": "object", "properties": { "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "quantity": { "type": "integer", "format": "int32" }, "date": { "type": "string" }, "price": { "type": "number", "format": "double", "nullable": true } } }, "CatalogVendors": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "catalogItemId": { "type": "integer", "format": "int32" }, "vendorId": { "type": "integer", "format": "int32", "nullable": true }, "vendorSku": { "type": "string", "description": " Max length: 50;" }, "isPreferredVendor": { "type": "boolean" }, "vendorName": { "type": "string" } } }, "Category": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "priceLevelXref": { "type": "string", "description": " Max length: 10;" }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "defaultFlag": { "type": "boolean", "nullable": true }, "addAllLocations": { "type": "boolean", "nullable": true }, "removeAllLocations": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CategoryInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Certification": { "required": [ "name", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CertificationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChangeOrder": { "required": [ "purchaseHeaderRecId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "purchaseHeaderRecId": { "type": "integer", "format": "int32" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCode": { "required": [ "name", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "expenseEntryFlag": { "type": "boolean", "nullable": true }, "allowAllExpenseTypeFlag": { "type": "boolean", "nullable": true }, "timeEntryFlag": { "type": "boolean", "nullable": true }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "expenseTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCodeExpenseType": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ExpenseTypeReference" }, "chargeCode": { "$ref": "#/components/schemas/ChargeCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCodeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "expenseEntryFlag": { "type": "boolean", "nullable": true }, "allowAllExpenseTypeFlag": { "type": "boolean", "nullable": true }, "timeEntryFlag": { "type": "boolean", "nullable": true }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "expenseTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Classification": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "multiplier": { "type": "number", "format": "double", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "companyFlag": { "type": "boolean", "nullable": true }, "employeeFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ClassificationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ClearPickerRequest": { "type": "object", "properties": { "member": { "$ref": "#/components/schemas/MemberReference" }, "type": { "enum": [ "Company", "Vendor" ], "type": "string", "nullable": true } } }, "ClosedInvoice": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/BillingStatusReference" }, "internalNotes": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Code": { "required": [ "name", "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "description": { "type": "string" }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Commission": { "required": [ "member" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "commissionPercent": { "type": "number", "format": "double", "nullable": true }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "serviceBoard": { "$ref": "#/components/schemas/BoardReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "billingMethod": { "enum": [ "Agreement", "CreditMemo", "DownPayment", "Miscellaneous", "Progress", "Standard" ], "type": "string", "nullable": true }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "projectBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "projectType": { "$ref": "#/components/schemas/ProjectTypeReference" }, "agreementType": { "$ref": "#/components/schemas/AgreementTypeReference" }, "numberOfMonths": { "type": "integer", "format": "int32", "nullable": true }, "productCategory": { "$ref": "#/components/schemas/ProductCategoryReference" }, "productSubCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "item": { "$ref": "#/components/schemas/IvItemReference" }, "commissionBasis": { "enum": [ "GrossProfit", "SalesAmount" ], "type": "string", "nullable": true }, "invoiceOption": { "enum": [ "AllInvoices", "PaidInvoices" ], "type": "string", "nullable": true }, "servicesFlag": { "type": "boolean", "nullable": true }, "agreementsFlag": { "type": "boolean", "nullable": true }, "productsFlag": { "type": "boolean", "nullable": true }, "myOpportunitiesFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CommunicationType": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "phoneFlag": { "type": "boolean", "description": "Gets or sets at least one flag is required to be true -- phone, fax, or email.", "nullable": true }, "faxFlag": { "type": "boolean", "description": "Gets or sets at least one flag is required to be true -- phone, fax, or email.", "nullable": true }, "emailFlag": { "type": "boolean", "description": "Gets or sets at least one flag is required to be true -- phone, fax, or email.", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "exchangeXref": { "type": "string", "description": " Max length: 50;" }, "iphoneXref": { "type": "string", "description": " Max length: 50;" }, "androidXref": { "type": "string", "description": " Max length: 50;" }, "googleXref": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CommunicationTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "phoneFlag": { "type": "boolean", "nullable": true }, "faxFlag": { "type": "boolean", "nullable": true }, "emailFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CommunicationTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Company": { "required": [ "identifier", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 30;" }, "name": { "type": "string", "description": " Max length: 50;" }, "status": { "$ref": "#/components/schemas/CompanyStatusReference" }, "addressLine1": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "addressLine2": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "city": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "state": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "zip": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "phoneNumber": { "type": "string", "description": " Max length: 30;" }, "faxNumber": { "type": "string", "description": " Max length: 30;" }, "website": { "type": "string", "description": " Max length: 255;" }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "market": { "$ref": "#/components/schemas/MarketDescriptionReference" }, "accountNumber": { "type": "string" }, "defaultContact": { "$ref": "#/components/schemas/ContactReference" }, "dateAcquired": { "type": "string", "format": "date-time" }, "sicCode": { "$ref": "#/components/schemas/SicCodeReference" }, "parentCompany": { "$ref": "#/components/schemas/CompanyReference" }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "yearEstablished": { "type": "integer", "format": "int32", "nullable": true }, "revenueYear": { "type": "integer", "format": "int32", "nullable": true }, "ownershipType": { "$ref": "#/components/schemas/OwnershipTypeReference" }, "timeZoneSetup": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "leadSource": { "type": "string", "description": " Max length: 50;" }, "leadFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "userDefinedField1": { "type": "string", "description": " Max length: 50;" }, "userDefinedField2": { "type": "string", "description": " Max length: 50;" }, "userDefinedField3": { "type": "string", "description": " Max length: 50;" }, "userDefinedField4": { "type": "string", "description": " Max length: 50;" }, "userDefinedField5": { "type": "string", "description": " Max length: 50;" }, "userDefinedField6": { "type": "string", "description": " Max length: 50;" }, "userDefinedField7": { "type": "string", "description": " Max length: 50;" }, "userDefinedField8": { "type": "string", "description": " Max length: 50;" }, "userDefinedField9": { "type": "string", "description": " Max length: 50;" }, "userDefinedField10": { "type": "string", "description": " Max length: 50;" }, "vendorIdentifier": { "type": "string" }, "taxIdentifier": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "pricingSchedule": { "$ref": "#/components/schemas/PricingScheduleReference" }, "companyEntityType": { "$ref": "#/components/schemas/EntityTypeReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billingSite": { "$ref": "#/components/schemas/SiteReference" }, "billingContact": { "$ref": "#/components/schemas/ContactReference" }, "invoiceDeliveryMethod": { "$ref": "#/components/schemas/BillingDeliveryReference" }, "invoiceToEmailAddress": { "type": "string" }, "invoiceCCEmailAddress": { "type": "string" }, "deletedFlag": { "type": "boolean", "nullable": true }, "dateDeleted": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "territoryManager": { "$ref": "#/components/schemas/MemberReference" }, "resellerIdentifier": { "type": "string" }, "isVendorFlag": { "type": "boolean", "nullable": true }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTypeReference" }, "description": "Gets or sets integrer array of Company_Type_Recids to be assigned to company that can be passed in only during new company creation (post)\n To update existing companies type, use the /company/companyTypeAssociations or /company/companies/{ID}/typeAssociations endpoints." }, "site": { "$ref": "#/components/schemas/SiteReference" }, "integratorTags": { "type": "array", "items": { "type": "string" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Company.CompanyTypeAssociation": { "required": [ "type", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CompanyTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Company.Configuration": { "required": [ "name", "type", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "type": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "status": { "$ref": "#/components/schemas/ConfigurationStatusReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "deviceIdentifier": { "type": "string", "description": " Max length: 100;" }, "serialNumber": { "type": "string", "description": " Max length: 250;" }, "modelNumber": { "type": "string", "description": " Max length: 50;" }, "tagNumber": { "type": "string", "description": " Max length: 50;" }, "purchaseDate": { "type": "string", "format": "date-time" }, "installationDate": { "type": "string", "format": "date-time" }, "installedBy": { "$ref": "#/components/schemas/MemberReference" }, "warrantyExpirationDate": { "type": "string", "format": "date-time" }, "vendorNotes": { "type": "string" }, "notes": { "type": "string" }, "macAddress": { "type": "string", "description": " Max length: 25;" }, "lastLoginName": { "type": "string", "description": " Max length: 100;" }, "billFlag": { "type": "boolean", "nullable": true }, "backupSuccesses": { "type": "integer", "format": "int32", "nullable": true }, "backupIncomplete": { "type": "integer", "format": "int32", "nullable": true }, "backupFailed": { "type": "integer", "format": "int32", "nullable": true }, "backupRestores": { "type": "integer", "format": "int32", "nullable": true }, "lastBackupDate": { "type": "string", "format": "date-time" }, "backupServerName": { "type": "string", "description": " Max length: 50;" }, "backupBillableSpaceGb": { "type": "number", "format": "double", "nullable": true }, "backupProtectedDeviceList": { "type": "string" }, "backupYear": { "type": "integer", "format": "int32", "nullable": true }, "backupMonth": { "type": "integer", "format": "int32", "nullable": true }, "ipAddress": { "type": "string", "description": " Max length: 50;" }, "defaultGateway": { "type": "string", "description": " Max length: 50;" }, "osType": { "type": "string", "description": " Max length: 250;" }, "osInfo": { "type": "string", "description": " Max length: 250;" }, "cpuSpeed": { "type": "string", "description": " Max length: 100;" }, "ram": { "type": "string", "description": " Max length: 25;" }, "localHardDrives": { "type": "string" }, "parentConfigurationId": { "type": "integer", "format": "int32", "nullable": true }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "manufacturer": { "$ref": "#/components/schemas/ManufacturerReference" }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationQuestion" } }, "activeFlag": { "type": "boolean", "nullable": true }, "managementLink": { "type": "string", "description": " Max length: 1000;" }, "remoteLink": { "type": "string", "description": " Max length: 1000;" }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "displayVendorFlag": { "type": "boolean", "nullable": true }, "companyLocationId": { "type": "integer", "format": "int32", "nullable": true }, "showRemoteFlag": { "type": "boolean", "nullable": true }, "showAutomateFlag": { "type": "boolean", "nullable": true }, "needsRenewalFlag": { "type": "boolean", "nullable": true }, "manufacturerPartNumber": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Company.ContactTypeAssociation": { "required": [ "type", "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ContactTypeReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyCompanyTypeAssociation.CompanyTypeAssociation": { "required": [ "type", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CompanyTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyCustomNote": { "required": [ "customNote", "status" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customNote": { "type": "string", "description": " Max length: 1500;" }, "status": { "$ref": "#/components/schemas/CompanyStatusReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyFinance": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "billOverrideFlag": { "type": "boolean", "nullable": true }, "billSrFlag": { "type": "boolean", "nullable": true }, "billCompleteSrFlag": { "type": "boolean", "nullable": true }, "billUnapprovedSrFlag": { "type": "boolean", "nullable": true }, "billRestrictPmFlag": { "type": "boolean", "nullable": true }, "billCompletePmFlag": { "type": "boolean", "nullable": true }, "billUnapprovedPmFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/EmailTemplateReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "CompanyGroup": { "required": [ "group" ], "type": "object", "properties": { "id": { "type": "integer", "description": " Required On Updates;", "format": "int32" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "defaultContactFlag": { "type": "boolean", "nullable": true }, "allContactsFlag": { "type": "boolean", "nullable": true }, "removeAllContactsFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "contactIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultContact": { "$ref": "#/components/schemas/ContactReference" }, "phoneNumber": { "type": "string" }, "city": { "type": "string" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "isVendorFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billingSite": { "$ref": "#/components/schemas/SiteReference" }, "billingContact": { "$ref": "#/components/schemas/ContactReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "deletedFlag": { "type": "boolean", "nullable": true }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTypeReference" } }, "status": { "$ref": "#/components/schemas/CompanyStatusReference" }, "noServiceFlag": { "type": "boolean", "nullable": true }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "state": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "zip": { "type": "string" }, "leadFlag": { "type": "boolean", "nullable": true }, "faxNumber": { "type": "string" }, "vendorIdentifier": { "type": "string" }, "taxIdentifier": { "type": "string" }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyManagementSummary": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "managementSolution": { "$ref": "#/components/schemas/ManagementSolutionReference" }, "groupIdentifier": { "type": "string", "description": " Max length: 100;" }, "deviceType": { "enum": [ "WorkstationsAndServers", "BackupStats", "Servers", "Workstations" ], "type": "string", "description": "Gets or sets deviceType is required if the managementSolution is Legacy.", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "snmpMachines": { "type": "integer", "format": "int32", "nullable": true }, "totalWorkstations": { "type": "integer", "format": "int32", "nullable": true }, "totalServers": { "type": "integer", "format": "int32", "nullable": true }, "totalWindowsServers": { "type": "integer", "format": "int32", "nullable": true }, "totalWindowsWorkstations": { "type": "integer", "format": "int32", "nullable": true }, "totalManagedMachines": { "type": "integer", "format": "int32", "nullable": true }, "serversOffline": { "type": "integer", "format": "int32", "nullable": true }, "serversDiskSpaceLow": { "type": "integer", "format": "int32", "nullable": true }, "failedBackupJobs": { "type": "integer", "format": "int32", "nullable": true }, "totalNotifications": { "type": "integer", "format": "int32", "nullable": true }, "successfulBackupJobs": { "type": "integer", "format": "int32", "nullable": true }, "serverAvailability": { "type": "integer", "format": "int32", "nullable": true }, "virusesRemoved": { "type": "integer", "format": "int32", "nullable": true }, "spywareItemsRemoved": { "type": "integer", "format": "int32", "nullable": true }, "windowsPatchesInstalled": { "type": "integer", "format": "int32", "nullable": true }, "diskCleanups": { "type": "integer", "format": "int32", "nullable": true }, "diskDefragmentations": { "type": "integer", "format": "int32", "nullable": true }, "fullyPatchedMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingOneTwoPatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingThreeFivePatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingMoreFivePatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingUnscannedPatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "alertsGenerated": { "type": "string" }, "internetConnectivity": { "type": "number", "format": "double", "nullable": true }, "diskSpaceCleanedMb": { "type": "integer", "format": "int32", "nullable": true }, "missingSecurityPatches": { "type": "string" }, "cpuUtilization": { "type": "number", "format": "double", "nullable": true }, "memoryUtilization": { "type": "number", "format": "double", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyMerge": { "required": [ "toCompanyId" ], "type": "object", "properties": { "toCompanyId": { "type": "integer", "format": "int32" }, "name": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "identifier": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "status": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "type": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "primaryAddress": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "primaryContact": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "phone": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "fax": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "website": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "market": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "territory": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "revenue": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "revenueYear": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "numberOfEmployees": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "sicCode": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "dateAcquired": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "timeZone": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "sourceList": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField1": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField2": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField3": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField4": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField5": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField6": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField7": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField8": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField9": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField10": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "billingAddress": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "billingContact": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "taxCode": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "accountNumber": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "billingTerms": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "notes": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "sites": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "activities": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "opportunities": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "services": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "projects": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "contacts": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "documents": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true } } }, "CompanyNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyNoteType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "importFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyNoteTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyPickerItem": { "required": [ "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyStatus": { "$ref": "#/components/schemas/CompanyStatusReference" }, "companyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "companySite": { "$ref": "#/components/schemas/SiteReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "companyCountry": { "$ref": "#/components/schemas/CountryReference" }, "vendorPickerFlag": { "type": "boolean", "description": "Gets or sets if true, this record was created by the vendor picker component. Otherwise, the record was created by the company picker component.", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanySite": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "addressLine1": { "type": "string", "description": " Max length: 50;" }, "addressLine2": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "stateReference": { "$ref": "#/components/schemas/StateReference" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "addressFormat": { "type": "string" }, "phoneNumber": { "type": "string", "description": " Max length: 30;" }, "phoneNumberExt": { "type": "string", "description": " Max length: 30;" }, "faxNumber": { "type": "string", "description": " Max length: 30;" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "entityType": { "$ref": "#/components/schemas/EntityTypeReference" }, "expenseReimbursement": { "type": "number", "format": "double", "nullable": true }, "primaryAddressFlag": { "type": "boolean", "nullable": true }, "defaultShippingFlag": { "type": "boolean", "nullable": true }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "defaultMailingFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "billSeparateFlag": { "type": "boolean", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "CompanySiteInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateReference": { "$ref": "#/components/schemas/StateReference" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "zip": { "type": "string" }, "addressFormat": { "type": "string" }, "phoneNumber": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultShippingFlag": { "type": "boolean", "nullable": true }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "primaryAddressFlag": { "type": "boolean", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "phoneNumberExt": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "notifyFlag": { "type": "boolean", "nullable": true }, "disallowSavingFlag": { "type": "boolean", "nullable": true }, "notificationMessage": { "type": "string", "description": " Max length: 500;" }, "customNoteFlag": { "type": "boolean", "nullable": true }, "cancelOpenTracksFlag": { "type": "boolean", "nullable": true }, "track": { "$ref": "#/components/schemas/TrackReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyTeam": { "required": [ "teamRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "teamRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "accountManagerFlag": { "type": "boolean", "nullable": true }, "techFlag": { "type": "boolean", "nullable": true }, "salesFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "vendorFlag": { "type": "boolean", "nullable": true }, "serviceAlertFlag": { "type": "boolean", "nullable": true }, "serviceAlertMessage": { "type": "string", "description": " Max length: 150;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isVendor": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationQuestion": { "type": "object", "properties": { "answerId": { "type": "integer", "format": "int32", "nullable": true }, "questionId": { "type": "integer", "format": "int32", "nullable": true }, "question": { "type": "string" }, "answer": { "type": "object" }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "fieldType": { "enum": [ "TextArea", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "Text", "Password" ], "type": "string", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true } } }, "ConfigurationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "deviceIdentifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationStatus": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 50;" }, "closedFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTabsCount": { "type": "object" }, "ConfigurationType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "systemFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeCopy": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" } } }, "ConfigurationTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "systemFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestion": { "required": [ "fieldType", "entryType", "sequenceNumber", "question" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "fieldType": { "enum": [ "TextArea", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "Text", "Password" ], "type": "string", "nullable": true }, "entryType": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "question": { "type": "string", "description": " Max length: 1000;" }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestionInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "fieldType": { "enum": [ "TextArea", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "Text", "Password" ], "type": "string", "nullable": true }, "entryType": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "question": { "type": "string" }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "question": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestionValue": { "required": [ "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "question": { "$ref": "#/components/schemas/ConfigurationTypeQuestionReference" }, "value": { "type": "string", "description": " Max length: 1000;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestionValueInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "question": { "$ref": "#/components/schemas/ConfigurationTypeQuestionReference" }, "value": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConnectWiseHostedScreen": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "screenId": { "type": "string" }, "name": { "type": "string" } } }, "ConnectWiseHostedSetup": { "required": [ "screenId", "description", "url", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "screenId": { "type": "integer", "description": "Can be obtained via ConnectWiseHostedApiScreen report.", "format": "int32", "nullable": true }, "description": { "type": "string", "description": " Max length: 50;" }, "url": { "type": "string", "description": " Max length: 1024;" }, "type": { "enum": [ "Tab", "Pod", "ToolbarButton" ], "type": "string", "nullable": true }, "clientId": { "type": "string", "description": "Only required if not already set. Max length: 36;" }, "origin": { "type": "string", "description": " Max length: 100;" }, "podHeight": { "type": "integer", "format": "int32", "nullable": true }, "toolbarButtonDialogHeight": { "type": "integer", "format": "int32", "nullable": true }, "toolbarButtonDialogWidth": { "type": "integer", "format": "int32", "nullable": true }, "toolbarButtonText": { "type": "string", "description": "Only required for ToolbarButtons. Max length: 50;" }, "toolbarButtonToolTip": { "type": "string", "description": " Max length: 50;" }, "toolbarButtonIconDocumentId": { "type": "integer", "format": "int32", "nullable": true }, "disabledFlag": { "type": "boolean", "nullable": true }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "locationsEnabledFlag": { "type": "boolean", "nullable": true }, "createdBy": { "type": "string" }, "dateCreated": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Contact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "relationship": { "$ref": "#/components/schemas/RelationshipReference" }, "relationshipOverride": { "type": "string" }, "department": { "$ref": "#/components/schemas/ContactDepartmentReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultMergeContactId": { "type": "integer", "format": "int32", "nullable": true }, "securityIdentifier": { "type": "string" }, "managerContact": { "$ref": "#/components/schemas/ContactReference" }, "assistantContact": { "$ref": "#/components/schemas/ContactReference" }, "title": { "type": "string" }, "school": { "type": "string" }, "nickName": { "type": "string" }, "marriedFlag": { "type": "boolean", "nullable": true }, "childrenFlag": { "type": "boolean", "nullable": true }, "children": { "type": "string" }, "significantOther": { "type": "string" }, "portalPassword": { "type": "string" }, "portalSecurityLevel": { "type": "integer", "format": "int32", "nullable": true }, "disablePortalLoginFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "gender": { "enum": [ "Female", "Male" ], "type": "string", "nullable": true }, "birthDay": { "type": "string" }, "anniversary": { "type": "string" }, "presence": { "enum": [ "NoAgent", "Online", "DoNotDisturb", "Away", "Offline" ], "type": "string", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "defaultPhoneType": { "type": "string" }, "defaultPhoneNbr": { "type": "string" }, "defaultPhoneExtension": { "type": "string" }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "userDefinedField1": { "type": "string", "description": " Max length: 50;" }, "userDefinedField2": { "type": "string", "description": " Max length: 50;" }, "userDefinedField3": { "type": "string", "description": " Max length: 50;" }, "userDefinedField4": { "type": "string", "description": " Max length: 50;" }, "userDefinedField5": { "type": "string", "description": " Max length: 50;" }, "userDefinedField6": { "type": "string", "description": " Max length: 50;" }, "userDefinedField7": { "type": "string", "description": " Max length: 50;" }, "userDefinedField8": { "type": "string", "description": " Max length: 50;" }, "userDefinedField9": { "type": "string", "description": " Max length: 50;" }, "userDefinedField10": { "type": "string", "description": " Max length: 50;" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "communicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCommunicationItem" } }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeReference" } }, "integratorTags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "ignoreDuplicates": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "typeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Gets or sets integrer array of Contact_Type_Recids to be assigned to contact that can be passed in only during new contact creation (post)\n To update existing contacts type, use the /company/contactTypeAssociations or /company/contacts/{ID}/typeAssociations endpoints." } } }, "ContactCommunication": { "required": [ "type", "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "$ref": "#/components/schemas/CommunicationTypeReference" }, "value": { "type": "string", "description": " Max length: 250;" }, "extension": { "type": "string", "description": " Max length: 15;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "communicationType": { "enum": [ "Email", "Fax", "Phone" ], "type": "string", "nullable": true }, "domain": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactCommunicationItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CommunicationTypeReference" }, "value": { "type": "string" }, "extension": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "domain": { "type": "string" }, "communicationType": { "enum": [ "Email", "Fax", "Phone" ], "type": "string", "nullable": true } } }, "ContactContactTypeAssociation.ContactTypeAssociation": { "required": [ "type", "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ContactTypeReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactDepartment": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactDepartmentInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactDepartmentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactGroup": { "required": [ "group" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "description": { "type": "string", "description": " Max length: 50;" }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "companyUnsubcribedEmailMessage": { "type": "string" }, "companyGroupUnsubscribedEmailMessage": { "type": "string" }, "contactUnsubscribedEmailMessage": { "type": "string" }, "contactGroupUnsubscribedEmailMessage": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "communicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCommunicationItem" } }, "defaultPhoneNbr": { "type": "string" }, "defaultPhoneType": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "title": { "type": "string" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeReference" } }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "zip": { "type": "string" }, "department": { "$ref": "#/components/schemas/ContactDepartmentReference" }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactRelationship": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactTrack": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "trackId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "actionTaken": { "type": "integer", "format": "int32", "nullable": true }, "actionRemaining": { "type": "integer", "format": "int32", "nullable": true }, "startedBy": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactType": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "serviceAlertFlag": { "type": "boolean", "nullable": true }, "serviceAlertMessage": { "type": "string", "description": " Max length: 150;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "serviceAlertFlag": { "type": "boolean", "nullable": true }, "serviceAlertMessage": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Conversion": { "required": [ "uomType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "uomType": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "parentUOM": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConversionTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConvertItem": { "required": [ "recordType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "recordType": { "enum": [ "ProjectIssue", "ProjectTicket", "ServiceTicket" ], "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string" } } }, "ConvertToProject": { "required": [ "phase", "wbsCode" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "recordType": { "enum": [ "ProjectIssue", "ProjectTicket", "ServiceTicket" ], "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string" } } }, "CorporateStructure": { "required": [ "fiscalYearStart", "locationCaption", "groupCaption", "baseCurrency" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "levelCount": { "enum": [ "Level1", "Level2", "Level3", "Level4", "Level5" ], "type": "string", "nullable": true }, "level1Name": { "type": "string", "description": " Max length: 20;" }, "level2Name": { "type": "string", "description": " Max length: 20;" }, "level3Name": { "type": "string", "description": " Max length: 20;" }, "level4Name": { "type": "string", "description": " Max length: 20;" }, "level5Name": { "type": "string", "description": " Max length: 20;" }, "fiscalYearStart": { "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ], "type": "string", "nullable": true }, "locationCaption": { "type": "string", "description": " Max length: 50;" }, "groupCaption": { "type": "string", "description": " Max length: 50;" }, "baseCurrency": { "$ref": "#/components/schemas/CurrencyReference" }, "president": { "$ref": "#/components/schemas/MemberReference" }, "chiefOperatingOfficer": { "$ref": "#/components/schemas/MemberReference" }, "controller": { "$ref": "#/components/schemas/MemberReference" }, "dispatcher": { "$ref": "#/components/schemas/MemberReference" }, "serviceManager": { "$ref": "#/components/schemas/MemberReference" }, "dutyManager": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CorporateStructureInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "locationCaption": { "type": "string" }, "groupCaption": { "type": "string" }, "baseCurrency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CorporateStructureLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "CorporateStructureLevelReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Count": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "Country": { "required": [ "name", "currency" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "cityCaption": { "type": "string", "description": " Max length: 25;" }, "stateCaption": { "type": "string", "description": " Max length: 25;" }, "zipCaption": { "type": "string", "description": " Max length: 25;" }, "zipMinimumLength": { "type": "integer", "format": "int32", "nullable": true }, "dialingPrefix": { "type": "string", "description": " Max length: 5;" }, "addressFormat": { "$ref": "#/components/schemas/AddressFormatReference" }, "countryCode": { "type": "string", "description": " Max length: 2;" }, "coreEntityCountryCode": { "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AR", "AM", "AW", "AT", "AZ", "BH", "BD", "BB", "BY", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "IO", "BN", "BG", "BF", "BI", "CM", "CV", "KY", "CF", "TD", "CL", "CX", "CC", "CO", "KM", "CG", "CK", "CI", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "EC", "EG", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "IR", "IQ", "IE", "IM", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "NA", "NR", "NP", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MP", "OM", "PK", "PW", "PS", "PG", "PY", "PE", "PN", "PL", "PT", "PR", "RE", "RO", "RU", "RW", "BL", "SH", "PM", "VC", "WS", "SM", "ST", "SN", "RS", "SC", "SL", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "SY", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TN", "TR", "TV", "UG", "UA", "GB", "UM", "UZ", "VU", "VN", "WF", "EH", "YE", "ZM", "ZW", "US", "CR", "MX", "AE", "VI", "VG", "SA", "KH", "AU", "ID", "CA", "BR", "TW", "TM", "TC", "QA", "MM", "CN", "SG", "IL", "VA", "DE", "NL", "AG", "BE", "LC", "UY", "PH", "BS", "VE", "CH", "MF", "KN", "TT", "DO", "PA", "MV", "SV", "NO", "MA", "AC", "TA" ], "type": "string", "nullable": true }, "localizationCaptionOne": { "type": "string", "description": " Max length: 25;" }, "localizationValueOne": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CountryInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "cityCaption": { "type": "string" }, "stateCaption": { "type": "string" }, "zipCaption": { "type": "string" }, "dialingPrefix": { "type": "string" }, "localizationCaptionOne": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CountryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CreateAccountingBatchRequest": { "required": [ "processedRecordIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "batchIdentifier": { "type": "string", "description": " Max length: 50;" }, "glInterfaceIdentifier": { "type": "string" }, "exportInvoicesFlag": { "type": "boolean", "description": "Batch must export Invoices, Expenses or Products.", "nullable": true }, "exportExpensesFlag": { "type": "boolean", "description": "Batch must export Invoices, Expenses or Products.", "nullable": true }, "exportProductsFlag": { "type": "boolean", "description": "Batch must export Invoices, Expenses or Products.", "nullable": true }, "processedRecordIds": { "type": "array", "items": { "type": "integer", "format": "int32", "nullable": true }, "description": "GL Entry RecIDs." }, "summarizeExpenses": { "type": "boolean", "nullable": true } } }, "Crm": { "required": [ "accountManagerRole", "technicalContactRole", "salesRepRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "companyListCount": { "type": "integer", "format": "int32", "nullable": true }, "lockProbabilityFlag": { "type": "boolean", "nullable": true }, "accountManagerRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "technicalContactRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "salesRepRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "companyIdGenerationFlag": { "type": "boolean", "nullable": true }, "excludeSpacesFlag": { "type": "boolean", "nullable": true }, "field1Caption": { "type": "string", "description": " Max length: 25;" }, "field2Caption": { "type": "string", "description": " Max length: 25;" }, "field3Caption": { "type": "string", "description": " Max length: 25;" }, "field4Caption": { "type": "string", "description": " Max length: 25;" }, "field5Caption": { "type": "string", "description": " Max length: 25;" }, "field6Caption": { "type": "string", "description": " Max length: 25;" }, "field7Caption": { "type": "string", "description": " Max length: 25;" }, "field8Caption": { "type": "string", "description": " Max length: 25;" }, "field9Caption": { "type": "string", "description": " Max length: 25;" }, "field10Caption": { "type": "string", "description": " Max length: 25;" }, "primaryRepCaption": { "type": "string", "description": " Max length: 50;" }, "secondaryRepCaption": { "type": "string", "description": " Max length: 50;" }, "other1Caption": { "type": "string", "description": " Max length: 50;" }, "other2Caption": { "type": "string", "description": " Max length: 50;" }, "defaultYear": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CrmInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "accountManagerRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "technicalContactRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "salesRepRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "field1Caption": { "type": "string" }, "field2Caption": { "type": "string" }, "field3Caption": { "type": "string" }, "field4Caption": { "type": "string" }, "field5Caption": { "type": "string" }, "field6Caption": { "type": "string" }, "field7Caption": { "type": "string" }, "field8Caption": { "type": "string" }, "field9Caption": { "type": "string" }, "field10Caption": { "type": "string" }, "primaryRepCaption": { "type": "string" }, "secondaryRepCaption": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CurrencyCode": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CurrencyCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CurrencyInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CurrencyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "symbol": { "type": "string" }, "currencyCode": { "type": "string" }, "decimalSeparator": { "type": "string" }, "numberOfDecimals": { "type": "integer", "format": "int32" }, "thousandsSeparator": { "type": "string" }, "negativeParenthesesFlag": { "type": "boolean" }, "displaySymbolFlag": { "type": "boolean" }, "currencyIdentifier": { "type": "string" }, "displayIdFlag": { "type": "boolean" }, "rightAlign": { "type": "boolean" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CustomFieldValue": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "caption": { "type": "string" }, "type": { "enum": [ "TextArea", "Button", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "PhoneNumber", "Text", "Password" ], "type": "string", "nullable": true }, "entryMethod": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "value": { "type": "object" }, "connectWiseId": { "type": "string" } } }, "CustomReport": { "required": [ "reportLink", "name", "module", "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportLink": { "type": "string" }, "name": { "type": "string", "description": " Max length: 100;" }, "module": { "enum": [ "Companies", "Finance", "Marketing", "Procurement", "Project", "Sales", "ServiceDesk", "TimeExpense" ], "type": "string", "description": "The Module Name.", "nullable": true }, "description": { "type": "string", "description": " Max length: 150;" }, "generatedFlag": { "type": "boolean", "nullable": true }, "parameterPrefix": { "type": "string", "description": " Max length: 50;" }, "parameterSeparator": { "type": "string", "description": " Max length: 50;" }, "parameterNameSeparator": { "type": "string", "description": " Max length: 50;" }, "parameterSuffix": { "type": "string", "description": " Max length: 50;" }, "locationFlag": { "type": "boolean", "nullable": true }, "locationParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Location parameter.", "format": "int32", "nullable": true }, "locationDefaultFlag": { "type": "boolean", "nullable": true }, "locationOverride": { "type": "string" }, "departmentFlag": { "type": "boolean", "nullable": true }, "departmentParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Department parameter.", "format": "int32", "nullable": true }, "departmentDefaultFlag": { "type": "boolean", "nullable": true }, "departmentOverride": { "type": "string" }, "territoryFlag": { "type": "boolean", "nullable": true }, "territoryParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Terriroty parameter.", "format": "int32", "nullable": true }, "territoryDefaultFlag": { "type": "boolean", "nullable": true }, "territoryOverride": { "type": "string" }, "companyFlag": { "type": "boolean", "nullable": true }, "companyParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Company parameter.", "format": "int32", "nullable": true }, "companyOverride": { "type": "string" }, "memberFlag": { "type": "boolean", "nullable": true }, "memberParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Member parameter.", "format": "int32", "nullable": true }, "memberOverride": { "type": "string" }, "startDateFlag": { "type": "boolean", "nullable": true }, "startDateParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Start Date parameter.", "format": "int32", "nullable": true }, "startDateOverride": { "type": "string" }, "endDateFlag": { "type": "boolean", "nullable": true }, "endDateParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's End Date parameter.", "format": "int32", "nullable": true }, "endDateOverride": { "type": "string" }, "oppTypeFlag": { "type": "boolean", "nullable": true }, "oppTypeParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Opportunity Type parameter.", "format": "int32", "nullable": true }, "oppTypeOverride": { "type": "string" }, "opportunityFlag": { "type": "boolean", "nullable": true }, "opportunityParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Opportunity parameter.", "format": "int32", "nullable": true }, "opportunityOverride": { "type": "string" }, "marketingCampaignFlag": { "type": "boolean", "nullable": true }, "marketingCampaignParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Marketing Campaign parameter.", "format": "int32", "nullable": true }, "marketingCampaignOverride": { "type": "string" }, "serviceBoardFlag": { "type": "boolean", "nullable": true }, "serviceBoardParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Service Board parameter.", "format": "int32", "nullable": true }, "serviceBoardDefaultFlag": { "type": "boolean", "nullable": true }, "serviceBoardOverride": { "type": "string" }, "serviceTypeFlag": { "type": "boolean", "nullable": true }, "serviceTypeParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Service Type parameter.", "format": "int32", "nullable": true }, "serviceTypeOverride": { "type": "string" }, "serviceStatusFlag": { "type": "boolean", "nullable": true }, "serviceStatusParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Service Status parameter.", "format": "int32", "nullable": true }, "serviceStatusOverride": { "type": "string" }, "agreementTypeFlag": { "type": "boolean", "nullable": true }, "agreementTypeParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Agreement Type parameter.", "format": "int32", "nullable": true }, "agreementTypeOverride": { "type": "string" }, "agreementFlag": { "type": "boolean", "nullable": true }, "agreementParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Agreement parameter.", "format": "int32", "nullable": true }, "agreementOverride": { "type": "string" }, "projectTypeFlag": { "type": "boolean", "nullable": true }, "projectTypeParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Project Type parameter.", "format": "int32", "nullable": true }, "projectTypeOverride": { "type": "string" }, "projectFlag": { "type": "boolean", "nullable": true }, "projectParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Project parameter.", "format": "int32", "nullable": true }, "projectOverride": { "type": "string" }, "workRoleFlag": { "type": "boolean", "nullable": true }, "workRoleParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Work Role parameter.", "format": "int32", "nullable": true }, "workRoleOverride": { "type": "string" }, "workTypeFlag": { "type": "boolean", "nullable": true }, "workTypeParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Work Type parameter.", "format": "int32", "nullable": true }, "workTypeOverride": { "type": "string" }, "invoiceFlag": { "type": "boolean", "nullable": true }, "invoiceParamId": { "type": "integer", "description": "Parameter unique identifier for the Custom Report's Invoice Type parameter.", "format": "int32", "nullable": true }, "invoiceOverride": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CustomReportParameter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Either a caption name or parameter name is required. Max length: 50;" }, "captionName": { "type": "string", "description": "Either a caption name or parameter name is required. Max length: 50;" }, "customReport": { "$ref": "#/components/schemas/CustomReportReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CustomReportReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CwTimeZone": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "offset": { "type": "number", "description": "The hours offset (+/-).", "format": "double" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "daylightSavingsFlag": { "type": "boolean", "description": "Determined based on system library value for specified timeZone.\n Not able to be used in query params at this time.", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DeliveryMethod": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "emailFlag": { "type": "boolean", "nullable": true }, "integrationEmailFlag": { "type": "boolean", "nullable": true }, "integrationPrintFlag": { "type": "boolean", "nullable": true }, "integrationActiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Department": { "required": [ "identifier", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DepartmentInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DepartmentLocation": { "required": [ "location" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "departmentManager": { "$ref": "#/components/schemas/MemberReference" }, "dispatch": { "$ref": "#/components/schemas/MemberReference" }, "serviceManager": { "$ref": "#/components/schemas/MemberReference" }, "dutyManager": { "$ref": "#/components/schemas/MemberReference" }, "ldapConfig": { "$ref": "#/components/schemas/LdapConfigurationReference" }, "addAllLocations": { "type": "boolean", "nullable": true }, "removeAllLocations": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DepartmentLocationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DirectionalSync": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DirectionalSyncInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DirectionalSyncReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentFormData": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "recordId": { "type": "integer", "format": "int32" }, "recordType": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "privateFlag": { "type": "boolean" }, "readOnlyFlay": { "type": "boolean" }, "isAvatar": { "type": "boolean" } } }, "DocumentInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "fileName": { "type": "string" }, "serverFileName": { "type": "string" }, "owner": { "type": "string" }, "linkFlag": { "type": "boolean", "nullable": true }, "imageFlag": { "type": "boolean", "nullable": true }, "publicFlag": { "type": "boolean", "nullable": true }, "htmlTemplateFlag": { "type": "boolean", "nullable": true }, "readOnlyFlag": { "type": "boolean", "nullable": true }, "size": { "type": "integer", "format": "int32", "nullable": true }, "urlFlag": { "type": "boolean", "nullable": true }, "createdOnDate": { "type": "string" }, "documentType": { "$ref": "#/components/schemas/DocumentTypeReference" }, "guid": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentSetup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "uploadAsLinkFlag": { "type": "boolean", "nullable": true }, "isPublicFlag": { "type": "boolean", "nullable": true }, "docPath": { "type": "string", "description": " Max length: 100;" }, "templatePath": { "type": "string", "description": " Max length: 200;" }, "templateOutputPath": { "type": "string", "description": " Max length: 200;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fileExtension": { "type": "string" }, "icon": { "type": "string" }, "mimeType": { "type": "string" }, "description": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnector": { "required": [ "serviceBoard", "defaultCompany", "emailErrorsTo" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "emailServerType": { "enum": [ "IMAP", "Office365", "Google", "Asio365" ], "type": "string", "nullable": true }, "imapSetup": { "$ref": "#/components/schemas/ImapSetupReference" }, "office365EmailSetup": { "$ref": "#/components/schemas/Office365EmailSetupReference" }, "asio365EmailSetup": { "$ref": "#/components/schemas/Office365EmailSetupReference" }, "googleEmailSetup": { "$ref": "#/components/schemas/GoogleEmailSetupReference" }, "serviceBoard": { "$ref": "#/components/schemas/BoardReference" }, "defaultCompany": { "$ref": "#/components/schemas/CompanyReference" }, "defaultMember": { "$ref": "#/components/schemas/MemberReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "emailNotifyFrom": { "type": "string", "description": " Max length: 50;" }, "bccEmailTo": { "type": "string", "description": " Max length: 250;" }, "emailErrorsTo": { "type": "string", "description": " Max length: 50;" }, "setEmailToDefaultContactFlag": { "type": "boolean", "nullable": true }, "noResponseFlag": { "type": "boolean", "nullable": true }, "neverRespondFlag": { "type": "boolean", "nullable": true }, "discardDuplicatesFlag": { "type": "boolean", "nullable": true }, "postRepliesToTicketFlag": { "type": "boolean", "nullable": true }, "createContactFlag": { "type": "boolean", "nullable": true }, "responseEmailForNew": { "type": "string" }, "responseEmailForExisting": { "type": "string" }, "sourceOverride": { "$ref": "#/components/schemas/ServiceSourceReference" }, "priorityOverride": { "$ref": "#/components/schemas/PriorityReference" }, "typeOverride": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subTypeOverride": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "itemOverride": { "$ref": "#/components/schemas/ServiceItemReference" }, "statusOverride": { "$ref": "#/components/schemas/ServiceStatusReference" }, "addCcFlag": { "type": "boolean", "nullable": true }, "inboundTicketMailboxId": { "type": "string" }, "useEmailMessageIdFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "defaultCompany": { "$ref": "#/components/schemas/CompanyReference" }, "imapSetup": { "$ref": "#/components/schemas/ImapSetupReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorParsingRule": { "required": [ "priority", "parsingVariable", "searchTerm" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parsingStyle": { "$ref": "#/components/schemas/EmailConnectorParsingStyleReference" }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "parsingVariable": { "$ref": "#/components/schemas/EmailConnectorParsingVariableReference" }, "searchTerm": { "type": "string", "description": " Max length: 250;" }, "servicePriority": { "$ref": "#/components/schemas/PriorityReference" }, "serviceStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "serviceSubType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "serviceItem": { "$ref": "#/components/schemas/ServiceItemReference" }, "serviceBoard": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorParsingStyle": { "required": [ "parsingType", "parseRule", "priority" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "parsingType": { "$ref": "#/components/schemas/EmailConnectorParsingTypeReference" }, "parseRule": { "type": "string", "description": " Max length: 500;" }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorParsingStyleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorParsingTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorParsingVariableReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailConnectorReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailExclusion": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 100;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailOpened": { "required": [ "contactId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "campaignId": { "type": "integer", "format": "int32", "nullable": true }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "dateOpened": { "type": "string", "format": "date-time" } } }, "EmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailToken": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "token": { "type": "string" }, "description": { "type": "string" }, "addressFlag": { "type": "boolean", "nullable": true }, "agreementFlag": { "type": "boolean", "nullable": true }, "companyFlag": { "type": "boolean", "nullable": true }, "configFlag": { "type": "boolean", "nullable": true }, "contactFlag": { "type": "boolean", "nullable": true }, "invoiceFlag": { "type": "boolean", "nullable": true }, "purchaseOrderFlag": { "type": "boolean", "nullable": true }, "purchaseOrderStatusFlag": { "type": "boolean", "nullable": true }, "rmaFlag": { "type": "boolean", "nullable": true }, "salesFlag": { "type": "boolean", "nullable": true }, "serviceFlag": { "type": "boolean", "nullable": true }, "tracksFlag": { "type": "boolean", "nullable": true }, "workflowFlag": { "type": "boolean", "nullable": true }, "portalPasswordFlag": { "type": "boolean", "nullable": true } } }, "EntityType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" } } }, "EntityTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "EntityTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EPayConfiguration": { "required": [ "location", "currency", "url", "storeIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "url": { "type": "string", "description": " Max length: 400;" }, "storeIdentifier": { "type": "string", "description": " Max length: 500;" }, "encryptionKey": { "type": "string", "description": " Max length: 500;" }, "initializationVector": { "type": "string", "description": " Max length: 500;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ErrorResponseMessage": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "ExistingTenantReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseDetailReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseEntry": { "required": [ "type", "amount", "date" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "expenseReport": { "$ref": "#/components/schemas/ExpenseReportReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "chargeToId": { "type": "integer", "format": "int32", "nullable": true }, "chargeToType": { "enum": [ "Company", "ServiceTicket", "ProjectTicket", "ChargeCode", "Activity" ], "type": "string", "description": "Gets or sets\n company or chargeToType is required.", "nullable": true }, "type": { "$ref": "#/components/schemas/ExpenseTypeReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodReference" }, "classification": { "$ref": "#/components/schemas/ClassificationReference" }, "amount": { "type": "number", "format": "double", "nullable": true }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "invoiceAmount": { "type": "number", "format": "double", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseTax" } }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "status": { "enum": [ "Open", "Rejected", "PendingApproval", "ErrorsCorrected", "PendingProjectApproval", "ApprovedByTierOne", "RejectBySecondTier", "ApprovedByTierTwo", "ReadyToBill", "Billed", "WrittenOff", "BilledAgreement" ], "type": "string", "nullable": true }, "billAmount": { "type": "number", "format": "double", "nullable": true }, "agreementAmount": { "type": "number", "format": "double", "nullable": true }, "odometerStart": { "type": "number", "format": "double", "nullable": true }, "odometerEnd": { "type": "number", "format": "double", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ExpenseEntryAudit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "source": { "enum": [ "None", "Member", "API", "Workflow", "Portal", "Mobile", "Network", "EmailConnector", "MassMaintenance", "Application", "SystemAPI", "Conversion" ], "type": "string", "nullable": true }, "type": { "enum": [ "Activity", "CloseDate", "Company", "Contact", "Conversion", "Document", "Forecast", "Note", "Notes", "Opportunity", "Products", "Stage", "Status", "Surveys", "Team", "Tracks", "Configuration", "ConfigurationQuestions", "DeviceBackupDetails", "Tickets", "Subject", "ActivityOverview", "Schedule", "Resources", "ExpenseEntry", "Member", "Date", "Classification", "Amount", "ExpenseType", "WorkType", "WorkRole", "Mileage", "Billing", "ExpenseHeader", "Project", "TimeEntry", "TicketStatus", "DateTime", "DeductHours", "ActualHours", "Invoice", "CompanyFinance", "Billable", "SalesOrder", "Shipping", "Profile", "Group", "GroupContact", "GroupCompany", "Options", "Site", "Agreement", "Addition", "Adjustment", "Microsoft365", "API", "ProjectFinance", "CompanyProfile", "CompanyTeam", "CompanyMgmt", "InvoiceTotal", "BillingInformation", "ShippingInformation", "BillingStatus", "Location", "Department", "Territory", "Payment", "Credit", "SubcontractorInformation", "InvoicingParameters", "ApplicationParameters", "Finance", "Invoicing", "Email", "Batching", "KnowledgeBase", "KbArticle", "KnowledgeBaseApproval", "KnowledgeBaseTicket", "ManageNetwork", "Tasks", "CustomField", "ScreenConnect", "SLA", "Ticket", "Workflow", "Record", "CombinedTickets", "Template", "PurchaseOrder", "Meeting", "RmaOverview", "ReturnedBy", "PurchasedFromVendor", "WarrantyVendor", "RepairVendor", "AdditionalDetails", "TicketTemplate", "AutoGeneration", "TimeInternalNote", "TimeDiscussion", "TimeInternal", "TimeResolution", "MemberTemplate", "Delegation", "Skill", "Certification", "Accrual", "ApiKey", "Login", "Notifications", "System", "ServiceBoard", "ProjectBoard", "Scheduling", "TimeBillingExpense", "CRM", "Procurement", "JobRole", "Details", "Authentication" ], "type": "string", "nullable": true }, "message": { "type": "string" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "value": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseReport": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "year": { "type": "integer", "format": "int32", "nullable": true }, "period": { "type": "integer", "format": "int32", "nullable": true }, "dateStart": { "type": "string" }, "dateEnd": { "type": "string" }, "status": { "enum": [ "Open", "Rejected", "PendingApproval", "ErrorsCorrected", "PendingProjectApproval", "ApprovedByTierOne", "RejectBySecondTier", "ApprovedByTierTwo", "ReadyToBill", "Billed", "WrittenOff", "BilledAgreement" ], "type": "string", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "dueDate": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseReportAudit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "source": { "enum": [ "None", "Member", "API", "Workflow", "Portal", "Mobile", "Network", "EmailConnector", "MassMaintenance", "Application", "SystemAPI", "Conversion" ], "type": "string", "nullable": true }, "type": { "enum": [ "Activity", "CloseDate", "Company", "Contact", "Conversion", "Document", "Forecast", "Note", "Notes", "Opportunity", "Products", "Stage", "Status", "Surveys", "Team", "Tracks", "Configuration", "ConfigurationQuestions", "DeviceBackupDetails", "Tickets", "Subject", "ActivityOverview", "Schedule", "Resources", "ExpenseEntry", "Member", "Date", "Classification", "Amount", "ExpenseType", "WorkType", "WorkRole", "Mileage", "Billing", "ExpenseHeader", "Project", "TimeEntry", "TicketStatus", "DateTime", "DeductHours", "ActualHours", "Invoice", "CompanyFinance", "Billable", "SalesOrder", "Shipping", "Profile", "Group", "GroupContact", "GroupCompany", "Options", "Site", "Agreement", "Addition", "Adjustment", "Microsoft365", "API", "ProjectFinance", "CompanyProfile", "CompanyTeam", "CompanyMgmt", "InvoiceTotal", "BillingInformation", "ShippingInformation", "BillingStatus", "Location", "Department", "Territory", "Payment", "Credit", "SubcontractorInformation", "InvoicingParameters", "ApplicationParameters", "Finance", "Invoicing", "Email", "Batching", "KnowledgeBase", "KbArticle", "KnowledgeBaseApproval", "KnowledgeBaseTicket", "ManageNetwork", "Tasks", "CustomField", "ScreenConnect", "SLA", "Ticket", "Workflow", "Record", "CombinedTickets", "Template", "PurchaseOrder", "Meeting", "RmaOverview", "ReturnedBy", "PurchasedFromVendor", "WarrantyVendor", "RepairVendor", "AdditionalDetails", "TicketTemplate", "AutoGeneration", "TimeInternalNote", "TimeDiscussion", "TimeInternal", "TimeResolution", "MemberTemplate", "Delegation", "Skill", "Certification", "Accrual", "ApiKey", "Login", "Notifications", "System", "ServiceBoard", "ProjectBoard", "Scheduling", "TimeBillingExpense", "CRM", "Procurement", "JobRole", "Details", "Authentication" ], "type": "string", "nullable": true }, "message": { "type": "string" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "value": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseReportReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseReportTierUpdate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "approvalType": { "enum": [ "DataEntry", "Tier1Update", "Tier2Update", "Billing", "Service", "Project", "MonthlySummary", "SalesActivity", "Schedule" ], "type": "string", "nullable": true } } }, "ExpenseRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseTax": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double", "nullable": true }, "type": { "$ref": "#/components/schemas/ExpenseTaxTypeReference" } } }, "ExpenseTaxTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactive": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseTaxTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseType": { "required": [ "name", "amountCaption", "billExpenses", "invoiceMarkupOption" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "amountCaption": { "type": "string" }, "reimbursementRate": { "type": "number", "format": "double", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "invoiceMarkupOption": { "enum": [ "Amount", "Mile", "Percent" ], "type": "string", "nullable": true }, "invoiceMarkupAmount": { "type": "number", "format": "double", "nullable": true }, "advancedAmountFlag": { "type": "boolean", "nullable": true }, "mileageFlag": { "type": "boolean", "nullable": true }, "quantityFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "format": "double", "nullable": true }, "integrationXRef": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseTypeExemption": { "required": [ "expenseType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "expenseType": { "$ref": "#/components/schemas/ExpenseTypeReference" }, "taxableLevels": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "amountCaption": { "type": "string" }, "mileageFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Experiment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "experimentId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "properties": { "type": "string" }, "inactiveFlag": { "type": "boolean" }, "memberInactiveFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExportAccountingBatchRequest": { "type": "object", "properties": { "batchIdentifier": { "type": "string", "description": " Max length: 50;" }, "glInterfaceIdentifier": { "type": "string" }, "thruDate": { "type": "string", "format": "date-time" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "summarizeInvoices": { "enum": [ "Default", "Condensed", "Detailed" ], "type": "string" }, "exportInvoicesFlag": { "type": "boolean", "description": "Batch export must include invoices, expenses, or products (procurement).", "nullable": true }, "includedInvoiceIds": { "type": "array", "items": { "type": "integer", "format": "int32", "nullable": true } }, "excludedInvoiceIds": { "type": "array", "items": { "type": "integer", "format": "int32", "nullable": true } }, "exportExpensesFlag": { "type": "boolean", "description": "Batch export must include invoices, expenses, or products (procurement).", "nullable": true }, "includedExpenseIds": { "type": "array", "items": { "type": "integer", "format": "int32", "nullable": true } }, "excludedExpenseIds": { "type": "array", "items": { "type": "integer", "format": "int32", "nullable": true } }, "exportPaymentsFlag": { "type": "boolean", "description": "Batch export must include invoices, expenses, or products (procurement).", "nullable": true }, "includedPaymentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "exportProductsFlag": { "type": "boolean", "description": "Batch export must include invoices, expenses, or products (procurement).", "nullable": true }, "includedProductIds": { "type": "array", "items": { "type": "string" } }, "excludedProductIds": { "type": "array", "items": { "type": "string" } } } }, "FileUploadSetting": { "required": [ "restrictFileTypesFlag" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "restrictFileTypesFlag": { "type": "boolean", "nullable": true }, "globalFileSizeLimit": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "FilterValues": { "type": "object", "properties": { "conditions": { "type": "string" }, "orderBy": { "type": "string" }, "childconditions": { "type": "string" }, "customfieldconditions": { "type": "string" } } }, "Finance.Currency": { "required": [ "currencyIdentifier", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "currencyIdentifier": { "type": "string", "description": " Max length: 10;" }, "name": { "type": "string", "description": " Max length: 50;" }, "symbol": { "type": "string", "description": " Max length: 10;" }, "displayIdFlag": { "type": "boolean", "nullable": true }, "displaySymbolFlag": { "type": "boolean", "nullable": true }, "currencyCode": { "$ref": "#/components/schemas/CurrencyCodeReference" }, "thousandsSeparator": { "type": "string", "description": " Max length: 1;" }, "decimalSeparator": { "type": "string", "description": " Max length: 1;" }, "negativeParenthesesFlag": { "type": "boolean", "nullable": true }, "rightAlign": { "type": "boolean", "nullable": true }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "reportFormat": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Forecast": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "forecastItems": { "type": "array", "items": { "$ref": "#/components/schemas/ForecastItem" } }, "productRevenue": { "$ref": "#/components/schemas/ProductRevenueReference" }, "serviceRevenue": { "$ref": "#/components/schemas/ServiceRevenueReference" }, "agreementRevenue": { "$ref": "#/components/schemas/AgreementRevenueReference" }, "timeRevenue": { "$ref": "#/components/schemas/TimeRevenueReference" }, "expenseRevenue": { "$ref": "#/components/schemas/ExpenseRevenueReference" }, "forecastRevenueTotals": { "$ref": "#/components/schemas/ForecastRevenueReference" }, "inclusiveRevenueTotals": { "$ref": "#/components/schemas/InclusiveRevenueReference" }, "recurringTotal": { "type": "number", "format": "double", "nullable": true }, "wonRevenue": { "$ref": "#/components/schemas/WonRevenueReference" }, "lostRevenue": { "$ref": "#/components/schemas/LostRevenueReference" }, "openRevenue": { "$ref": "#/components/schemas/OpenRevenueReference" }, "otherRevenue1": { "$ref": "#/components/schemas/Other1RevenueReference" }, "otherRevenue2": { "$ref": "#/components/schemas/Other2RevenueReference" }, "salesTaxRevenue": { "type": "number", "format": "double", "nullable": true }, "forecastTotalWithTaxes": { "type": "number", "format": "double", "nullable": true }, "expectedProbability": { "type": "integer", "format": "int32" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ForecastItem": { "required": [ "opportunity", "status", "forecastType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "forecastDescription": { "type": "string", "description": " Max length: 50;" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "quantity": { "type": "number", "format": "double" }, "status": { "$ref": "#/components/schemas/OpportunityStatusReference" }, "catalogItem": { "$ref": "#/components/schemas/IvItemReference" }, "productDescription": { "type": "string" }, "productClass": { "type": "string" }, "revenue": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double" }, "percentage": { "type": "integer", "format": "int32" }, "includeFlag": { "type": "boolean" }, "quoteWerksDocNo": { "type": "string", "description": " Max length: 20;" }, "quoteWerksDocName": { "type": "string", "description": " Max length: 255;" }, "quoteWerksQuantity": { "type": "integer", "format": "int32" }, "forecastType": { "enum": [ "Other1", "Other2", "Agreement", "Product", "Service" ], "type": "string", "nullable": true }, "linkFlag": { "type": "boolean" }, "recurringRevenue": { "type": "number", "format": "double" }, "recurringCost": { "type": "number", "format": "double", "nullable": true }, "recurringDateStart": { "type": "string", "format": "date-time" }, "recurringDateEnd": { "type": "string", "format": "date-time" }, "billCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "cycleBasis": { "type": "string" }, "cycles": { "type": "integer", "format": "int32" }, "recurringFlag": { "type": "boolean" }, "sequenceNumber": { "type": "number", "format": "double" }, "subNumber": { "type": "integer", "format": "int32" }, "taxableFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ForecastRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "FormSubmitted": { "required": [ "contactId", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "campaignId": { "type": "integer", "format": "int32", "nullable": true }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "dateSubmitted": { "type": "string", "format": "date-time" }, "url": { "type": "string", "description": " Max length: 2083;" }, "queryString": { "type": "string" }, "pageType": { "type": "string" }, "pageSubType": { "type": "string" }, "topic": { "type": "string" }, "version": { "type": "string" }, "status": { "type": "string" } } }, "GenericBoardTeamReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "isProjectTeamFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GenericIdIdentifierReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" } } }, "GenericNameIdDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "GLAccount": { "required": [ "glType", "mappedType", "mappedRecord" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "glType": { "enum": [ "AP", "AR", "EE", "EI", "EO", "IA", "IT", "P", "PF", "R", "RA", "RD", "RE", "RP", "ST", "SD", "ET", "FT", "PT", "WP", "WR" ], "type": "string", "nullable": true }, "mappedType": { "$ref": "#/components/schemas/MappedTypeReference" }, "mappedRecord": { "$ref": "#/components/schemas/MappedRecordReference" }, "segment1": { "type": "string", "description": " Max length: 255;" }, "segment2": { "type": "string", "description": " Max length: 255;" }, "segment3": { "type": "string", "description": " Max length: 255;" }, "segment4": { "type": "string", "description": " Max length: 255;" }, "segment5": { "type": "string", "description": " Max length: 255;" }, "segment6": { "type": "string", "description": " Max length: 255;" }, "segment7": { "type": "string", "description": " Max length: 255;" }, "segment8": { "type": "string", "description": " Max length: 255;" }, "segment9": { "type": "string", "description": " Max length: 255;" }, "segment10": { "type": "string", "description": " Max length: 255;" }, "cogs1": { "type": "string", "description": " Max length: 255;" }, "cogs2": { "type": "string", "description": " Max length: 255;" }, "cogs3": { "type": "string", "description": " Max length: 255;" }, "cogs4": { "type": "string", "description": " Max length: 255;" }, "cogs5": { "type": "string", "description": " Max length: 255;" }, "cogs6": { "type": "string", "description": " Max length: 255;" }, "cogs7": { "type": "string", "description": " Max length: 255;" }, "cogs8": { "type": "string", "description": " Max length: 255;" }, "cogs9": { "type": "string", "description": " Max length: 255;" }, "cogs10": { "type": "string", "description": " Max length: 255;" }, "productId": { "type": "string", "description": " Max length: 255;" }, "inventory": { "type": "string", "description": " Max length: 255;" }, "salesCode": { "type": "string", "description": " Max length: 255;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GLCaption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "segment1": { "type": "string", "description": " Max length: 255;" }, "segment2": { "type": "string", "description": " Max length: 255;" }, "segment3": { "type": "string", "description": " Max length: 255;" }, "segment4": { "type": "string", "description": " Max length: 255;" }, "segment5": { "type": "string", "description": " Max length: 255;" }, "segment6": { "type": "string", "description": " Max length: 255;" }, "segment7": { "type": "string", "description": " Max length: 255;" }, "segment8": { "type": "string", "description": " Max length: 255;" }, "segment9": { "type": "string", "description": " Max length: 255;" }, "segment10": { "type": "string", "description": " Max length: 255;" }, "segment1type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment2type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment3type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment4type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment5type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment6type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment7type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment8type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment9type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "segment10type": { "enum": [ "Account", "Class" ], "type": "string", "nullable": true }, "cogs1": { "type": "string", "description": " Max length: 255;" }, "cogs2": { "type": "string", "description": " Max length: 255;" }, "cogs3": { "type": "string", "description": " Max length: 255;" }, "cogs4": { "type": "string", "description": " Max length: 255;" }, "cogs5": { "type": "string", "description": " Max length: 255;" }, "cogs6": { "type": "string", "description": " Max length: 255;" }, "cogs7": { "type": "string", "description": " Max length: 255;" }, "cogs8": { "type": "string", "description": " Max length: 255;" }, "cogs9": { "type": "string", "description": " Max length: 255;" }, "cogs10": { "type": "string", "description": " Max length: 255;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GLEntry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "amount": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "description": " Max length: 100;" }, "segment1": { "type": "string", "description": " Max length: 255;" }, "segment2": { "type": "string", "description": " Max length: 255;" }, "segment3": { "type": "string", "description": " Max length: 255;" }, "segment4": { "type": "string", "description": " Max length: 255;" }, "segment5": { "type": "string", "description": " Max length: 255;" }, "segment6": { "type": "string", "description": " Max length: 255;" }, "segment7": { "type": "string", "description": " Max length: 255;" }, "segment8": { "type": "string", "description": " Max length: 255;" }, "segment9": { "type": "string", "description": " Max length: 255;" }, "segment10": { "type": "string", "description": " Max length: 255;" }, "productId": { "type": "string", "description": " Max length: 255;" }, "cost": { "type": "number", "format": "double", "nullable": true }, "salesCode": { "type": "string", "description": " Max length: 255;" }, "inventory": { "type": "string", "description": " Max length: 255;" }, "cogs1": { "type": "string", "description": " Max length: 255;" }, "cogs2": { "type": "string", "description": " Max length: 255;" }, "cogs3": { "type": "string", "description": " Max length: 255;" }, "cogs4": { "type": "string", "description": " Max length: 255;" }, "cogs5": { "type": "string", "description": " Max length: 255;" }, "cogs6": { "type": "string", "description": " Max length: 255;" }, "cogs7": { "type": "string", "description": " Max length: 255;" }, "cogs8": { "type": "string", "description": " Max length: 255;" }, "cogs9": { "type": "string", "description": " Max length: 255;" }, "cogs10": { "type": "string", "description": " Max length: 255;" }, "isBatched": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GLExport": { "type": "object", "properties": { "exportSettings": { "$ref": "#/components/schemas/GLExportSettings" }, "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportVendor" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportCustomer" } }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportTransaction" } }, "expenses": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportExpense" } }, "expenseBills": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportExpenseBill" } }, "purchaseTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportPurchaseTransaction" } }, "adjustmentTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportAdjustmentTransaction" } }, "inventoryTransfers": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportInventoryTransfer" } } } }, "GLExportAdjustmentTransaction": { "type": "object", "properties": { "id": { "type": "string" }, "documentType": { "type": "string" }, "documentDate": { "type": "string" }, "glTypeID": { "type": "string" }, "accountNumber": { "type": "string" }, "memo": { "type": "string" }, "glClass": { "type": "string" }, "adjustmentDescription": { "type": "string" }, "adjustmentDetail": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportAdjustmentTransactionDetail" } } } }, "GLExportAdjustmentTransactionDetail": { "type": "object", "properties": { "glClass": { "type": "string" }, "description": { "type": "string" }, "memo": { "type": "string" }, "item": { "$ref": "#/components/schemas/IvItemReference" }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "costAccountNumber": { "type": "string" }, "inventoryAccountNumber": { "type": "string" }, "accountNumber": { "type": "string" }, "productAccountNumber": { "type": "string" } } }, "GLExportCustomer": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "accountNumber": { "type": "string" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "billingTermsXref": { "type": "string" }, "dueDays": { "type": "integer", "format": "int32", "nullable": true }, "taxable": { "type": "boolean", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "stateTaxXref": { "type": "string" }, "countyTaxXref": { "type": "string" }, "cityTaxXref": { "type": "string" }, "countryTaxXref": { "type": "string" }, "compositeTaxXref": { "type": "string" }, "stateTaxRate": { "type": "number", "format": "double", "nullable": true }, "countyTaxRate": { "type": "number", "format": "double", "nullable": true }, "cityTaxRate": { "type": "number", "format": "double", "nullable": true }, "countryTaxRate": { "type": "number", "format": "double", "nullable": true }, "compositeTaxRate": { "type": "number", "format": "double", "nullable": true }, "taxGroupRate": { "type": "number", "format": "double", "nullable": true }, "taxAgencyXref": { "type": "string" }, "stateTaxAgencyXref": { "type": "string" }, "countyTaxAgencyXref": { "type": "string" }, "cityTaxAgencyXref": { "type": "string" }, "countryTaxAgencyXref": { "type": "string" }, "compositeTaxAgencyXref": { "type": "string" }, "taxLevels": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportCustomerTaxLevel" } } } }, "GLExportCustomerTaxLevel": { "type": "object", "properties": { "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxCodeXref": { "type": "string" }, "agencyXref": { "type": "string" }, "taxLevel": { "type": "integer", "format": "int32" } } }, "GLExportExpense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "documentDate": { "type": "string" }, "documentType": { "type": "string" }, "apAccountNumber": { "type": "string" }, "apClass": { "type": "string" }, "accountNumber": { "type": "string" }, "glClass": { "type": "string" }, "glTypeId": { "type": "string" }, "memo": { "type": "string" }, "description": { "type": "string" }, "periodStartDate": { "type": "string" }, "periodEndDate": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "vendorNumber": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyAccountNumber": { "type": "string" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "offset": { "$ref": "#/components/schemas/GLExportExpenseOffset" } } }, "GLExportExpenseBill": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "documentDate": { "type": "string" }, "documentType": { "type": "string" }, "documentNumber": { "type": "string" }, "memo": { "type": "string" }, "glClass": { "type": "string" }, "apAccountNumber": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "vendorNumber": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "detail": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportExpenseBillDetail" } } } }, "GLExportExpenseBillDetail": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "documentDate": { "type": "string" }, "glTypeId": { "type": "string" }, "memo": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "accountNumber": { "type": "string" }, "expenseClass": { "$ref": "#/components/schemas/ClassificationReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "billable": { "type": "boolean", "nullable": true }, "reimbursable": { "type": "boolean", "nullable": true }, "companyAdvance": { "type": "boolean", "nullable": true } } }, "GLExportExpenseOffset": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "documentDate": { "type": "string" }, "documentType": { "type": "string" }, "accountNumber": { "type": "string" }, "glTypeId": { "type": "string" }, "glClass": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "memo": { "type": "string" }, "description": { "type": "string" }, "total": { "type": "number", "format": "double", "nullable": true } } }, "GLExportInventoryTransfer": { "type": "object", "properties": { "id": { "type": "string" }, "documentType": { "type": "string" }, "documentDate": { "type": "string" }, "accountNumber": { "type": "string" }, "glClass": { "type": "string" }, "glTypeId": { "type": "string" }, "description": { "type": "string" }, "salesCode": { "type": "string" }, "memo": { "type": "string" }, "costAccountNumber": { "type": "string" }, "inventoryAccountNumber": { "type": "string" }, "transferId": { "type": "integer", "format": "int32", "nullable": true }, "item": { "$ref": "#/components/schemas/IvItemReference" }, "glItemId": { "type": "string" }, "salesDescription": { "type": "string" }, "itemDescription": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "itemPrice": { "type": "number", "format": "double", "nullable": true }, "taxable": { "type": "boolean", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "subCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "serializedFlag": { "type": "boolean", "nullable": true }, "serialNumbers": { "type": "string" }, "bin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "transferFromBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "transferFromLocationXref": { "type": "string" }, "transferToBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "transferToLocationXref": { "type": "string" }, "locationXref": { "type": "string" }, "priceLevelXref": { "type": "string" }, "uomScheduleXref": { "type": "string" }, "itemTypeXref": { "type": "string" }, "inventoryXref": { "type": "string" }, "cogsXref": { "type": "string" }, "taxNote": { "type": "string" }, "offset": { "$ref": "#/components/schemas/GLExportInventoryTransferOffset" } } }, "GLExportInventoryTransferOffset": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "documentType": { "type": "string" }, "documentDate": { "type": "string" }, "accountNumber": { "type": "string" }, "glClass": { "type": "string" }, "total": { "type": "number", "format": "double", "nullable": true }, "memo": { "type": "string" }, "description": { "type": "string" }, "glTypeId": { "type": "string" } } }, "GLExportPurchaseTransaction": { "type": "object", "properties": { "id": { "type": "string" }, "documentDate": { "type": "string" }, "documentNumber": { "type": "string" }, "description": { "type": "string" }, "memo": { "type": "string" }, "apAccountNumber": { "type": "string" }, "purchaseDate": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "purchaseClass": { "type": "string" }, "freightAmount": { "type": "number", "format": "double", "nullable": true }, "freightPackingSlip": { "type": "string" }, "packingSlip": { "type": "string" }, "dropshipFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "billingTermsXref": { "type": "string" }, "dueDays": { "type": "integer", "format": "int32", "nullable": true }, "vendorNumber": { "type": "string" }, "vendorAccountNumber": { "type": "string" }, "vendorInvoiceDate": { "type": "string" }, "vendorInvoiceNumber": { "type": "string" }, "taxAgencyXref": { "type": "string" }, "stateTaxXref": { "type": "string" }, "countyTaxXref": { "type": "string" }, "cityTaxXref": { "type": "string" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToCompanyAccountNumber": { "type": "string" }, "shipToCompanyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "shipToTaxGroup": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "taxGroupRate": { "type": "number", "format": "double", "nullable": true }, "useAvalaraTaxFlag": { "type": "boolean", "nullable": true }, "purchaseHeaderTaxGroup": { "type": "string" }, "purchaseHeaderTaxableFlag": { "type": "boolean", "nullable": true }, "purchaseHeaderFreightTaxableFlag": { "type": "boolean", "nullable": true }, "taxLevels": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportPurchaseTransactionTaxLevel" } }, "purchaseDetail": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportPurchaseTransactionDetail" } }, "purchaseDetailTax": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportPurchaseTransactionDetailTax" } } } }, "GLExportPurchaseTransactionDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "documentDate": { "type": "string" }, "glClass": { "type": "string" }, "glTypeId": { "type": "string" }, "glItemId": { "type": "string" }, "salesCode": { "type": "string" }, "description": { "type": "string" }, "cost": { "type": "number", "format": "double", "nullable": true }, "memo": { "type": "string" }, "taxNote": { "type": "string" }, "vendorNumber": { "type": "string" }, "accountNumber": { "type": "string" }, "costAccountNumber": { "type": "string" }, "inventoryAccountNumber": { "type": "string" }, "vendorAccountNumber": { "type": "string" }, "item": { "$ref": "#/components/schemas/IvItemReference" }, "itemDescription": { "type": "string" }, "salesDescription": { "type": "string" }, "taxable": { "type": "boolean", "nullable": true }, "itemPrice": { "type": "number", "format": "double", "nullable": true }, "itemCost": { "type": "number", "format": "double", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "serializedFlag": { "type": "boolean", "nullable": true }, "serialNumbers": { "type": "string" }, "dropShippedFlag": { "type": "boolean", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "warehouseSite": { "$ref": "#/components/schemas/SiteReference" }, "subCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "shipmentMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "itemTypeXref": { "type": "string" }, "inventoryXref": { "type": "string" }, "cogsXref": { "type": "string" }, "uomScheduleXref": { "type": "string" }, "priceLevelXref": { "type": "string" }, "locationXref": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "purchaseHeaderTaxGroup": { "type": "string" }, "taxCodeXref": { "type": "string" }, "taxRate": { "type": "number", "format": "double" }, "taxAgencyXref": { "type": "string" } } }, "GLExportPurchaseTransactionDetailTax": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "documentDate": { "type": "string" }, "accountNumber": { "type": "string" }, "glClass": { "type": "string" }, "cost": { "type": "number", "format": "double", "nullable": true }, "salesCode": { "type": "string" }, "glTypeId": { "type": "string" }, "glItemId": { "type": "string" }, "memo": { "type": "string" }, "vendorNumber": { "type": "string" }, "vendorAccountNumber": { "type": "string" }, "costAccountNumber": { "type": "string" }, "inventoryAccountNumber": { "type": "string" }, "itemTypeXref": { "type": "string" }, "inventoryXref": { "type": "string" }, "cogsXref": { "type": "string" }, "uomScheduleXref": { "type": "string" }, "priceLevelXref": { "type": "string" }, "locationXref": { "type": "string" }, "item": { "$ref": "#/components/schemas/IvItemReference" }, "taxableFlag": { "type": "boolean", "nullable": true }, "salesDescription": { "type": "string" }, "itemDescription": { "type": "string" }, "itemPrice": { "type": "number", "format": "double", "nullable": true }, "itemCost": { "type": "number", "format": "double", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "serializedFlag": { "type": "boolean", "nullable": true }, "serialNumbers": { "type": "string" }, "dropShippedFlag": { "type": "boolean", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32" }, "warehouseSite": { "$ref": "#/components/schemas/SiteReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "shipmentMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "subCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxRatePercent": { "type": "number", "format": "double", "nullable": true }, "taxAgencyXref": { "type": "string" }, "taxNote": { "type": "string" }, "purchaseHeaderTaxGroup": { "type": "string" } } }, "GLExportPurchaseTransactionTaxLevel": { "type": "object", "properties": { "taxCodeXref": { "type": "string" }, "taxLevel": { "type": "integer", "format": "int32" } } }, "GLExportSettings": { "type": "object" }, "GLExportTransaction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "glClass": { "type": "string" }, "glTypeId": { "type": "string" }, "documentDate": { "type": "string" }, "documentNumber": { "type": "string" }, "documentType": { "type": "string" }, "memo": { "type": "string" }, "description": { "type": "string" }, "attention": { "type": "string" }, "salesTerritory": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "companyAccountNumber": { "type": "string" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "billingTermsXref": { "type": "string" }, "dueDays": { "type": "integer", "format": "int32", "nullable": true }, "dueDate": { "type": "string" }, "emailDeliveryFlag": { "type": "boolean", "nullable": true }, "printDeliveryFlag": { "type": "boolean", "nullable": true }, "agreementPrePaymentFlag": { "type": "boolean", "nullable": true }, "accountNumber": { "type": "string" }, "billingType": { "type": "string" }, "glEntryIds": { "type": "string" }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrderReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "salesRepId": { "type": "string" }, "salesRepName": { "type": "string" }, "taxable": { "type": "boolean", "nullable": true }, "taxableTotal": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "taxGroupRate": { "type": "number", "format": "double", "nullable": true }, "piggyBackFlag": { "type": "boolean", "nullable": true }, "taxAccountNumber": { "type": "string" }, "salesTax": { "type": "number", "format": "double", "nullable": true }, "stateTax": { "type": "number", "format": "double", "nullable": true }, "countyTax": { "type": "number", "format": "double", "nullable": true }, "cityTax": { "type": "number", "format": "double", "nullable": true }, "taxableAmount1": { "type": "number", "format": "double", "nullable": true }, "taxableAmount2": { "type": "number", "format": "double", "nullable": true }, "taxableAmount3": { "type": "number", "format": "double", "nullable": true }, "taxableAmount4": { "type": "number", "format": "double", "nullable": true }, "taxableAmount5": { "type": "number", "format": "double", "nullable": true }, "taxAgencyXref": { "type": "string" }, "stateTaxXref": { "type": "string" }, "countyTaxXref": { "type": "string" }, "taxId": { "type": "string" }, "taxDpAppliedFlag": { "type": "boolean", "nullable": true }, "useAvalaraFlag": { "type": "boolean", "nullable": true }, "sendAvalaraTaxFlag": { "type": "boolean", "nullable": true }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToCompanyAccountNumber": { "type": "string" }, "shipToCompanyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "shipToTaxId": { "type": "string" }, "shipSite": { "$ref": "#/components/schemas/SiteReference" }, "shipContact": { "type": "string" }, "detail": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportTransactionDetail" } }, "taxLevels": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportTransactionTaxLevel" } } } }, "GLExportTransactionDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "documentDate": { "type": "string" }, "documentType": { "type": "string" }, "accountNumber": { "type": "string" }, "glClass": { "type": "string" }, "glTypeId": { "type": "string" }, "glItemId": { "type": "string" }, "invoiceSummaryOption": { "type": "string" }, "cost": { "type": "number", "format": "double", "nullable": true }, "salesCode": { "type": "string" }, "memo": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "timeEntry": { "$ref": "#/components/schemas/TimeEntryReference" }, "costAccountNumber": { "type": "string" }, "inventoryAccountNumber": { "type": "string" }, "productAccountNumber": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "taxCodeXref": { "type": "string" }, "taxAgencyXref": { "type": "string" }, "taxNote": { "type": "string" }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxRatePercent": { "type": "number", "format": "double", "nullable": true }, "taxableFlag": { "type": "boolean", "nullable": true }, "taxable2Flag": { "type": "boolean", "nullable": true }, "taxable3Flag": { "type": "boolean", "nullable": true }, "taxable4Flag": { "type": "boolean", "nullable": true }, "taxable5Flag": { "type": "boolean", "nullable": true }, "item": { "$ref": "#/components/schemas/IvItemReference" }, "product": { "$ref": "#/components/schemas/ProductReference" }, "itemTaxableFlag": { "type": "boolean", "nullable": true }, "itemPrice": { "type": "number", "format": "double", "nullable": true }, "itemCost": { "type": "number", "format": "double", "nullable": true }, "itemDescription": { "type": "string" }, "salesDescription": { "type": "string" }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "subCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "serializedFlag": { "type": "boolean", "nullable": true }, "serialNumbers": { "type": "string" }, "warehouseSite": { "$ref": "#/components/schemas/SiteReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "shipmentMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "dropShippedFlag": { "type": "boolean", "nullable": true }, "itemTypeXref": { "type": "string" }, "inventoryXref": { "type": "string" }, "cogsXref": { "type": "string" }, "uomScheduleXref": { "type": "string" }, "priceLevelXref": { "type": "string" }, "locationXref": { "type": "string" }, "taxLevels": { "type": "array", "items": { "$ref": "#/components/schemas/GLExportTransactionDetailTaxLevel" } } } }, "GLExportTransactionDetailTaxLevel": { "type": "object", "properties": { "taxableFlag": { "type": "boolean" }, "taxLevel": { "type": "integer", "format": "int32" } } }, "GLExportTransactionTaxLevel": { "type": "object", "properties": { "taxAmount": { "type": "number", "format": "double", "nullable": true }, "taxableAmount": { "type": "number", "format": "double", "nullable": true }, "taxCodeXref": { "type": "string" }, "taxLevel": { "type": "integer", "format": "int32" } } }, "GLExportVendor": { "type": "object", "properties": { "member": { "$ref": "#/components/schemas/MemberReference" }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "vendorNumber": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "accountNumber": { "type": "string" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "dueDays": { "type": "integer", "format": "int32", "nullable": true }, "site": { "$ref": "#/components/schemas/SiteReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" } } }, "GLPath": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "path": { "type": "string", "description": " Max length: 255;" }, "sqlServerName": { "type": "string", "description": " Max length: 255;" }, "databaseName": { "type": "string", "description": " Max length: 100;" }, "lastPaymentSync": { "type": "string", "format": "date-time" }, "lastPaymentSyncBy": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleEmailSetup": { "required": [ "name", "username", "inboxFolder", "processedFolder", "failedFolder" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 200;" }, "username": { "type": "string", "description": " Max length: 100;" }, "inboxFolder": { "type": "string", "description": " Max length: 40;" }, "processedFolder": { "type": "string", "description": " Max length: 40;" }, "failedFolder": { "type": "string", "description": " Max length: 40;" }, "clientId": { "type": "string", "description": " Max length: 200;" }, "privateKey": { "type": "string", "description": " Max length: 4000;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "emailConnector": { "$ref": "#/components/schemas/EmailConnectorReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GoogleEmailSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Group": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "publicDescription": { "type": "string", "description": " Max length: 255;" }, "publicFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GroupInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GroupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Holiday": { "required": [ "name", "date" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "allDayFlag": { "type": "boolean", "description": "Can be set to false to set a holiday for specific hours (Defaults to True).", "nullable": true }, "date": { "type": "string", "format": "date" }, "timeStart": { "type": "string" }, "timeEnd": { "type": "string" }, "holidayList": { "$ref": "#/components/schemas/HolidayListReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HolidayInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "allDayFlag": { "type": "boolean", "description": "Can be set to false to set a holiday for specific hours (Defaults to True).", "nullable": true }, "date": { "type": "string" }, "timeStart": { "type": "string" }, "timeEnd": { "type": "string" }, "holidayList": { "$ref": "#/components/schemas/HolidayListReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HolidayList": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HolidayListInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HolidayListReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "HttpContent": { "type": "object", "properties": { "headers": { "type": "array", "items": { } } } }, "HttpMethod": { "type": "object", "properties": { "get": { "$ref": "#/components/schemas/HttpMethod" }, "put": { "$ref": "#/components/schemas/HttpMethod" }, "post": { "$ref": "#/components/schemas/HttpMethod" }, "delete": { "$ref": "#/components/schemas/HttpMethod" }, "head": { "$ref": "#/components/schemas/HttpMethod" }, "options": { "$ref": "#/components/schemas/HttpMethod" }, "trace": { "$ref": "#/components/schemas/HttpMethod" }, "method": { "type": "string" } } }, "HttpRequestMessage": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Version" }, "content": { "$ref": "#/components/schemas/HttpContent" }, "method": { "$ref": "#/components/schemas/HttpMethod" }, "requestUri": { "type": "string" }, "headers": { "type": "array", "items": { } }, "properties": { "type": "object", "additionalProperties": { "type": "object" } } } }, "HttpResponseMessage": { "type": "object", "properties": { "version": { "$ref": "#/components/schemas/Version" }, "content": { "$ref": "#/components/schemas/HttpContent" }, "statusCode": { "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], "type": "string" }, "reasonPhrase": { "type": "string" }, "headers": { "type": "array", "items": { } }, "requestMessage": { "$ref": "#/components/schemas/HttpRequestMessage" }, "isSuccessStatusCode": { "type": "boolean" } } }, "IdCollection": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "Imap": { "required": [ "name", "imapName", "processedName", "failedFolder", "server", "userName", "port" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 200;" }, "imapName": { "type": "string", "description": " Max length: 40;" }, "processedName": { "type": "string", "description": " Max length: 40;" }, "failedFolder": { "type": "string", "description": " Max length: 40;" }, "server": { "type": "string", "description": " Max length: 200;" }, "userName": { "type": "string", "description": " Max length: 80;" }, "password": { "type": "string", "description": " Max length: 80;" }, "port": { "type": "integer", "format": "int32", "nullable": true }, "sslFlag": { "type": "boolean", "nullable": true }, "emailConnector": { "$ref": "#/components/schemas/EmailConnectorReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ImapInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "emailConnector": { "$ref": "#/components/schemas/EmailConnectorReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ImapSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Impact": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "description": " Max length: 200;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ImportMassMaintenance": { "type": "object", "properties": { "deletedContactCount": { "type": "integer", "format": "int32" }, "deletedCompanyCount": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "success": { "type": "boolean" } } }, "InclusiveRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Info": { "type": "object", "properties": { "version": { "type": "string" }, "isCloud": { "type": "boolean" }, "serverTimeZone": { "type": "string" }, "licenseBits": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseBit" } }, "cloudRegion": { "type": "string" }, "maxWorkFlowRecordsAllowed": { "type": "integer", "format": "int32" } } }, "InOutBoard": { "required": [ "member", "inOutType", "dateBack" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "inOutType": { "$ref": "#/components/schemas/InOutTypeReference" }, "additionalInfo": { "type": "string", "description": " Max length: 100;" }, "dateBack": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InOutType": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InOutTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InOutTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IntegratorLogin": { "required": [ "username" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "username": { "type": "string", "description": " Max length: 50;" }, "password": { "type": "string", "description": "The password will never be returned in response. Max length: 50;" }, "canAccessAllRecordsFlag": { "type": "boolean", "description": "This flag controls whether the integrator can access only the db records it created, or all system records.", "nullable": true }, "canAccessAllApisFlag": { "type": "boolean", "description": "Setting this flag to true will create an integrator that can access all of the available apis in the system.\n If this field is set to true, both the member and board fields are required.", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "dateInactivated": { "type": "string", "format": "date-time" }, "inactivatedBy": { "$ref": "#/components/schemas/MemberReference" }, "serviceTicketApiFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "serviceBoardCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "serviceBoardLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "timeEntryApiFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "timeEntryCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "timeEntryLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "managedServicesApiFlag": { "type": "boolean", "nullable": true }, "managedServicesAutoChildFlag": { "type": "boolean", "nullable": true }, "managedServicesChildingFlag": { "type": "boolean", "description": "True if integrator is allowed to child configurations.", "nullable": true }, "contactApiFlag": { "type": "boolean", "nullable": true }, "contactCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "contactLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "companyApiFlag": { "type": "boolean", "nullable": true }, "companyCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "companyLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "activityApiFlag": { "type": "boolean", "nullable": true }, "activityCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "activityLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "invoiceApiFlag": { "type": "boolean", "nullable": true }, "productApiFlag": { "type": "boolean", "nullable": true }, "productCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "productLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "opportunityApiFlag": { "type": "boolean", "nullable": true }, "opportunityCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "opportunityLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "opportunityConversionApiFlag": { "type": "boolean", "description": "True if the member has access to the Opportunity Conversion Api.", "nullable": true }, "memberApiFlag": { "type": "boolean", "nullable": true }, "marketingApiFlag": { "type": "boolean", "nullable": true }, "purchasingApiFlag": { "type": "boolean", "nullable": true }, "purchasingCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "purchasingLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "reportingApiFlag": { "type": "boolean", "nullable": true }, "systemApiFlag": { "type": "boolean", "nullable": true }, "projectApiFlag": { "type": "boolean", "nullable": true }, "projectCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "projectLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "configurationApiFlag": { "type": "boolean", "nullable": true }, "configurationAutoChildFlag": { "type": "boolean", "nullable": true }, "configurationChildlingFlag": { "type": "boolean", "description": "True if integrator is allowed to child configurations.", "nullable": true }, "configurationCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "configurationLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "scheduleApiFlag": { "type": "boolean", "nullable": true }, "scheduleCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "scheduleLegacyCallbackFlag": { "type": "boolean", "nullable": true }, "agreementApiFlag": { "type": "boolean", "nullable": true }, "agreementCallbackUrl": { "type": "string", "description": " Max length: 1000;" }, "agreementCallbackLegacyFlag": { "type": "boolean", "nullable": true }, "documentApiFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IntegratorLoginReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IntegratorTag": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IntegratorTagCollection": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } } } }, "InventoryOnHand": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "onHand": { "type": "integer", "format": "int32", "nullable": true }, "serialNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/OnHandSerialNumberReference" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Invoice": { "required": [ "type", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "invoiceNumber": { "type": "string", "description": " Max length: 15; Required On Updates;" }, "type": { "enum": [ "Agreement", "CreditMemo", "DownPayment", "Miscellaneous", "Progress", "Standard" ], "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/BillingStatusReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "accountNumber": { "type": "string" }, "applyToType": { "enum": [ "All", "Agreement", "Project", "ProjectPhase", "SalesOrder", "Ticket" ], "type": "string", "nullable": true }, "applyToId": { "type": "integer", "format": "int32", "nullable": true }, "attention": { "type": "string", "description": " Max length: 60;" }, "shipToAttention": { "type": "string", "description": " Max length: 60;" }, "billingSite": { "$ref": "#/components/schemas/SiteReference" }, "billingSiteAddressLine1": { "type": "string" }, "billingSiteAddressLine2": { "type": "string" }, "billingSiteCity": { "type": "string" }, "billingSiteState": { "type": "string" }, "billingSiteZip": { "type": "string" }, "billingSiteCountry": { "type": "string" }, "shippingSite": { "$ref": "#/components/schemas/SiteReference" }, "shippingSiteAddressLine1": { "type": "string" }, "shippingSiteAddressLine2": { "type": "string" }, "shippingSiteCity": { "type": "string" }, "shippingSiteState": { "type": "string" }, "shippingSiteZip": { "type": "string" }, "shippingSiteCountry": { "type": "string" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "reference": { "type": "string", "description": " Max length: 50;" }, "customerPO": { "type": "string", "description": " Max length: 50;" }, "templateSetupId": { "type": "integer", "description": "Can be obtained via InvoiceTemplate report.", "format": "int32", "nullable": true }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateDetailReference" }, "emailTemplateId": { "type": "integer", "description": "Can be obtained via InvoiceEmailTemplate report.", "format": "int32", "nullable": true }, "addToBatchEmailList": { "type": "boolean", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "restrictDownpaymentFlag": { "type": "boolean", "nullable": true }, "locationId": { "type": "integer", "description": " Required On Updates;", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "departmentId": { "type": "integer", "description": "departmentId is only required for special invoices.", "format": "int32", "nullable": true }, "department": { "$ref": "#/components/schemas/BillingUnitReference" }, "territoryId": { "type": "integer", "format": "int32", "nullable": true }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "topComment": { "type": "string" }, "bottomComment": { "type": "string" }, "taxableFlag": { "type": "boolean", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "internalNotes": { "type": "string" }, "downpaymentPreviouslyTaxedFlag": { "type": "boolean", "nullable": true }, "serviceTotal": { "type": "number", "format": "double", "nullable": true }, "overrideDownPaymentAmountFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "dueDate": { "type": "string", "format": "date-time" }, "expenseTotal": { "type": "number", "format": "double", "nullable": true }, "productTotal": { "type": "number", "format": "double", "nullable": true }, "previousProgressApplied": { "type": "number", "format": "double", "nullable": true }, "serviceAdjustmentAmount": { "type": "number", "format": "double", "nullable": true }, "agreementAmount": { "type": "number", "format": "double", "nullable": true }, "downpaymentApplied": { "type": "number", "format": "double", "nullable": true }, "subtotal": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "remainingDownpayment": { "type": "number", "format": "double", "nullable": true }, "salesTax": { "type": "number", "format": "double", "nullable": true }, "adjustmentReason": { "type": "string" }, "adjustedBy": { "type": "string" }, "closedBy": { "type": "string" }, "payments": { "type": "number", "format": "double", "nullable": true }, "credits": { "type": "number", "format": "double", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "specialInvoiceFlag": { "type": "boolean", "nullable": true }, "billingSetupReference": { "$ref": "#/components/schemas/BillingSetupReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrderReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "glBatch": { "$ref": "#/components/schemas/BatchReference" }, "unbatchedBatch": { "$ref": "#/components/schemas/BatchReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "InvoiceCommission": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "percent": { "type": "number", "format": "double", "nullable": true }, "splitPercent": { "type": "number", "format": "double", "nullable": true }, "adjustment": { "type": "number", "format": "double", "nullable": true }, "netAmount": { "type": "number", "format": "double", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "activity": { "$ref": "#/components/schemas/ActivityReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrderReference" }, "adjustedBy": { "type": "string" }, "adjustedDate": { "type": "string" }, "adjustmentReason": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceEmailTemplate": { "required": [ "name", "subject" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "serviceSurvey": { "$ref": "#/components/schemas/ServiceSurveyReference" }, "useSenderFlag": { "type": "boolean", "nullable": true }, "firstName": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "lastName": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "emailAddress": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "subject": { "type": "string", "description": " Max length: 200;" }, "body": { "type": "string" }, "copySenderFlag": { "type": "boolean", "nullable": true }, "invoiceStatus": { "$ref": "#/components/schemas/BillingStatusReference" }, "attachInvoiceFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceEmailTemplateInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceGrouping": { "required": [ "name", "customerDescription" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "customerDescription": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "showPriceFlag": { "type": "boolean", "nullable": true }, "showSubItemsFlag": { "type": "boolean", "nullable": true }, "groupParentChildAdditionsFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceGroupingReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string" }, "showPriceFlag": { "type": "boolean" }, "showSubItemsFlag": { "type": "boolean" }, "groupParentChildAdditionsFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "invoice": { "$ref": "#/components/schemas/Invoice" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplate" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItem" } }, "bundledComponentsInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ProductComponent" } }, "expenses": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseEntry" } }, "timeEntries": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } }, "logo": { "$ref": "#/components/schemas/DocumentInfo" }, "billingSetup": { "$ref": "#/components/schemas/BillingSetup" }, "agreementBillingInfo": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementBillingInfo" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoicePayment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "source": { "enum": [ "Default", "WisePay" ], "type": "string" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "credit": { "$ref": "#/components/schemas/InvoiceReference" }, "amount": { "type": "number", "format": "double", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "invoiceBalance": { "type": "number", "format": "double", "nullable": true }, "invoiceTotal": { "type": "number", "format": "double", "nullable": true }, "paymentDate": { "type": "string", "format": "date-time" }, "appliedBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "wisePayPayment": { "$ref": "#/components/schemas/WisePayPayment" }, "paymentSyncStatus": { "enum": [ "Unapplied", "Applied", "Synced" ], "type": "string" }, "glBatchID": { "type": "string", "description": " Max length: 50;" }, "paymentSyncDate": { "type": "string", "format": "date-time" }, "paymentAccount": { "type": "string" }, "aRPaymentAccount": { "type": "string" } } }, "InvoiceReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "billingType": { "type": "string" }, "applyToType": { "type": "string" }, "invoiceDate": { "type": "string" }, "chargeFirmFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceRouting": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "reviewedFlag": { "type": "boolean" }, "dateReviewedUTC": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceTemplate": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "marginLeft": { "type": "number", "format": "double", "nullable": true }, "marginRight": { "type": "number", "format": "double", "nullable": true }, "marginTop": { "type": "number", "format": "double", "nullable": true }, "marginBottom": { "type": "number", "format": "double", "nullable": true }, "logoVisibleFlag": { "type": "boolean", "nullable": true }, "headerLogoPosition": { "enum": [ "Center", "LeftSide", "RightSide" ], "type": "string", "nullable": true }, "remitToVisibleFlag": { "type": "boolean", "nullable": true }, "headerAddressPosition": { "enum": [ "Center", "LeftSide", "RightSide" ], "type": "string", "nullable": true }, "headerTitleVisibleFlag": { "type": "boolean", "nullable": true }, "headerTitleCaption": { "type": "string", "description": " Max length: 50;" }, "headerTitlePosition": { "enum": [ "Center", "LeftSide", "RightSide" ], "type": "string", "nullable": true }, "headerTitleFont": { "enum": [ "Regular", "RegularBold", "Large", "LargeBold", "ExtraLarge", "ExtraLargeBold" ], "type": "string", "nullable": true }, "headerTermsVisibleFlag": { "type": "boolean", "nullable": true }, "headerTermsCaption": { "type": "string", "description": " Max length: 50;" }, "headerDueDateVisibleFlag": { "type": "boolean", "nullable": true }, "headerDueDateCaption": { "type": "string", "description": " Max length: 50;" }, "headerPoNumberVisibleFlag": { "type": "boolean", "nullable": true }, "headerPoNumberCaption": { "type": "string", "description": " Max length: 50;" }, "headerReferenceVisibleFlag": { "type": "boolean", "nullable": true }, "headerReferenceCaption": { "type": "string", "description": " Max length: 50;" }, "headerAccountVisibleFlag": { "type": "boolean", "nullable": true }, "headerAccountCaption": { "type": "string", "description": " Max length: 50;" }, "headerTaxIdVisibleFlag": { "type": "boolean", "nullable": true }, "headerTaxIdCaption": { "type": "string", "description": " Max length: 50;" }, "headerShipToVisibleFlag": { "type": "boolean", "nullable": true }, "headerShipToCaption": { "type": "string", "description": " Max length: 50;" }, "headerHoursBasedExtendedAmountVisibleFlag": { "type": "boolean", "nullable": true }, "payableCaption": { "type": "string", "description": " Max length: 1000;" }, "serviceHeaderTicketNumberVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderTicketNumberCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderCompanyNameVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderCompanyNameCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderSummaryVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderSummaryCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderContactNameVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderContactNameCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderDetailDescriptionVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderDetailDescriptionCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderResolutionVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderResolutionCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderAmountVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderAmountCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderBillingMethodVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderBillingMethodCaption": { "type": "string", "description": " Max length: 50;" }, "serviceHeaderClosedTasksVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderOpenTasksVisibleFlag": { "type": "boolean", "nullable": true }, "serviceHeaderBundledTicketsVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderProjectNameVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderProjectNameCaption": { "type": "string", "description": " Max length: 50;" }, "projectHeaderCompanyNameVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderCompanyNameCaption": { "type": "string", "description": " Max length: 50;" }, "projectHeaderOriginalDownpaymentVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderOriginalDownpaymentCaption": { "type": "string", "description": " Max length: 50;" }, "projectHeaderContactNameVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderContactNameCaption": { "type": "string", "description": " Max length: 50;" }, "projectHeaderAmountVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderAmountCaption": { "type": "string", "description": " Max length: 50;" }, "projectHeaderBillingMethodVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderBillingMethodCaption": { "type": "string", "description": " Max length: 50;" }, "projectHeaderBillingTypeVisibleFlag": { "type": "boolean", "nullable": true }, "projectHeaderBillingTypeCaption": { "type": "string", "description": " Max length: 50;" }, "invoicePaymentAmountVisibleFlag": { "type": "boolean", "nullable": true }, "invoicePaymentAmountCaption": { "type": "string", "description": " Max length: 50;" }, "invoiceCreditAmountVisibleFlag": { "type": "boolean", "nullable": true }, "invoiceCreditAmountCaption": { "type": "string", "description": " Max length: 50;" }, "invoiceBalanceDueVisibleFlag": { "type": "boolean", "nullable": true }, "invoiceBalanceDueCaption": { "type": "string", "description": " Max length: 50;" }, "creditCreditAmountVisibleFlag": { "type": "boolean", "nullable": true }, "creditCreditAmountCaption": { "type": "string", "description": " Max length: 50;" }, "creditRemainingAmountVisibleFlag": { "type": "boolean", "nullable": true }, "creditRemainingAmountCaption": { "type": "string", "description": " Max length: 50;" }, "timeDetailVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailPrimarySortField": { "type": "string" }, "timeDetailPrimarySortDirection": { "type": "string" }, "timeDetailSecondarySortField": { "type": "string" }, "timeDetailSecondarySortDirection": { "type": "string" }, "timeDetailSubtotalVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailStartEndTimeVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailHoursVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailMembersVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailBillableVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailExtendedAmountVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailDollarAmountsOnHourseBasedVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailHourlyRateVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailContactsVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailNotesVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailNonBillableCaption": { "type": "string", "description": " Max length: 50;" }, "timeDetailAgreementVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailHoursBasedHoursVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailHoursBasedExtAmountVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailHoursbasedHourlyRateVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailAmountBasedHoursVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailAmountBasedExtAmountVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailAmountBasedHourlyRateVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailSRTicketSummaryVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailSRContactVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailSRAddressVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailPmPhaseVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailPmSummaryVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailTicketNumberVisibleFlag": { "type": "boolean", "nullable": true }, "timeDetailDatesVisibleFlag": { "type": "boolean", "nullable": true }, "servicesStaffCaption": { "type": "string", "description": " Max length: 50;" }, "servicesStaffVisibleFlag": { "type": "boolean", "nullable": true }, "servicesAmountCaption": { "type": "string", "description": " Max length: 50;" }, "servicesAmountVisibleFlag": { "type": "boolean", "nullable": true }, "servicesHoursCaption": { "type": "string", "description": " Max length: 50;" }, "servicesHoursVisibleFlag": { "type": "boolean", "nullable": true }, "servicesRateCaption": { "type": "string", "description": " Max length: 50;" }, "servicesRateVisibleFlag": { "type": "boolean", "nullable": true }, "servicesWorkRoleCaption": { "type": "string", "description": " Max length: 50;" }, "servicesWorkRoleVisibleFlag": { "type": "boolean", "nullable": true }, "servicesWorkTypeCaption": { "type": "string", "description": " Max length: 50;" }, "servicesWorkTypeVisibleFlag": { "type": "boolean", "nullable": true }, "servicesTotalVisibleFlag": { "type": "boolean", "nullable": true }, "servicesMemberNameVisibleFlag": { "type": "boolean", "nullable": true }, "servicesMemberNameCaption": { "type": "string", "description": " Max length: 50;" }, "currencyIdVisibleFlag": { "type": "boolean", "nullable": true }, "currencySymbolVisibleFlag": { "type": "boolean", "nullable": true }, "portalFlag": { "type": "boolean", "nullable": true }, "servicesCollapsedFlag": { "type": "boolean", "nullable": true }, "expensesCollapsedFlag": { "type": "boolean", "nullable": true }, "otherChargesCollapsedFlag": { "type": "boolean", "nullable": true }, "expensesTypeCaption": { "type": "string", "description": " Max length: 50;" }, "expensesStaffCaption": { "type": "string", "description": " Max length: 50;" }, "expensesAmountCaption": { "type": "string", "description": " Max length: 50;" }, "expensesTypeVisibleFlag": { "type": "boolean", "nullable": true }, "expensesStaffVisibleFlag": { "type": "boolean", "nullable": true }, "expensesAmountVisibleFlag": { "type": "boolean", "nullable": true }, "expensesTotalVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailSubtotalVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailMembersVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailContactsVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailBillableVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailExtAmountVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailNotesVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailPrimarySortField": { "type": "string" }, "expenseDetailPrimarySortDirection": { "type": "string" }, "expenseDetailSecondarySortField": { "type": "string" }, "expenseDetailSecondarySortDirection": { "type": "string" }, "expenseDetailNonbillableCaption": { "type": "string", "description": " Max length: 50;" }, "expenseDetailVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailAgreementVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailAgreementExtAmountVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailTicketNumberVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailSrTicketSummaryVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailSrContactVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailSrAddressVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailPmPhaseVisibleFlag": { "type": "boolean", "nullable": true }, "expenseDetailPmSummaryVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesAmountCaption": { "type": "string", "description": " Max length: 50;" }, "otherChargesAmountVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesDescriptionCaption": { "type": "string", "description": " Max length: 50;" }, "otherChargesDescriptionVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesDisplaySixDecimals": { "type": "boolean", "nullable": true }, "otherChargesItemIdVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesPriceCaption": { "type": "string", "description": " Max length: 50;" }, "otherChargesPriceVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesQuantityCaption": { "type": "string", "description": " Max length: 50;" }, "otherChargesQuantityVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesSerialNumberVisibleFlag": { "type": "boolean", "nullable": true }, "otherChargesTotalVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentDescriptionVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentDescriptionCaption": { "type": "string", "description": " Max length: 50;" }, "adjustmentQuantityVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentQuantityCaption": { "type": "string", "description": " Max length: 50;" }, "adjustmentAmountVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentAmountCaption": { "type": "string", "description": " Max length: 50;" }, "adjustmentAgrTypeVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentTotalVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentPriceVisibleFlag": { "type": "boolean", "nullable": true }, "adjustmentPriceCaption": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceTemplateDetailReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or sets invoice Template Setup Id.", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceTemplateSetup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "customFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IRestIdentifiedItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" } } }, "IvItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "serializedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KBCategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseArticle": { "required": [ "title", "issue", "resolution" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "issue": { "type": "string" }, "resolution": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "subCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string" }, "createdBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "approver": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseSettings": { "required": [ "requireApproval" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "requireApproval": { "type": "boolean", "nullable": true }, "defaultApprover": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseSubCategory": { "required": [ "name", "category" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "category": { "$ref": "#/components/schemas/KBCategoryReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KPI": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "$ref": "#/components/schemas/KPICategoryReference" }, "dateFilter": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true } } }, "KPICategory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true } } }, "KPICategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KPIReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LdapConfiguration": { "required": [ "name", "server", "domain" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "server": { "type": "string", "description": "FQDN of the Server. Max length: 200;" }, "domain": { "type": "string", "description": "Domain Name of the server. Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LdapConfigurationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LdapConfigurationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "server": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LdapConfigurationTestLink": { "required": [ "Server" ], "type": "object", "properties": { "server": { "type": "string", "description": " Max length: 200;" } } }, "LegacySubCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LegacySubCategoryInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LicenseBit": { "type": "object", "properties": { "name": { "type": "string" }, "activeFlag": { "type": "boolean" } } }, "Link": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "tableReferenceId": { "type": "integer", "format": "int32", "nullable": true }, "url": { "type": "string", "description": " Max length: 1000;" }, "screenLink": { "enum": [ "Company", "Contact", "Service", "Invoice", "PurchaseOrder", "SalesOrder" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LinkClicked": { "required": [ "contactId", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "campaignId": { "type": "integer", "format": "int32", "nullable": true }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "dateClicked": { "type": "string", "format": "date-time" }, "url": { "type": "string", "description": " Max length: 2083;" }, "queryString": { "type": "string" } } }, "LinkInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "screenLink": { "enum": [ "Company", "Contact", "Service", "Invoice", "PurchaseOrder", "SalesOrder" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LinkResolveUrlInfo": { "required": [ "referenceId" ], "type": "object", "properties": { "referenceId": { "type": "integer", "format": "int32", "nullable": true }, "url": { "type": "string" } } }, "LocaleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "localeCode": { "type": "string" } } }, "LocaleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Location": { "required": [ "structureLevel", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ownerLevelId": { "type": "integer", "format": "int32", "nullable": true }, "structureLevel": { "$ref": "#/components/schemas/CorporateStructureLevelReference" }, "name": { "type": "string", "description": " Max length: 50;" }, "manager": { "$ref": "#/components/schemas/MemberReference" }, "reportsTo": { "$ref": "#/components/schemas/SystemLocationReference" }, "salesRep": { "type": "string", "description": " Max length: 50;" }, "timeZoneSetup": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "overrideAddressLine1": { "type": "string", "description": " Max length: 50;" }, "overrideAddressLine2": { "type": "string", "description": " Max length: 50;" }, "overrideCity": { "type": "string", "description": " Max length: 50;" }, "overrideState": { "type": "string", "description": " Max length: 50;" }, "overrideZip": { "type": "string", "description": " Max length: 12;" }, "overrideCountry": { "$ref": "#/components/schemas/CountryReference" }, "overridePhoneNumber": { "type": "string", "description": " Max length: 15;" }, "overrideFaxNumber": { "type": "string", "description": " Max length: 15;" }, "owaUrl": { "type": "string", "description": " Max length: 100;" }, "payrollXref": { "type": "string", "description": " Max length: 10;" }, "locationFlag": { "type": "boolean", "nullable": true }, "clientFlag": { "type": "boolean", "nullable": true }, "workRoleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "departmentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LocationDepartment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LocationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location_flag": { "type": "boolean" }, "structureLevel": { "$ref": "#/components/schemas/CorporateStructureLevelReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LocationWorkRole": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workRoleInactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LostRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "M365Contact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userPrincipalName": { "type": "string" }, "displayName": { "type": "string" }, "contactRecId": { "type": "integer", "format": "int32" }, "tenantId": { "type": "string" }, "m365ContactId": { "type": "string" }, "department": { "type": "string" }, "employeeType": { "type": "string" }, "managerId": { "type": "string" }, "proxyAddresses": { "type": "string" }, "proxyAddressesPlain": { "type": "string" }, "groups": { "type": "string" }, "directoryRoles": { "type": "string" }, "assignedLicenses": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "M365ContactSyncInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "M365ContactSyncMonitoring": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "monitoringTypeId": { "type": "integer", "format": "int32" }, "emailAddress": { "type": "string" }, "serviceBoardId": { "type": "integer", "format": "int32", "nullable": true }, "serviceBoardStatusId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "M365ContactSyncProperty": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "includeExcludeType": { "enum": [ "All", "M365Property", "None" ], "type": "string", "nullable": true }, "propertyType": { "enum": [ "City", "DepartmentContactSync", "Email", "DistributionGroup", "JobTitle", "AssignedLicenses", "DisplayName", "OfficeLocation", "ReportManager", "State", "EmployeeType", "UserType" ], "type": "string", "nullable": true }, "excludeIncludeFlag": { "type": "boolean" }, "wildCard": { "type": "string" }, "companyRecID": { "type": "integer", "format": "int32" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDeviceAccount": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "username": { "type": "string" }, "password": { "type": "string" }, "managedDevicesIntegration": { "$ref": "#/components/schemas/ManagedDevicesIntegrationReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegration": { "required": [ "name", "solution", "loginBy", "defaultBillingLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "solution": { "type": "string", "description": " Max length: 30;" }, "portalUrl": { "type": "string", "description": " Max length: 200;" }, "loginBy": { "enum": [ "Global", "Member" ], "type": "string", "nullable": true }, "globalLoginUsername": { "type": "string", "description": "Gets or sets\n this is only required when globalLoginFlag = true. Max length: 50;" }, "globalLoginPassword": { "type": "string", "description": "Gets or sets\n this is only required when globalLoginFlag = true. Max length: 50;" }, "defaultBillingLevel": { "enum": [ "Detail", "Summary" ], "type": "string", "nullable": true }, "managementItSetupType": { "type": "string" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "integratorLogin": { "$ref": "#/components/schemas/IntegratorLoginReference" }, "matchOnSerialNumberFlag": { "type": "boolean", "nullable": true }, "disableNewCrossReferencesFlag": { "type": "boolean", "nullable": true }, "configBillCustomerFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegrationCrossReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "managedDevicesIntegration": { "$ref": "#/components/schemas/ManagedDevicesIntegrationReference" }, "vendorType": { "type": "string", "description": " Max length: 255;" }, "vendorLevel": { "type": "string", "description": " Max length: 255;" }, "agreementType": { "$ref": "#/components/schemas/AgreementTypeReference" }, "product": { "$ref": "#/components/schemas/IvItemReference" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegrationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "solution": { "type": "string" }, "managementItSetupType": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegrationLogin": { "required": [ "username", "member" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "managedDevicesIntegration": { "$ref": "#/components/schemas/ManagedDevicesIntegrationReference" }, "username": { "type": "string", "description": " Max length: 50;" }, "password": { "type": "string", "description": " Max length: 50;" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegrationNotification": { "required": [ "notifyWho", "logType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "managedDevicesIntegration": { "$ref": "#/components/schemas/ManagedDevicesIntegrationReference" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "logType": { "enum": [ "All", "Error", "NewManagedSolution", "NewDeviceType", "NewConfiguration", "NewAddition", "Info" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegrationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedInformation": { "type": "object", "properties": { "managementSolutionName": { "type": "string" }, "managedIdentifier": { "type": "string" }, "type": { "type": "string" }, "level": { "type": "string" }, "childConfigurationsMatchingOn": { "type": "string" }, "inactivateConfigurationsMatchingOn": { "type": "string" }, "inactiveConfigurationStatusId": { "type": "integer", "format": "int32" } } }, "Management": { "required": [ "addedConfigurationStatus", "deletedConfigurationStatus", "integratorLogin", "scheduleExecutiveSummaryReportFlag" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "runTime": { "type": "string", "format": "date-time" }, "addedConfigurationStatus": { "$ref": "#/components/schemas/ConfigurationStatusReference" }, "deletedConfigurationStatus": { "$ref": "#/components/schemas/ConfigurationStatusReference" }, "integratorLogin": { "$ref": "#/components/schemas/IntegratorLoginReference" }, "scheduleExecutiveSummaryReportFlag": { "type": "boolean", "nullable": true }, "executiveSummaryReportScheduleDay": { "type": "integer", "description": "Gets or sets\n this is only required when scheduleExecutiveSummaryReportFlag = true.", "format": "int32", "nullable": true }, "executiveSummaryReportScheduleHour": { "type": "integer", "description": "Gets or sets\n this is only required when scheduleExecutiveSummaryReportFlag = true. Input should be in 24 hour format, ie 2pm is 14.", "format": "int32", "nullable": true }, "executiveSummaryReportScheduleMinute": { "type": "integer", "description": "Gets or sets\n this is only required when scheduleExecutiveSummaryReportFlag = true.", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementBackup": { "required": [ "type", "item", "billingLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "item": { "$ref": "#/components/schemas/CatalogItemReference" }, "billingLevel": { "enum": [ "Detail", "Summary" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementItSolution": { "required": [ "name", "managementItSolutionType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "managementItSolutionType": { "enum": [ "LevelPlatforms", "NAble", "Continuum", "Custom" ], "type": "string", "nullable": true }, "managementSolutionName": { "type": "string", "description": "Gets or sets\n this is only required when managementItSolutionType is Custom. Max length: 30;" }, "managementServerUrl": { "type": "string", "description": "Gets or sets\n this is only required for Level Platforms. Max length: 200;" }, "webserviceOverrideUrl": { "type": "string", "description": "Gets or sets\n this is only required for Level Platforms when overrideWebServiceLocationFlag is true. Max length: 200;" }, "portalOverrideLoginUrl": { "type": "string", "description": "Gets or sets\n this is only required for Level Platforms when overrideLoginLocationFlag is true. Max length: 200;" }, "globalLoginFlag": { "type": "boolean", "nullable": true }, "globalLoginUsername": { "type": "string", "description": "Gets or sets\n this is only required when globalLoginFlag = true. Max length: 50;" }, "globalLoginPassword": { "type": "string", "description": "Gets or sets\n this is only required when globalLoginFlag = true. Max length: 50;" }, "usingSslFlag": { "type": "boolean", "nullable": true }, "nAbleUsername": { "type": "string", "description": "Gets or sets\n this is only required for N-Able solution. Max length: 50;" }, "nAblePassword": { "type": "string", "description": "Gets or sets\n this is only required for N-Able solution. Max length: 50;" }, "overrideWebServiceLocationFlag": { "type": "boolean", "nullable": true }, "overrideLoginLocationFlag": { "type": "boolean", "nullable": true }, "continuumApiUsername": { "type": "string", "description": "Gets or sets\n this is only required for Continuum solution. Max length: 100;" }, "continuumApiPassword": { "type": "string", "description": "Gets or sets\n this is only required for Continuum solution. Max length: 100;" }, "levelApiUsername": { "type": "string", "description": "Gets or sets\n this is only required for Level Platforms solution. Max length: 100;" }, "levelApiPassword": { "type": "string", "description": "Gets or sets\n this is only required for Level Platforms solution. Max length: 100;" }, "levelVarDomain": { "type": "string", "description": "Gets or sets\n this is only required for Level Platforms solution. Max length: 100;" }, "noDisplayFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementItSolutionAgreementInterfaceParameter": { "required": [ "agreementType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "managedDevicesIntegration": { "$ref": "#/components/schemas/ManagedDevicesIntegrationReference" }, "agreementType": { "$ref": "#/components/schemas/AgreementTypeReference" }, "serverProduct": { "$ref": "#/components/schemas/IvItemReference" }, "workstationProduct": { "$ref": "#/components/schemas/IvItemReference" }, "spamStatsProduct": { "$ref": "#/components/schemas/IvItemReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementLogDocumentInfo": { "type": "object", "properties": { "fullPathFileName": { "type": "string" }, "fileSize": { "type": "string" } } }, "ManagementNetworkSecurity": { "required": [ "name", "site" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "username": { "type": "string", "description": " Max length: 50;" }, "password": { "type": "string", "description": " Max length: 50;" }, "site": { "type": "string", "description": " Max length: 100;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementReportNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": " Max length: 50;" }, "globalFlag": { "type": "boolean", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementReportSetup": { "required": [ "scheduledReportDisabledFlag" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scheduledReportDisabledFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementSolutionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "setupName": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Manufacturer": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManufacturerInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManufacturerReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MappedRecordReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" } } }, "MappedType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "table": { "type": "string" }, "recIdField": { "type": "string" }, "glType": { "enum": [ "AP", "AR", "EE", "EI", "EO", "IA", "IT", "P", "PF", "R", "RA", "RD", "RE", "RP", "ST", "SD", "ET", "FT", "PT", "WP", "WR" ], "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } } }, "MappedTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketDescription": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketDescriptionInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketDescriptionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketingCompany": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "defaultContactFlag": { "type": "boolean", "nullable": true }, "allContactsFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketingContact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32", "nullable": true }, "note": { "type": "string", "description": " Max length: 50;" }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketplaceImport": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "marketplaceImportType": { "enum": [ "Agreements", "Configurations", "CRMSurveys", "CustomReports", "CustomerPortalTypes", "HTMLEmailTemplates", "Products", "ProjectBoards", "ProjectTemplates", "ReportWriterReports", "ServiceBoards", "TicketTemplates", "Views" ], "type": "string" }, "marketplaceObject": { "type": "array", "items": { } }, "requiredFields": { "type": "array", "items": { "type": "string" } } } }, "Member": { "required": [ "identifier", "licenseClass", "firstName", "lastName", "hireDate", "defaultEmail", "defaultPhone", "securityRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "password": { "type": "string", "description": "ConditionallyRequired. API Member will get random password generated Max length: 60;" }, "disableOnlineFlag": { "type": "boolean", "nullable": true }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "notes": { "type": "string" }, "employeeIdentifer": { "type": "string", "description": " Max length: 10;" }, "vendorNumber": { "type": "string" }, "enableMobileGpsFlag": { "type": "boolean", "nullable": true }, "inactiveDate": { "type": "string", "format": "date-time" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "lastLogin": { "type": "string" }, "clientId": { "type": "string" }, "token": { "type": "string" }, "firstName": { "type": "string", "description": " Max length: 30;" }, "middleInitial": { "type": "string", "description": " Max length: 1;" }, "lastName": { "type": "string", "description": " Max length: 30;" }, "hireDate": { "type": "string", "format": "date-time" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "officeEmail": { "type": "string", "description": " Max length: 250;" }, "mobileEmail": { "type": "string", "description": " Max length: 250;" }, "homeEmail": { "type": "string", "description": " Max length: 250;" }, "defaultEmail": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "primaryEmail": { "type": "string", "description": " Max length: 250;" }, "officePhone": { "type": "string", "description": " Max length: 15;" }, "officeExtension": { "type": "string", "description": " Max length: 10;" }, "mobilePhone": { "type": "string", "description": " Max length: 15;" }, "mobileExtension": { "type": "string", "description": " Max length: 10;" }, "homePhone": { "type": "string", "description": " Max length: 15;" }, "homeExtension": { "type": "string", "description": " Max length: 10;" }, "defaultPhone": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "securityRole": { "$ref": "#/components/schemas/SecurityRoleReference" }, "office365": { "$ref": "#/components/schemas/MemberOffice365" }, "mapiName": { "type": "string" }, "calendarSyncIntegrationFlag": { "type": "boolean", "nullable": true }, "authenticationServiceType": { "enum": [ "AuthAnvil", "GoogleAuthenticator", "Email" ], "type": "string", "nullable": true }, "timebasedOneTimePasswordActivated": { "type": "boolean", "nullable": true }, "enableLdapAuthenticationFlag": { "type": "boolean", "nullable": true }, "ldapConfiguration": { "$ref": "#/components/schemas/LdapConfigurationReference" }, "ldapUserName": { "type": "string", "description": " Max length: 50;" }, "directionalSync": { "$ref": "#/components/schemas/DirectionalSyncReference" }, "ssoSettings": { "$ref": "#/components/schemas/MemberSsoSettingsReference" }, "signature": { "type": "string" }, "phoneIntegrationType": { "enum": [ "TAPI", "SKYPE", "TEL", "CALLTO", "NONE" ], "type": "string", "nullable": true }, "useBrowserLanguageFlag": { "type": "boolean", "nullable": true }, "title": { "type": "string" }, "reportCard": { "$ref": "#/components/schemas/ReportCardReference" }, "enableMobileFlag": { "type": "boolean", "nullable": true }, "type": { "$ref": "#/components/schemas/MemberTypeReference" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "partnerPortalFlag": { "type": "boolean", "nullable": true }, "stsUserAdminUrl": { "type": "string" }, "toastNotificationFlag": { "type": "boolean", "nullable": true }, "memberPersonas": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "adminFlag": { "type": "boolean", "nullable": true }, "structureLevel": { "$ref": "#/components/schemas/StructureReference" }, "securityLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "reportsTo": { "$ref": "#/components/schemas/MemberReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "billableForecast": { "type": "number", "format": "double", "nullable": true }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "hourlyCost": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "includeInUtilizationReportingFlag": { "type": "boolean", "nullable": true }, "requireExpenseEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeSheetEntryFlag": { "type": "boolean", "nullable": true }, "requireStartAndEndTimeOnTimeEntryFlag": { "type": "boolean", "nullable": true }, "allowInCellEntryOnTimeSheet": { "type": "boolean", "nullable": true }, "enterTimeAgainstCompanyFlag": { "type": "boolean", "nullable": true }, "allowExpensesEnteredAgainstCompaniesFlag": { "type": "boolean", "nullable": true }, "timeReminderEmailFlag": { "type": "boolean", "nullable": true }, "daysTolerance": { "type": "integer", "format": "int32", "nullable": true }, "minimumHours": { "type": "number", "format": "double", "nullable": true }, "timeSheetStartDate": { "type": "string" }, "serviceDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "restrictServiceDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictServiceDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "teams": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serviceBoardTeamIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "projectDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "projectDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectDefaultBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "restrictProjectDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictProjectDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedProjectBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "scheduleDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "scheduleDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "scheduleCapacity": { "type": "number", "format": "double", "nullable": true }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "restrictScheduleFlag": { "type": "boolean", "nullable": true }, "hideMemberInDispatchPortalFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "restrictDefaultSalesTerritoryFlag": { "type": "boolean", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "restrictDefaultWarehouseFlag": { "type": "boolean", "nullable": true }, "restrictDefaultWarehouseBinFlag": { "type": "boolean", "nullable": true }, "companyActivityTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceTimeTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceScreenDefaultTabFormat": { "enum": [ "ShowInvoicingTab", "ShowAgreementInvoicingTab" ], "type": "string", "nullable": true }, "invoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "agreementInvoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "autoStartStopwatch": { "type": "boolean", "nullable": true }, "autoPopupQuickNotesWithStopwatch": { "type": "boolean", "nullable": true }, "globalSearchDefaultTicketFilter": { "enum": [ "OpenRecords", "ClosedRecords", "AllRecords" ], "type": "string", "nullable": true }, "globalSearchDefaultSort": { "enum": [ "None", "LastUpdatedDesc", "LastUpdatedAsc", "CreatedDesc", "CreatedAsc" ], "type": "string", "nullable": true }, "phoneSource": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "copyPodLayouts": { "type": "boolean" }, "copySharedDefaultViews": { "type": "boolean" }, "copyColumnLayoutsAndFilters": { "type": "boolean" }, "fromMemberRecId": { "type": "integer", "format": "int32" }, "fromMemberTemplateRecId": { "type": "integer", "format": "int32" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "MemberAccrual": { "required": [ "accrualType", "year", "hours", "reason" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "accrualType": { "enum": [ "Holiday", "PTO", "Sick", "Vacation" ], "type": "string", "nullable": true }, "year": { "type": "integer", "format": "int32", "nullable": true }, "hours": { "type": "number", "format": "double", "nullable": true }, "reason": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberCertification": { "required": [ "certification" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "certification": { "$ref": "#/components/schemas/CertificationReference" }, "percentComplete": { "type": "integer", "format": "int32", "nullable": true }, "dateReceived": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "certificationNumber": { "type": "string", "description": " Max length: 50;" }, "notes": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberDeactivation": { "type": "object", "properties": { "activity": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "serviceTeam": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "companyTeam": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDeactivationCompanyTeam" }, "description": "A list of customers for which the member holds a team role" }, "workflowEmail": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "serviceStatusWorkflow": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDeactivationStatusWorkflow" } }, "ticketTemplate": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "opportunity": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "salesTeam": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "projectManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "projectTimeApprover": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "projectExpenseApprover": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "knowledgeBaseArticle": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyPresident": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyCOO": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyController": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyDispatch": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyServiceManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyDutyManagerRole": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "departmentManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "dispatchMember": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "serviceManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "dutyManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "sendFromEmailNotify": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "deleteOpenTimeSheetsFlag": { "type": "boolean", "description": "By default, this is set to false\n If there is any open timesheets, system will return error message\n that there is open timesheets still attached to this member\n If user would like to delete member with open timesheets, they can set this boolean to TRUE\n System will delete member and any associated open timesheets", "nullable": true } } }, "MemberDeactivationCompanyTeam": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "reAssignToContact": { "$ref": "#/components/schemas/ContactReference" }, "count": { "type": "integer", "format": "int32" }, "reAssignToMember": { "$ref": "#/components/schemas/MemberReference" } } }, "MemberDeactivationItem": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "reAssignToMember": { "$ref": "#/components/schemas/MemberReference" } } }, "MemberDeactivationStatusWorkflow": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "reAssignToMember": { "$ref": "#/components/schemas/MemberReference" } } }, "MemberDelegation": { "required": [ "delegationType", "delegatedTo", "dateStart", "dateEnd" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "delegationType": { "enum": [ "Approval", "Project" ], "type": "string", "nullable": true }, "delegatedTo": { "$ref": "#/components/schemas/MemberReference" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberForCalSync": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "memberId": { "type": "string" }, "office365Id": { "type": "string" }, "mapiName": { "type": "string" }, "calendarSyncIntegrationFlag": { "type": "boolean", "nullable": true } } }, "MemberInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "firstName": { "type": "string" }, "middleInitial": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "defaultEmail": { "type": "string" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberLinkSsoUser": { "type": "object", "properties": { "ssoUserId": { "type": "string", "description": " Max length: 100;" } } }, "MemberNotificationSetting": { "required": [ "notificationType", "notificationTrigger" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notificationType": { "enum": [ "Email", "Push" ], "type": "string", "nullable": true }, "notificationTrigger": { "enum": [ "ActivityStatusReq", "CustomerUpdated", "ExpenseReport", "TicketStatusChange", "TicketStatusRequest", "TimeNagApprover", "TimeNagMember", "TimeSheet", "WorkflowRules" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberOffice365": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "MemberPersona": { "required": [ "name", "personaId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "jobRolePercentage": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "description": " Max length: 20;" }, "personaId": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberSkill": { "required": [ "skill", "skillLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "skill": { "$ref": "#/components/schemas/SkillReference" }, "skillLevel": { "enum": [ "Beginner", "Intermediate", "Advanced", "Expert" ], "type": "string", "nullable": true }, "certifiedFlag": { "type": "boolean", "nullable": true }, "yearsExperience": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberSsoSettingsReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "ssoUserId": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberSsoToken": { "type": "object", "properties": { "token": { "type": "string" } } }, "MemberTemplate": { "required": [ "identifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 50;" }, "templateDescription": { "type": "string", "description": " Max length: 1024;" }, "title": { "type": "string" }, "reportCard": { "$ref": "#/components/schemas/ReportCardReference" }, "enableMobileFlag": { "type": "boolean", "nullable": true }, "type": { "$ref": "#/components/schemas/MemberTypeReference" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "partnerPortalFlag": { "type": "boolean", "nullable": true }, "stsUserAdminUrl": { "type": "string" }, "toastNotificationFlag": { "type": "boolean", "nullable": true }, "memberPersonas": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "adminFlag": { "type": "boolean", "nullable": true }, "structureLevel": { "$ref": "#/components/schemas/StructureReference" }, "securityLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "reportsTo": { "$ref": "#/components/schemas/MemberReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "billableForecast": { "type": "number", "format": "double", "nullable": true }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "hourlyCost": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "includeInUtilizationReportingFlag": { "type": "boolean", "nullable": true }, "requireExpenseEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeSheetEntryFlag": { "type": "boolean", "nullable": true }, "requireStartAndEndTimeOnTimeEntryFlag": { "type": "boolean", "nullable": true }, "allowInCellEntryOnTimeSheet": { "type": "boolean", "nullable": true }, "enterTimeAgainstCompanyFlag": { "type": "boolean", "nullable": true }, "allowExpensesEnteredAgainstCompaniesFlag": { "type": "boolean", "nullable": true }, "timeReminderEmailFlag": { "type": "boolean", "nullable": true }, "daysTolerance": { "type": "integer", "format": "int32", "nullable": true }, "minimumHours": { "type": "number", "format": "double", "nullable": true }, "timeSheetStartDate": { "type": "string" }, "serviceDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "restrictServiceDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictServiceDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "teams": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serviceBoardTeamIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "projectDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "projectDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectDefaultBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "restrictProjectDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictProjectDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedProjectBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "scheduleDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "scheduleDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "scheduleCapacity": { "type": "number", "format": "double", "nullable": true }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "restrictScheduleFlag": { "type": "boolean", "nullable": true }, "hideMemberInDispatchPortalFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "restrictDefaultSalesTerritoryFlag": { "type": "boolean", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "restrictDefaultWarehouseFlag": { "type": "boolean", "nullable": true }, "restrictDefaultWarehouseBinFlag": { "type": "boolean", "nullable": true }, "companyActivityTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceTimeTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceScreenDefaultTabFormat": { "enum": [ "ShowInvoicingTab", "ShowAgreementInvoicingTab" ], "type": "string", "nullable": true }, "invoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "agreementInvoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "autoStartStopwatch": { "type": "boolean", "nullable": true }, "autoPopupQuickNotesWithStopwatch": { "type": "boolean", "nullable": true }, "globalSearchDefaultTicketFilter": { "enum": [ "OpenRecords", "ClosedRecords", "AllRecords" ], "type": "string", "nullable": true }, "globalSearchDefaultSort": { "enum": [ "None", "LastUpdatedDesc", "LastUpdatedAsc", "CreatedDesc", "CreatedAsc" ], "type": "string", "nullable": true }, "phoneSource": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "copyPodLayouts": { "type": "boolean" }, "copySharedDefaultViews": { "type": "boolean" }, "copyColumnLayoutsAndFilters": { "type": "boolean" }, "fromMemberRecId": { "type": "integer", "format": "int32" }, "fromMemberTemplateRecId": { "type": "integer", "format": "int32" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "MemberType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MenuEntry": { "required": [ "menuLocation", "caption", "link", "newWindowFlag" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "menuLocation": { "$ref": "#/components/schemas/MenuLocationReference" }, "caption": { "type": "string", "description": " Max length: 50;" }, "link": { "type": "string", "description": " Max length: 2000;" }, "newWindowFlag": { "type": "boolean", "nullable": true }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "origin": { "type": "string", "description": " Max length: 2000;" }, "clientId": { "type": "string", "description": "Only required if not already set Max length: 36;" }, "addAllLocations": { "type": "boolean", "nullable": true }, "removeAllLocations": { "type": "boolean", "nullable": true }, "smallMenuIconId": { "type": "integer", "format": "int32", "nullable": true }, "largeMenuIconId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MenuEntryLocation": { "required": [ "location" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "menuEntry": { "$ref": "#/components/schemas/SystemMenuEntryReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MenuLocationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MinimumStockByWarehouse": { "required": [ "warehouse", "minimumStock" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "minimumStock": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MyAccount": { "required": [ "identifier", "firstName", "lastName", "licenseClass", "timeZone", "defaultEmail", "defaultPhone", "defaultLocation", "defaultDepartment", "workRole", "timeApprover", "expenseApprover", "hireDate", "salesDefaultLocation", "companyActivityTabFormat", "invoiceTimeTabFormat", "invoiceScreenDefaultTabFormat", "invoicingDisplayOptions", "agreementInvoicingDisplayOptions" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "password": { "type": "string", "description": "ConditionallyRequired. API Member will get random password generated Max length: 60;" }, "firstName": { "type": "string", "description": " Max length: 30;" }, "middleInitial": { "type": "string", "description": " Max length: 1;" }, "lastName": { "type": "string", "description": " Max length: 30;" }, "title": { "type": "string", "description": " Max length: 50;" }, "reportCard": { "$ref": "#/components/schemas/ReportCardReference" }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "disableOnlineFlag": { "type": "boolean", "nullable": true }, "enableMobileFlag": { "type": "boolean", "nullable": true }, "type": { "$ref": "#/components/schemas/MemberTypeReference" }, "employeeIdentifer": { "type": "string", "description": " Max length: 10;" }, "vendorNumber": { "type": "string" }, "notes": { "type": "string" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "serviceBoardTeamIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "enableMobileGpsFlag": { "type": "boolean", "nullable": true }, "inactiveDate": { "type": "string", "format": "date-time" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "lastLogin": { "type": "string" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "partnerPortalFlag": { "type": "boolean", "nullable": true }, "clientId": { "type": "string" }, "stsUserAdminUrl": { "type": "string" }, "token": { "type": "string" }, "toastNotificationFlag": { "type": "boolean", "nullable": true }, "memberPersonas": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "office365": { "$ref": "#/components/schemas/MemberOffice365" }, "officeEmail": { "type": "string", "description": " Max length: 250;" }, "officePhone": { "type": "string", "description": " Max length: 15;" }, "officeExtension": { "type": "string", "description": " Max length: 10;" }, "mobileEmail": { "type": "string", "description": " Max length: 250;" }, "mobilePhone": { "type": "string", "description": " Max length: 15;" }, "mobileExtension": { "type": "string", "description": " Max length: 10;" }, "homeEmail": { "type": "string", "description": " Max length: 250;" }, "homePhone": { "type": "string", "description": " Max length: 15;" }, "homeExtension": { "type": "string", "description": " Max length: 10;" }, "defaultEmail": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "primaryEmail": { "type": "string", "description": " Max length: 250;" }, "defaultPhone": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "reportsTo": { "$ref": "#/components/schemas/MemberReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "billableForecast": { "type": "number", "format": "double", "nullable": true }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "includeInUtilizationReportingFlag": { "type": "boolean", "nullable": true }, "requireExpenseEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeSheetEntryFlag": { "type": "boolean", "nullable": true }, "requireStartAndEndTimeOnTimeEntryFlag": { "type": "boolean", "nullable": true }, "allowInCellEntryOnTimeSheet": { "type": "boolean", "nullable": true }, "enterTimeAgainstCompanyFlag": { "type": "boolean", "nullable": true }, "allowExpensesEnteredAgainstCompaniesFlag": { "type": "boolean", "nullable": true }, "timeReminderEmailFlag": { "type": "boolean", "nullable": true }, "daysTolerance": { "type": "integer", "format": "int32", "nullable": true }, "minimumHours": { "type": "number", "format": "double", "nullable": true }, "timeSheetStartDate": { "type": "string", "format": "date-time" }, "hireDate": { "type": "string", "format": "date-time" }, "serviceDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "projectDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "projectDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectDefaultBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "scheduleDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "scheduleDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "scheduleCapacity": { "type": "number", "format": "double", "nullable": true }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "hideMemberInDispatchPortalFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "mapiName": { "type": "string" }, "calendarSyncIntegrationFlag": { "type": "boolean", "nullable": true }, "companyActivityTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceTimeTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceScreenDefaultTabFormat": { "enum": [ "ShowInvoicingTab", "ShowAgreementInvoicingTab" ], "type": "string", "nullable": true }, "invoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "agreementInvoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "authenticationServiceType": { "enum": [ "AuthAnvil", "GoogleAuthenticator", "Email" ], "type": "string", "nullable": true }, "timebasedOneTimePasswordActivated": { "type": "boolean", "nullable": true }, "directionalSync": { "$ref": "#/components/schemas/DirectionalSyncReference" }, "autoStartStopwatch": { "type": "boolean", "nullable": true }, "autoPopupQuickNotesWithStopwatch": { "type": "boolean", "nullable": true }, "signature": { "type": "string" }, "globalSearchDefaultTicketFilter": { "enum": [ "OpenRecords", "ClosedRecords", "AllRecords" ], "type": "string", "nullable": true }, "globalSearchDefaultSort": { "enum": [ "None", "LastUpdatedDesc", "LastUpdatedAsc", "CreatedDesc", "CreatedAsc" ], "type": "string", "nullable": true }, "phoneSource": { "type": "string" }, "phoneIntegrationType": { "enum": [ "TAPI", "SKYPE", "TEL", "CALLTO", "NONE" ], "type": "string", "nullable": true }, "useBrowserLanguageFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "copyPodLayouts": { "type": "boolean" }, "copySharedDefaultViews": { "type": "boolean" }, "copyColumnLayoutsAndFilters": { "type": "boolean" }, "fromMemberRecId": { "type": "integer", "format": "int32" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "MyMember": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "password": { "type": "string", "description": "ConditionallyRequired. API Member will get random password generated" }, "firstName": { "type": "string" }, "middleInitial": { "type": "string" }, "lastName": { "type": "string" }, "title": { "type": "string" }, "reportCard": { "$ref": "#/components/schemas/ReportCardReference" }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "disableOnlineFlag": { "type": "boolean", "nullable": true }, "enableMobileFlag": { "type": "boolean", "nullable": true }, "type": { "$ref": "#/components/schemas/MemberTypeReference" }, "employeeIdentifer": { "type": "string" }, "vendorNumber": { "type": "string" }, "notes": { "type": "string" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "serviceBoardTeamIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "enableMobileGpsFlag": { "type": "boolean", "nullable": true }, "inactiveDate": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "lastLogin": { "type": "string" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "toastNotificationFlag": { "type": "boolean", "nullable": true }, "officeEmail": { "type": "string" }, "officePhone": { "type": "string" }, "officeExtension": { "type": "string" }, "mobileEmail": { "type": "string" }, "mobilePhone": { "type": "string" }, "mobileExtension": { "type": "string" }, "homeEmail": { "type": "string" }, "homePhone": { "type": "string" }, "homeExtension": { "type": "string" }, "defaultEmail": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "defaultPhone": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "securityRole": { "$ref": "#/components/schemas/SecurityRoleReference" }, "adminFlag": { "type": "boolean", "nullable": true }, "structureLevel": { "$ref": "#/components/schemas/StructureReference" }, "securityLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "reportsTo": { "$ref": "#/components/schemas/MemberReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "billableForecast": { "type": "number", "format": "double", "nullable": true }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "hourlyCost": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "includeInUtilizationReportingFlag": { "type": "boolean", "nullable": true }, "requireExpenseEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeSheetEntryFlag": { "type": "boolean", "nullable": true }, "requireStartAndEndTimeOnTimeEntryFlag": { "type": "boolean", "nullable": true }, "allowInCellEntryOnTimeSheet": { "type": "boolean", "nullable": true }, "enterTimeAgainstCompanyFlag": { "type": "boolean", "nullable": true }, "allowExpensesEnteredAgainstCompaniesFlag": { "type": "boolean", "nullable": true }, "timeReminderEmailFlag": { "type": "boolean", "nullable": true }, "daysTolerance": { "type": "integer", "format": "int32", "nullable": true }, "minimumHours": { "type": "number", "format": "double", "nullable": true }, "timeSheetStartDate": { "type": "string" }, "hireDate": { "type": "string" }, "serviceDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "restrictServiceDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictServiceDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "projectDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "projectDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectDefaultBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "restrictProjectDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictProjectDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedProjectBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "scheduleDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "scheduleDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "scheduleCapacity": { "type": "number", "format": "double", "nullable": true }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "restrictScheduleFlag": { "type": "boolean", "nullable": true }, "hideMemberInDispatchPortalFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "restrictDefaultSalesTerritoryFlag": { "type": "boolean", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "restrictDefaultWarehouseFlag": { "type": "boolean", "nullable": true }, "restrictDefaultWarehouseBinFlag": { "type": "boolean", "nullable": true }, "mapiName": { "type": "string" }, "calendarSyncIntegrationFlag": { "type": "boolean", "nullable": true }, "enableLdapAuthenticationFlag": { "type": "boolean", "nullable": true }, "ldapConfiguration": { "$ref": "#/components/schemas/LdapConfigurationReference" }, "ldapUserName": { "type": "string" }, "companyActivityTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceTimeTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceScreenDefaultTabFormat": { "enum": [ "ShowInvoicingTab", "ShowAgreementInvoicingTab" ], "type": "string", "nullable": true }, "invoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "agreementInvoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "corelyticsUsername": { "type": "string" }, "corelyticsPassword": { "type": "string" }, "authenticationServiceType": { "enum": [ "AuthAnvil", "GoogleAuthenticator", "Email" ], "type": "string", "nullable": true }, "timebasedOneTimePasswordActivated": { "type": "boolean", "nullable": true }, "directionalSync": { "$ref": "#/components/schemas/DirectionalSyncReference" }, "ssoSessionFlag": { "type": "boolean", "nullable": true }, "ssoClientId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MyMemberInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "firstName": { "type": "string" }, "middleInitial": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "defaultEmail": { "type": "string" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "useBrowserLanguageFlag": { "type": "boolean", "nullable": true }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "requireExpenseEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeSheetEntryFlag": { "type": "boolean", "nullable": true }, "requireStartAndEndTimeOnTimeEntryFlag": { "type": "boolean", "nullable": true }, "enterTimeAgainstCompanyFlag": { "type": "boolean", "nullable": true }, "allowExpensesEnteredAgainstCompaniesFlag": { "type": "boolean", "nullable": true }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "serviceDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "restrictServiceDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictServiceDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "projectDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "projectDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectDefaultBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "restrictProjectDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictProjectDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedProjectBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "scheduleDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "scheduleDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "scheduleCapacity": { "type": "number", "format": "double", "nullable": true }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "restrictDefaultWarehouseFlag": { "type": "boolean", "nullable": true }, "restrictDefaultWarehouseBinFlag": { "type": "boolean", "nullable": true }, "ssoSessionFlag": { "type": "boolean", "nullable": true }, "ssoClientId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MySecurity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "addLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "editLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "deleteLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "inquireLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "moduleFunctionName": { "type": "string" }, "moduleFunctionDescription": { "type": "string" }, "myAllFlag": { "type": "boolean", "nullable": true }, "moduleFunctionIdentifier": { "type": "string" }, "reportFlag": { "type": "boolean", "nullable": true }, "restrictFlag": { "type": "boolean", "nullable": true }, "customFlag": { "type": "boolean", "nullable": true }, "moduleDescription": { "type": "string" }, "moduleIdentifier": { "type": "string" }, "moduleName": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MySecurityCustomizeItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customizeIdentifier": { "enum": [ "CompanyReports", "FinanceReports", "MarketingReports", "ProcurementReports", "ProjectReports", "SalesReports", "ServiceReports", "SystemReports", "TimeAndExpenseReports", "CompanyConfigurations", "FinanceAgreements", "ProjectScheduling", "ServiceResourceScheduling", "SystemManageHostedApi", "SystemMyAccount", "SystemCustomMenuEntry", "SystemMassMaintenance", "SystemTableSetup" ], "type": "string", "nullable": true }, "itemIdentifier": { "type": "string" } } }, "NoteTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "NotificationRecipient": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "externalFlag": { "type": "boolean", "nullable": true }, "serviceFlag": { "type": "boolean", "nullable": true }, "salesFlag": { "type": "boolean", "nullable": true }, "invoiceFlag": { "type": "boolean", "nullable": true }, "agreementFlag": { "type": "boolean", "nullable": true }, "memberFlag": { "type": "boolean", "nullable": true }, "configFlag": { "type": "boolean", "nullable": true }, "mspFlag": { "type": "boolean", "nullable": true }, "trackFlag": { "type": "boolean", "nullable": true }, "projectFlag": { "type": "boolean", "nullable": true }, "procurementFlag": { "type": "boolean", "nullable": true }, "knowledgeBaseFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "NotificationRecipientReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "NotifyTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Office365EmailApplicationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Office365EmailSetup": { "required": [ "name", "inboxFolder", "processedFolder", "failedFolder" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 200;" }, "username": { "type": "string", "description": " Max length: 100;" }, "inboxFolder": { "type": "string", "description": " Max length: 40;" }, "processedFolder": { "type": "string", "description": " Max length: 40;" }, "failedFolder": { "type": "string", "description": " Max length: 40;" }, "tenantId": { "type": "string", "description": " Max length: 36;" }, "clientId": { "type": "string", "description": " Max length: 36;" }, "clientSecret": { "type": "string", "description": " Max length: 4000;" }, "authorizedFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "source": { "type": "integer", "format": "int32" }, "useExistingTenantFlag": { "type": "boolean", "nullable": true }, "existingTenant": { "$ref": "#/components/schemas/ExistingTenantReference" }, "emailConnector": { "$ref": "#/components/schemas/EmailConnectorReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Office365EmailSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OnHandSerialNumber": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serial": { "type": "string" }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OnHandSerialNumberReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "serialNumber": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OnPremiseSearchSetting": { "required": [ "password" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "password": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpenRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Opportunity": { "required": [ "name", "primarySalesRep", "company", "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "expectedCloseDate": { "type": "string", "description": " Required On Updates;", "format": "date-time" }, "type": { "$ref": "#/components/schemas/OpportunityTypeReference" }, "stage": { "$ref": "#/components/schemas/OpportunityStageReference" }, "status": { "$ref": "#/components/schemas/OpportunityStatusReference" }, "priority": { "$ref": "#/components/schemas/OpportunityPriorityReference" }, "notes": { "type": "string" }, "probability": { "$ref": "#/components/schemas/OpportunityProbabilityReference" }, "source": { "type": "string", "description": " Max length: 50;" }, "rating": { "$ref": "#/components/schemas/OpportunityRatingReference" }, "campaign": { "$ref": "#/components/schemas/CampaignReference" }, "primarySalesRep": { "$ref": "#/components/schemas/MemberReference" }, "secondarySalesRep": { "$ref": "#/components/schemas/MemberReference" }, "locationId": { "type": "integer", "description": " Required On Updates;", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "description": " Required On Updates;", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "customerPO": { "type": "string", "description": " Max length: 25;" }, "pipelineChangeDate": { "type": "string", "format": "date-time" }, "dateBecameLead": { "type": "string", "format": "date-time" }, "closedDate": { "type": "string", "format": "date-time" }, "closedBy": { "$ref": "#/components/schemas/MemberReference" }, "totalSalesTax": { "type": "number", "format": "double", "nullable": true }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "companyLocationId": { "type": "integer", "format": "int32", "nullable": true }, "technicalContact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "OpportunityContact": { "required": [ "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "role": { "$ref": "#/components/schemas/OpportunitySalesRoleReference" }, "notes": { "type": "string" }, "referralFlag": { "type": "boolean", "nullable": true }, "opportunityId": { "type": "integer", "format": "int32", "nullable": true }, "phoneNumber": { "type": "string" }, "emailAddress": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "opportunityId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "text": { "type": "string" }, "flagged": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityPriorityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityProbabilityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityRating": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityRatingInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityRatingReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunitySalesRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityStage": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "probability": { "$ref": "#/components/schemas/OpportunityProbabilityReference" }, "color": { "type": "string", "description": " Max length: 25;" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityStageInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "probability": { "$ref": "#/components/schemas/OpportunityProbabilityReference" }, "color": { "type": "string" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityStageReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "wonFlag": { "type": "boolean", "nullable": true }, "lostFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "dateEntered": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "closedFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityToAgreementConversion": { "type": "object", "properties": { "agreementId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "noEndingDateFlag": { "type": "boolean", "nullable": true }, "billCycleId": { "type": "integer", "format": "int32", "nullable": true }, "billOneTimeFlag": { "type": "boolean", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "includeAllNotesFlag": { "type": "boolean", "nullable": true }, "includeAllDocumentsFlag": { "type": "boolean", "nullable": true }, "includeAllProductsFlag": { "type": "boolean", "nullable": true }, "includeNoteIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeDocumentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeProductIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "OpportunityToProjectConversion": { "type": "object", "properties": { "projectId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/ProjectStatusReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "board": { "$ref": "#/components/schemas/ProjectBoardReference" }, "manager": { "$ref": "#/components/schemas/MemberReference" }, "estimatedStart": { "type": "string" }, "estimatedEnd": { "type": "string" }, "includeAllNotesFlag": { "type": "boolean", "nullable": true }, "includeAllDocumentsFlag": { "type": "boolean", "nullable": true }, "includeAllProductsFlag": { "type": "boolean", "nullable": true }, "includeNoteIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeDocumentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeProductIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "OpportunityToSalesOrderConversion": { "type": "object", "properties": { "salesOrderId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "includeAllNotesFlag": { "type": "boolean", "nullable": true }, "includeAllDocumentsFlag": { "type": "boolean", "nullable": true }, "includeAllProductsFlag": { "type": "boolean", "nullable": true }, "includeNoteIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeDocumentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeProductIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "OpportunityToServiceTicketConversion": { "type": "object", "properties": { "ticketId": { "type": "integer", "format": "int32" }, "summary": { "type": "string" }, "includeAllNotesFlag": { "type": "boolean", "nullable": true }, "includeAllDocumentsFlag": { "type": "boolean", "nullable": true }, "includeAllProductsFlag": { "type": "boolean", "nullable": true }, "includeNoteIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeDocumentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "includeProductIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "OpportunityType": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Order": { "required": [ "company", "status", "salesRep" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "phone": { "type": "string" }, "phoneExt": { "type": "string" }, "email": { "type": "string" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "status": { "$ref": "#/components/schemas/OrderStatusReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "orderDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "poNumber": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "salesRep": { "$ref": "#/components/schemas/MemberReference" }, "notes": { "type": "string" }, "billClosedFlag": { "type": "boolean", "nullable": true }, "billShippedFlag": { "type": "boolean", "nullable": true }, "restrictDownpaymentFlag": { "type": "boolean", "nullable": true }, "description": { "type": "string" }, "topCommentFlag": { "type": "boolean", "nullable": true }, "bottomCommentFlag": { "type": "boolean", "nullable": true }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "productIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "documentIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "invoiceIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "configIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "total": { "type": "number", "format": "double", "nullable": true }, "taxTotal": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "subTotal": { "type": "number", "format": "double" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "OrderStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/OrderStatusEmailTemplateReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OrderStatusEmailTemplate": { "required": [ "subject", "body" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/OrderStatusReference" }, "useSenderFlag": { "type": "boolean", "nullable": true }, "firstName": { "type": "string", "description": " Max length: 100;" }, "lastName": { "type": "string", "description": " Max length: 100;" }, "emailAddress": { "type": "string", "description": " Max length: 100;" }, "subject": { "type": "string", "description": " Max length: 200;" }, "body": { "type": "string" }, "copySenderFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OrderStatusEmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OrderStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OrderStatusNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "status": { "$ref": "#/components/schemas/OrderStatusReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": "Order Status Notification sendEmail must be entered if the notify type is \"Email Address\". Max length: 50;" }, "workflowStep": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OrderStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OsGradeWeight": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "osGradeWeight": { "type": "number", "format": "double" }, "osName": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Other": { "required": [ "defaultFromAddress", "portalUrlOverride", "siteUrl", "serverTimeZone", "defaultCalendar", "defaultAddressFormat", "locale" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "defaultLdap": { "$ref": "#/components/schemas/LdapConfigurationReference" }, "defaultFromAddress": { "type": "string", "description": " Max length: 50;" }, "portalUrlOverride": { "type": "string", "description": " Max length: 100;" }, "siteUrl": { "type": "string", "description": " Max length: 100;" }, "logoPath": { "type": "string", "description": " Max length: 200;" }, "contactSync": { "enum": [ "FL", "LF", "CFL", "CLF" ], "type": "string", "nullable": true }, "serverTimeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "defaultCalendar": { "$ref": "#/components/schemas/CalendarReference" }, "defaultAddressFormat": { "$ref": "#/components/schemas/AddressFormatReference" }, "useSslFlag": { "type": "boolean", "nullable": true }, "syncLeadsFlag": { "type": "boolean", "nullable": true }, "includePortalLinkFlag": { "type": "boolean", "nullable": true }, "useExpandedFormatTimeFlag": { "type": "boolean", "nullable": true }, "useExpandedFormatActivityFlag": { "type": "boolean", "nullable": true }, "disableZAdminLoginFlag": { "type": "boolean", "nullable": true }, "locale": { "$ref": "#/components/schemas/LocaleReference" }, "updateMemberTimeZonesFlag": { "type": "boolean", "description": "If true, all Members time zone will also be set to serverTimeZone. Otherwise, only My Company time zone will be updated.", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Other1RevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Other2RevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OwnerLevelReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OwnershipType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 200;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OwnershipTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OwnershipTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PageValues": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32", "nullable": true }, "pageSize": { "type": "integer", "format": "int32", "nullable": true }, "pageId": { "type": "integer", "format": "int32", "nullable": true } } }, "ParsingType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "parseRule": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ParsingVariable": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PatchOperation": { "type": "object", "properties": { "op": { "type": "string" }, "path": { "type": "string" }, "value": { "type": "object" } } }, "PaymentMethodReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PaymentType": { "required": [ "name", "classification" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "classification": { "$ref": "#/components/schemas/ClassificationReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "companyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PaymentTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PersonasInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "PhaseStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "collapsedFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "boardAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "statusIndicator": { "$ref": "#/components/schemas/StatusIndicatorReference" }, "customStatusIndicatorName": { "type": "string", "description": "Required when statusIndicator is Custom. Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PhaseStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "collapsedFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "boardAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PhaseStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalCalendar": { "required": [ "weekStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "weekStart": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "nullable": true }, "adjust1Start": { "type": "string" }, "adjust1End": { "type": "string" }, "adjust1Hours": { "type": "number", "format": "double", "nullable": true }, "adjust2Start": { "type": "string" }, "adjust2End": { "type": "string" }, "adjust2Hours": { "type": "number", "format": "double", "nullable": true }, "adjust3Start": { "type": "string" }, "adjust3End": { "type": "string" }, "adjust3Hours": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfiguration": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or sets and Sets\n An existing Portal Configuration id is required when copying a Portal Configuration.", "format": "int32" }, "name": { "type": "string", "description": " Max length: 150;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "loginBackgroundColor": { "type": "string", "description": " Max length: 7;" }, "portalBackgroundColor": { "type": "string", "description": " Max length: 7;" }, "menuColor": { "type": "string", "description": " Max length: 7;" }, "buttonColor": { "type": "string", "description": " Max length: 7;" }, "headerColor": { "type": "string", "description": " Max length: 7;" }, "url": { "type": "string", "description": " Max length: 1000;" }, "language": { "enum": [ "English", "Spanish", "French", "British", "Australian", "BrazilianPortuguese", "CanadianFrench", "German", "NewZealand", "Dutch" ], "type": "string", "nullable": true }, "welcomeText": { "type": "string", "description": " Max length: 4000;" }, "boardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "agreementTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "configTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "portalImageCopySuccessFlag": { "type": "boolean", "nullable": true }, "displayVendorFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationInvoiceSetup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "portalConfiguration": { "$ref": "#/components/schemas/PortalConfigurationReference" }, "displayInvPmtFlag": { "type": "boolean", "nullable": true }, "allowInvPmtFlag": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "paymentProcessor": { "$ref": "#/components/schemas/PortalConfigurationPaymentProcessorReference" }, "login": { "type": "string" }, "password": { "type": "string" }, "urlOverride": { "type": "string" }, "billingStatusIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllStatuses": { "type": "boolean", "nullable": true }, "removeAllStatuses": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationOpportunitySetup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "opportunityStatusRecIDs": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllOpportunityStatuses": { "type": "boolean", "nullable": true }, "removeAllOpportunityStatuses": { "type": "boolean", "nullable": true }, "opportunityTypeRecIDs": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllOpportunityTypes": { "type": "boolean", "nullable": true }, "removeAllOpportunityTypes": { "type": "boolean", "nullable": true }, "restrictViewByOpportunityStatusFlag": { "type": "boolean", "nullable": true }, "restrictViewByOpportunityTypeFlag": { "type": "boolean", "nullable": true }, "acceptanceChangeStatusFlag": { "type": "boolean", "nullable": true }, "acceptanceCreateActivityFlag": { "type": "boolean", "nullable": true }, "acceptanceOpportunityStatus": { "$ref": "#/components/schemas/OpportunityStatusReference" }, "acceptanceSendEmailFlag": { "type": "boolean", "nullable": true }, "acceptanceEmailFromFirstName": { "type": "string" }, "acceptanceEmailFromLastName": { "type": "string" }, "acceptanceEmailSubject": { "type": "string" }, "acceptanceEmailBody": { "type": "string" }, "acceptanceFromEmail": { "type": "string", "description": "Gets or sets\n required when acceptanceSendEmailFlag is true." }, "acceptanceEmailActivityType": { "$ref": "#/components/schemas/ActivityTypeReference" }, "acceptanceEmailAssignedByMember": { "$ref": "#/components/schemas/MemberReference" }, "rejectionChangeStatusFlag": { "type": "boolean", "nullable": true }, "rejectionCreateActivityFlag": { "type": "boolean", "nullable": true }, "rejectionOpportunityStatus": { "$ref": "#/components/schemas/OpportunityStatusReference" }, "rejectionSendEmailFlag": { "type": "boolean", "nullable": true }, "rejectionEmailFromFirstName": { "type": "string" }, "rejectionEmailFromLastName": { "type": "string" }, "rejectionFromEmail": { "type": "string", "description": "Gets or sets\n required when rejectionSendEmailFlag is true." }, "rejectionEmailSubject": { "type": "string" }, "rejectionEmailBody": { "type": "string" }, "rejectionEmailActivityType": { "$ref": "#/components/schemas/ActivityTypeReference" }, "rejectionEmailAssignedByMember": { "$ref": "#/components/schemas/MemberReference" }, "confirmationSendEmailFlag": { "type": "boolean", "nullable": true }, "confirmationEmailUseDefaultCompanyEmailAddressFlag": { "type": "boolean", "nullable": true }, "confirmationEmailFromFirstName": { "type": "string" }, "confirmationEmailFromLastName": { "type": "string" }, "confirmationFromEmail": { "type": "string", "description": "Gets or sets\n required when confirmationSendEmailFlag is true." }, "confirmationEmailSubject": { "type": "string" }, "confirmationEmailBody": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationPasswordEmailSetup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "validPasswordEmailUseCustomEmailFlag": { "type": "boolean", "nullable": true }, "validPasswordEmailFromFirstName": { "type": "string" }, "validPasswordEmailFromLastName": { "type": "string" }, "validPasswordEmailFromEmail": { "type": "string", "description": "Gets or sets\n required when validPasswordEmailUseCustomEmailFlag is true." }, "validPasswordEmailSubject": { "type": "string" }, "validPasswordEmailBody": { "type": "string" }, "invalidPasswordEmailUseCustomEmailFlag": { "type": "boolean", "nullable": true }, "invalidPasswordEmailFromFirstName": { "type": "string" }, "invalidPasswordEmailFromLastName": { "type": "string" }, "invalidPasswordEmailFromEmail": { "type": "string", "description": "Gets or sets\n required when invalidPasswordEmailUseCustomEmailFlag is true." }, "invalidPasswordEmailSubject": { "type": "string" }, "invalidPasswordEmailBody": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationPaymentProcessor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "testURL": { "type": "string" } } }, "PortalConfigurationPaymentProcessorReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationProjectSetup": { "required": [ "onlyDisplay" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "portalConfig": { "$ref": "#/components/schemas/PortalConfigurationReference" }, "projectNameFlag": { "type": "boolean", "nullable": true }, "projectTypeFlag": { "type": "boolean", "nullable": true }, "statusFlag": { "type": "boolean", "nullable": true }, "projectManagerFlag": { "type": "boolean", "nullable": true }, "billingMethodFlag": { "type": "boolean", "nullable": true }, "contactFlag": { "type": "boolean", "nullable": true }, "estimatedStartFlag": { "type": "boolean", "nullable": true }, "estimatedEndFlag": { "type": "boolean", "nullable": true }, "descriptionFlag": { "type": "boolean", "nullable": true }, "lastUpdatedFlag": { "type": "boolean", "nullable": true }, "onlyDisplay": { "enum": [ "DoNotDisplay", "Closed30Days", "Closed60Days", "Closed90Days", "Closed120Days", "AllClosed" ], "type": "string", "nullable": true }, "timeMaterialBudgetHrsFlag": { "type": "boolean", "nullable": true }, "timeMaterialScheduledStartFlag": { "type": "boolean", "nullable": true }, "timeMaterialScheduledFinishFlag": { "type": "boolean", "nullable": true }, "timeMaterialScheduledHrsFlag": { "type": "boolean", "nullable": true }, "timeMaterialActualStartFlag": { "type": "boolean", "nullable": true }, "timeMaterialActualFinishFlag": { "type": "boolean", "nullable": true }, "timeMaterialActualHrsFlag": { "type": "boolean", "nullable": true }, "timeMaterialBillFlag": { "type": "boolean", "nullable": true }, "timeMaterialStatusFlag": { "type": "boolean", "nullable": true }, "timeMaterialAssignedFlag": { "type": "boolean", "nullable": true }, "fixedFeeBudgetHrsFlag": { "type": "boolean", "nullable": true }, "fixedFeeScheduledStartFlag": { "type": "boolean", "nullable": true }, "fixedFeeScheduledFinishFlag": { "type": "boolean", "nullable": true }, "fixedFeeScheduledHrsFlag": { "type": "boolean", "nullable": true }, "fixedFeeActualStartFlag": { "type": "boolean", "nullable": true }, "fixedFeeActualFinishFlag": { "type": "boolean", "nullable": true }, "fixedFeeActualHrsFlag": { "type": "boolean", "nullable": true }, "fixedFeeBillFlag": { "type": "boolean", "nullable": true }, "fixedFeeStatusFlag": { "type": "boolean", "nullable": true }, "fixedFeeAssignedFlag": { "type": "boolean", "nullable": true }, "projectIssueBudgetHrsFlag": { "type": "boolean", "nullable": true }, "projectIssueScheduledStartFlag": { "type": "boolean", "nullable": true }, "projectIssueScheduledFinishFlag": { "type": "boolean", "nullable": true }, "projectIssueScheduledHrsFlag": { "type": "boolean", "nullable": true }, "projectIssueActualStartFlag": { "type": "boolean", "nullable": true }, "projectIssueActualFinishFlag": { "type": "boolean", "nullable": true }, "projectIssueActualHrsFlag": { "type": "boolean", "nullable": true }, "projectIssueBillFlag": { "type": "boolean", "nullable": true }, "projectIssueStatusFlag": { "type": "boolean", "nullable": true }, "projectIssueAssignedFlag": { "type": "boolean", "nullable": true }, "projectDetailTotalHoursFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalConfigurationServiceSetup": { "required": [ "displayClosedTicketsOption", "timeMaterialsTicketTemplate", "fixedFeeTicketTemplate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serviceTypeFlag": { "type": "boolean", "nullable": true }, "serviceSubTypeFlag": { "type": "boolean", "nullable": true }, "serviceSubTypeItemFlag": { "type": "boolean", "nullable": true }, "statusFlag": { "type": "boolean", "nullable": true }, "siteNameFlag": { "type": "boolean", "nullable": true }, "enteredDateFlag": { "type": "boolean", "nullable": true }, "lastUpdateFlag": { "type": "boolean", "nullable": true }, "requiredDateFlag": { "type": "boolean", "nullable": true }, "contactFlag": { "type": "boolean", "nullable": true }, "assignedResourcesFlag": { "type": "boolean", "nullable": true }, "slaInfoFlag": { "type": "boolean", "nullable": true }, "serviceBoardFlag": { "type": "boolean", "nullable": true }, "budgetHoursFlag": { "type": "boolean", "nullable": true }, "actualHoursFlag": { "type": "boolean", "nullable": true }, "approvalStatusFlag": { "type": "boolean", "nullable": true }, "openTasksFlag": { "type": "boolean", "nullable": true }, "closedTasksFlag": { "type": "boolean", "nullable": true }, "enableChatAssistFlag": { "type": "boolean", "nullable": true }, "displayClosedTicketsOption": { "enum": [ "DoNotDisplay", "Closed30Days", "Closed60Days", "Closed90Days", "Closed120Days", "AllClosed" ], "type": "string", "nullable": true }, "timeMaterialsTicketTemplate": { "$ref": "#/components/schemas/ServiceSignoffReference" }, "fixedFeeTicketTemplate": { "$ref": "#/components/schemas/ServiceSignoffReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalReport": { "required": [ "name", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "portalConfiguration": { "$ref": "#/components/schemas/PortalConfigurationReference" }, "name": { "type": "string", "description": " Max length: 255;" }, "url": { "type": "string", "description": " Max length: 255;" }, "openSameWindowFlag": { "type": "boolean", "nullable": true }, "customFlag": { "type": "boolean", "nullable": true }, "displayFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalSecurity": { "type": "object", "properties": { "identifier": { "type": "string" }, "enabled": { "type": "boolean", "nullable": true } } }, "PortalSecurityLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "captionIdentifier": { "type": "string" }, "isDefaultFlag": { "type": "boolean", "nullable": true }, "caption": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalSecuritySetting": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "functionIdentifier": { "type": "string" }, "functionDescription": { "type": "string" }, "levelOne": { "type": "boolean", "nullable": true }, "levelTwo": { "type": "boolean", "nullable": true }, "levelThree": { "type": "boolean", "nullable": true }, "levelFour": { "type": "boolean", "nullable": true }, "levelFive": { "type": "boolean", "nullable": true }, "levelSix": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PricingBreak": { "required": [ "quantityStart", "priceMethod" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "detailId": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "quantityStart": { "type": "number", "format": "double", "nullable": true }, "quantityEnd": { "type": "number", "format": "double", "nullable": true }, "unlimited": { "type": "boolean" }, "priceMethod": { "enum": [ "FlatRateForRange", "PercentMarkupFromCost", "PercentMarkdownFromPrice", "PricePerUnit" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PricingDetail": { "required": [ "startDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/components/schemas/CatalogItemReference" }, "category": { "$ref": "#/components/schemas/ProductCategoryReference" }, "subCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "noEndDate": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PricingSchedule": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "companies": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "setAllCompaniesFlag": { "type": "boolean", "nullable": true }, "removeAllCompaniesFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PricingScheduleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Priority": { "required": [ "name", "color" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "color": { "enum": [ "Black", "Blue", "Cyan", "Gray", "Green", "Lime", "Orange", "Pink", "Purple", "Red", "White", "Yellow", "Custom" ], "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "imageLink": { "type": "string" }, "urgencySortOrder": { "type": "string" }, "level": { "enum": [ "Critical", "High", "Medium", "Low" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PriorityInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "enum": [ "Black", "Blue", "Cyan", "Gray", "Green", "Lime", "Orange", "Pink", "Purple", "Red", "White", "Yellow", "Custom" ], "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "imageLink": { "type": "string" }, "urgencySortOrder": { "type": "string" }, "level": { "enum": [ "Critical", "High", "Medium", "Low" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PriorityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "sort": { "type": "integer", "format": "int32", "nullable": true }, "level": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProcurementAdjustment": { "required": [ "identifier", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 50;" }, "type": { "$ref": "#/components/schemas/AdjustmentTypeReference" }, "reason": { "type": "string", "description": " Max length: 100;" }, "notes": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "closedBy": { "type": "string" }, "closedDate": { "type": "string", "format": "date-time" }, "adjustmentDetails": { "type": "array", "items": { "$ref": "#/components/schemas/AdjustmentDetail" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProcurementSetting": { "required": [ "startingPurchaseOrderNum", "costingMethod" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "startingPurchaseOrderNum": { "type": "integer", "format": "int32" }, "purchaseOrderPrefix": { "type": "string", "description": " Max length: 5;" }, "purchaseOrderSuffix": { "type": "string", "description": " Max length: 5;" }, "prefixSuffixType": { "enum": [ "Prefix", "Suffix" ], "type": "string", "nullable": true }, "disableCostUpdatesFlag": { "type": "boolean", "nullable": true }, "disableNegativeInventoryFlag": { "type": "boolean", "nullable": true }, "costingMethod": { "enum": [ "FIFO", "LIFO", "AverageCosting" ], "type": "string", "nullable": true }, "autoClosePurchaseOrderFlag": { "type": "boolean", "nullable": true }, "autoClosePurchaseOrderItemFlag": { "type": "boolean", "nullable": true }, "autoApprovePurchaseOrderFlag": { "type": "boolean", "nullable": true }, "taxPurchaseOrderFlag": { "type": "boolean", "nullable": true }, "taxFreightFlag": { "type": "boolean", "nullable": true }, "useVendorTaxCodeFlag": { "type": "boolean", "nullable": true }, "numDecimalPlaces": { "type": "integer", "format": "int32", "nullable": true }, "disableAutoPickFlag": { "type": "boolean", "nullable": true }, "defaultProductTaxableFlag": { "type": "boolean", "nullable": true }, "eoriNumber": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "notificationForChangesInShippingInfoFlag": { "type": "boolean", "nullable": true }, "shippingInfoNotificationEmail": { "type": "string", "description": " Max length: 250;" } } }, "ProductCategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductComponent": { "required": [ "quantity", "catalogItem" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sequenceNumber": { "type": "integer", "description": " Required On Updates;", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "hidePriceFlag": { "type": "boolean", "nullable": true }, "hideItemIdentifierFlag": { "type": "boolean", "nullable": true }, "hideDescriptionFlag": { "type": "boolean", "nullable": true }, "hideQuantityFlag": { "type": "boolean", "nullable": true }, "hideExtendedPriceFlag": { "type": "boolean", "nullable": true }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "parentProductItem": { "$ref": "#/components/schemas/ProductItemReference" }, "productItem": { "$ref": "#/components/schemas/ProductItemReference" }, "price": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductDemand": { "type": "object", "properties": { "productRecId": { "type": "integer", "format": "int32" }, "quantity": { "type": "integer", "format": "int32" }, "cost": { "type": "number", "format": "double", "nullable": true } } }, "ProductDetach": { "type": "object", "properties": { "removeFromTicket": { "type": "boolean" }, "removeFromInvoice": { "type": "boolean" }, "removeFromOpportunity": { "type": "boolean" }, "removeFromSalesOrder": { "type": "boolean" }, "removeFromProject": { "type": "boolean" } } }, "ProductItem": { "required": [ "catalogItem", "billableOption" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "catalogItem": { "$ref": "#/components/schemas/CatalogItemReference" }, "description": { "type": "string", "description": " Max length: 2000;" }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "quantity": { "type": "number", "format": "double", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "price": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "extPrice": { "type": "number", "format": "double", "nullable": true }, "extCost": { "type": "number", "format": "double", "nullable": true }, "discount": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "agreementAmount": { "type": "number", "format": "double", "nullable": true }, "priceMethod": { "enum": [ "FlatRateForRange", "PercentMarkupFromCost", "PercentMarkdownFromPrice", "PricePerUnit" ], "type": "string", "nullable": true }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge" ], "type": "string", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "locationId": { "type": "integer", "description": " Required On Updates;", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "businessUnitId": { "type": "integer", "description": " Required On Updates;", "format": "int32", "nullable": true }, "businessUnit": { "$ref": "#/components/schemas/BillingUnitReference" }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "vendorSku": { "type": "string", "description": " Max length: 50;" }, "taxableFlag": { "type": "boolean", "nullable": true }, "dropshipFlag": { "type": "boolean", "nullable": true }, "specialOrderFlag": { "type": "boolean", "nullable": true }, "phaseProductFlag": { "type": "boolean", "nullable": true }, "cancelledFlag": { "type": "boolean", "nullable": true }, "quantityCancelled": { "type": "number", "format": "double", "nullable": true }, "cancelledReason": { "type": "string", "description": " Max length: 100;" }, "customerDescription": { "type": "string", "description": " Max length: 6000; Required On Updates;" }, "internalNotes": { "type": "string", "description": " Max length: 1000;" }, "productSuppliedFlag": { "type": "boolean", "nullable": true }, "subContractorShipToId": { "type": "integer", "format": "int32", "nullable": true }, "subContractorAmountLimit": { "type": "number", "format": "double", "nullable": true }, "recurring": { "$ref": "#/components/schemas/ProductRecurring" }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "entityType": { "$ref": "#/components/schemas/EntityTypeReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrderReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "warehouseId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseIdObject": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBinId": { "type": "integer", "format": "int32", "nullable": true }, "warehouseBinIdObject": { "$ref": "#/components/schemas/WarehouseBinReference" }, "calculatedPriceFlag": { "type": "boolean", "nullable": true }, "calculatedCostFlag": { "type": "boolean", "nullable": true }, "forecastDetailId": { "type": "integer", "format": "int32", "nullable": true }, "cancelledBy": { "type": "integer", "format": "int32", "nullable": true }, "cancelledDate": { "type": "string", "format": "date-time" }, "warehouse": { "type": "string" }, "warehouseBin": { "type": "string" }, "purchaseDate": { "type": "string", "format": "date-time" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "integrationXRef": { "type": "string" }, "listPrice": { "type": "number", "format": "double", "nullable": true }, "serialNumberIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serialNumbers": { "type": "array", "items": { "type": "string" } }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "forecastStatus": { "$ref": "#/components/schemas/OpportunityStatusReference" }, "productClass": { "enum": [ "Agreement", "Bundle", "Inventory", "NonInventory", "Service" ], "type": "string", "nullable": true }, "needToPurchaseFlag": { "type": "boolean", "nullable": true }, "needToOrderQuantity": { "type": "integer", "format": "int32", "nullable": true }, "minimumStockFlag": { "type": "boolean", "nullable": true }, "shipSet": { "type": "string", "description": " Max length: 10;" }, "calculatedPrice": { "type": "number", "format": "double", "nullable": true }, "calculatedCost": { "type": "number", "format": "double", "nullable": true }, "invoiceGrouping": { "$ref": "#/components/schemas/InvoiceGroupingReference" }, "poApprovedFlag": { "type": "boolean", "nullable": true }, "uom": { "type": "string" }, "addComponentsFlag": { "type": "boolean", "nullable": true }, "ignorePricingSchedulesFlag": { "type": "boolean", "nullable": true }, "asioSubscriptionsID": { "type": "string", "format": "uuid", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "bypassForecastUpdate": { "type": "boolean", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProductItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductPickingShippingDetail": { "required": [ "warehouse", "warehouseBin" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "pickedQuantity": { "type": "integer", "format": "int32", "nullable": true }, "shippedQuantity": { "type": "integer", "format": "int32", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "shipmentMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "serialNumber": { "type": "string" }, "serialNumberIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "trackingNumber": { "type": "string" }, "productItem": { "$ref": "#/components/schemas/ProductItemReference" }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "expectedArrivalDate": { "type": "string", "format": "date-time" }, "shipmentDate": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductRecurring": { "type": "object", "properties": { "recurringRevenue": { "type": "number", "format": "double", "nullable": true }, "recurringCost": { "type": "number", "format": "double", "nullable": true }, "startDate": { "type": "string" }, "endDate": { "type": "string", "description": "The Recurring End Date is calculated based on the\n start date, number of cycles, and cycle type." }, "billCycleId": { "type": "integer", "format": "int32", "nullable": true }, "billCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "cycles": { "type": "integer", "format": "int32", "nullable": true }, "cycleType": { "enum": [ "ContractYear", "CalendarYear" ], "type": "string", "nullable": true }, "agreementType": { "$ref": "#/components/schemas/AgreementTypeReference" } } }, "ProductReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductSubCategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "typeXref": { "enum": [ "InventoryPart", "NonInventoryPart", "OtherCharge", "Service" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductTypeExemption": { "required": [ "productType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "productType": { "$ref": "#/components/schemas/ProductTypeReference" }, "taxableLevels": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Project": { "required": [ "billingMethod", "board", "company", "estimatedEnd", "estimatedStart", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "actualEnd": { "type": "string", "format": "date-time" }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "actualStart": { "type": "string", "format": "date-time" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "billingAttention": { "type": "string", "description": " Max length: 50;" }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "billingRateType": { "enum": [ "StaffMember", "WorkRole" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProjectAfterClosedFlag": { "type": "boolean", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "billUnapprovedTimeAndExpense": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/ProjectBoardReference" }, "budgetAnalysis": { "enum": [ "ActualHours", "BillableHours" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "budgetFlag": { "type": "boolean", "nullable": true }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "customerPO": { "type": "string", "description": " Max length: 50;" }, "description": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "downpayment": { "type": "number", "format": "double", "nullable": true }, "estimatedEnd": { "type": "string", "format": "date-time" }, "percentComplete": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedHours": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedStart": { "type": "string", "format": "date-time" }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "includeDependenciesFlag": { "type": "boolean", "nullable": true }, "includeEstimatesFlag": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "manager": { "$ref": "#/components/schemas/MemberReference" }, "name": { "type": "string", "description": " Max length: 100;" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "projectTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "restrictDownPaymentFlag": { "type": "boolean", "nullable": true }, "scheduledEnd": { "type": "string", "format": "date-time" }, "scheduledHours": { "type": "number", "format": "double", "nullable": true }, "scheduledStart": { "type": "string", "format": "date-time" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "status": { "$ref": "#/components/schemas/ProjectStatusReference" }, "closedFlag": { "type": "boolean" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "type": { "$ref": "#/components/schemas/ProjectTypeReference" }, "doNotDisplayInPortalFlag": { "type": "boolean", "nullable": true }, "billingStartDate": { "type": "string", "format": "date-time" }, "poAmount": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProjectBillingRate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectRecId": { "type": "integer", "format": "int32" }, "hourlyRate": { "type": "number", "format": "double" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "activityClassRecId": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "memberRecId": { "type": "integer", "format": "int32" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectBoardKanbanSetting": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "color": { "type": "string", "description": " Max length: 4;" }, "order": { "type": "integer", "format": "int32" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardKanbanStatus" } }, "updatedBy": { "type": "string", "description": " Max length: 15;" }, "lastUpdated": { "type": "string" } } }, "ProjectBoardKanbanStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "srStatusId": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" } } }, "ProjectBoardReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectBoardTeam": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectBoardTeamInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectBoardTeamMember": { "required": [ "member", "projectRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "projectRole": { "$ref": "#/components/schemas/ProjectRoleReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectContact": { "required": [ "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectPhase": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "description": " Max length: 100;" }, "board": { "$ref": "#/components/schemas/ProjectBoardReference" }, "status": { "$ref": "#/components/schemas/PhaseStatusReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "department": { "$ref": "#/components/schemas/BillingUnitReference" }, "parentPhase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string", "description": " Max length: 50;" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "markAsMilestoneFlag": { "type": "boolean", "nullable": true }, "notes": { "type": "string" }, "deadlineDate": { "type": "string", "format": "date-time" }, "billSeparatelyFlag": { "type": "boolean", "nullable": true }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "description": "billingMethod is required if the phase billSeparatelyFlag is true.", "nullable": true }, "scheduledHours": { "type": "number", "format": "double", "nullable": true }, "scheduledStart": { "type": "string" }, "scheduledEnd": { "type": "string" }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "actualStart": { "type": "string" }, "actualEnd": { "type": "string" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "billingStartDate": { "type": "string", "format": "date-time" }, "billPhaseClosedFlag": { "type": "boolean", "description": "This phase can only be billed after it has been closed.", "nullable": true }, "billProjectClosedFlag": { "type": "boolean", "description": "This phase can only be billed after the project has been closed.", "nullable": true }, "downpayment": { "type": "number", "format": "double", "nullable": true }, "poNumber": { "type": "string", "description": " Max length: 25;" }, "poAmount": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProjectPhaseReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectSecurityRole": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "managerRoleFlag": { "type": "boolean", "nullable": true }, "defaultContactFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectSecurityRoleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "managerRoleFlag": { "type": "boolean", "nullable": true }, "defaultContactFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectSecurityRoleSetting": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "addLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "editLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "deleteLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "inquireLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "moduleIdentifier": { "type": "string", "description": " Max length: 50;" }, "myFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "noTimeFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "statusIndicator": { "$ref": "#/components/schemas/StatusIndicatorReference" }, "customStatusIndicatorName": { "type": "string", "description": "Required when statusIndicator is Custom. Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "noTimeFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTeamMember": { "required": [ "member", "projectRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "hours": { "type": "number", "format": "double", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "projectRole": { "$ref": "#/components/schemas/ProjectRoleReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplate": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 200;" }, "description": { "type": "string" }, "connectWiseId": { "type": "string" }, "type": { "$ref": "#/components/schemas/ProjectTypeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplatePhase": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "templateRecId": { "type": "integer", "format": "int32" }, "parentPhase": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string" }, "markAsMilestone": { "type": "boolean" }, "phaseBilledSeparately": { "type": "boolean" }, "wbsCode": { "type": "string" }, "connectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplatePhaseReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplateTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "sequence": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "connectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "summary": { "type": "string" }, "code": { "$ref": "#/components/schemas/ServiceCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplateTicket": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "projectTemplatePhaseId": { "type": "integer", "format": "int32", "nullable": true }, "lineNumber": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "description": " Max length: 100;" }, "connectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "projectTemplatePhaseCwId": { "type": "string" }, "notes": { "type": "string" }, "internalAnalysis": { "type": "string" }, "resolution": { "type": "string" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "wbsCode": { "type": "string", "description": " Max length: 50;" }, "billSeparatelyFlag": { "type": "boolean", "nullable": true }, "markAsMilestoneFlag": { "type": "boolean", "nullable": true }, "recordType": { "type": "string", "description": " Max length: 1;" }, "pmTmpProjectRecID": { "type": "integer", "format": "int32", "nullable": true }, "predecessorType": { "enum": [ "Ticket", "Phase" ], "type": "string", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorClosedFlag": { "type": "boolean", "nullable": true }, "lagDays": { "type": "integer", "format": "int32", "nullable": true }, "lagNonworkingDaysFlag": { "type": "boolean", "nullable": true }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplateWorkPlan": { "type": "object", "properties": { "templateId": { "type": "integer", "format": "int32" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/TemplatePhase" } } } }, "ProjectTicket": { "required": [ "summary", "phase" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string", "description": " Max length: 100;" }, "isIssueFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string", "description": " Max length: 50;" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "siteName": { "type": "string", "description": " Max length: 50;" }, "addressLine1": { "type": "string", "description": " Max length: 50;" }, "addressLine2": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "stateIdentifier": { "type": "string", "description": " Max length: 50;" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "contactName": { "type": "string", "description": " Max length: 62;" }, "contactPhoneNumber": { "type": "string", "description": " Max length: 20;" }, "contactPhoneExtension": { "type": "string", "description": " Max length: 15;" }, "contactEmailAddress": { "type": "string", "description": " Max length: 250;" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "owner": { "$ref": "#/components/schemas/MemberReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "requiredDate": { "type": "string", "format": "date-time" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementType": { "type": "string" }, "knowledgeBaseCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseSubCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseLinkId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseLinkType": { "enum": [ "Activity", "ProjectIssue", "KnowledgeBaseArticle", "ProjectTicket", "ServiceTicket", "Time" ], "type": "string", "nullable": true }, "allowAllClientsPortalView": { "type": "boolean", "nullable": true }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "automaticEmailContactFlag": { "type": "boolean", "nullable": true }, "automaticEmailResourceFlag": { "type": "boolean", "nullable": true }, "automaticEmailCcFlag": { "type": "boolean", "nullable": true }, "automaticEmailCc": { "type": "string", "description": " Max length: 1000;" }, "closedDate": { "type": "string" }, "closedBy": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "approved": { "type": "boolean", "nullable": true }, "subBillingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "subBillingAmount": { "type": "number", "format": "double", "nullable": true }, "subDateAccepted": { "type": "string" }, "resources": { "type": "string" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "predecessorType": { "enum": [ "Ticket", "Phase" ], "type": "string", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorClosedFlag": { "type": "boolean", "nullable": true }, "lagDays": { "type": "integer", "format": "int32", "nullable": true }, "lagNonworkingDaysFlag": { "type": "boolean", "nullable": true }, "estimatedStartDate": { "type": "string", "format": "date-time" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "scheduleStartDate": { "type": "string", "format": "date-time" }, "scheduleEndDate": { "type": "string", "format": "date-time" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTask" } }, "initialDescription": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialInternalAnalysis": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialResolution": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "contactEmailLookup": { "type": "string" }, "processNotifications": { "type": "boolean", "description": "Can be set to false to skip notification processing when adding or updating a ticket (Defaults to True).", "nullable": true }, "skipCallback": { "type": "boolean", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProjectTicketNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "noteType": { "enum": [ "TicketNote", "TimeEntryNote", "MeetingNote" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "text": { "type": "string" }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "timeStart": { "type": "string", "format": "date-time" }, "timeEnd": { "type": "string", "format": "date-time" }, "bundledFlag": { "type": "boolean", "nullable": true }, "mergedFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "originalAuthor": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectWorkplan": { "type": "object", "properties": { "projectId": { "type": "integer", "format": "int32" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectWorkplanProjectPhase" } } } }, "ProjectWorkplanProjectPhase": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "status": { "$ref": "#/components/schemas/PhaseStatusReference" }, "parentPhase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string" }, "markAsMilestoneFlag": { "type": "boolean", "nullable": true }, "notes": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "billableHours": { "type": "number", "format": "double", "nullable": true }, "scheduled_Hours": { "type": "number", "format": "double", "nullable": true }, "scheduled_Start": { "type": "string" }, "scheduled_End": { "type": "string" }, "scheduled_Duration": { "type": "integer", "format": "int32", "nullable": true }, "billPhaseSeparately": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "PurchaseOrder": { "required": [ "status", "terms", "vendorCompany" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnit": { "$ref": "#/components/schemas/BillingUnitReference" }, "cancelReason": { "type": "string" }, "closedFlag": { "type": "boolean", "description": "The closed flag can only be updated via updating the purchase order status to a closed/open status.", "nullable": true }, "closedBy": { "type": "string" }, "customerCity": { "type": "string" }, "customerCompany": { "$ref": "#/components/schemas/CompanyReference" }, "customerContact": { "$ref": "#/components/schemas/ContactReference" }, "customerCountry": { "$ref": "#/components/schemas/CountryReference" }, "customerExtension": { "type": "string" }, "customerName": { "type": "string" }, "customerPhone": { "type": "string" }, "customerSite": { "$ref": "#/components/schemas/SiteReference" }, "customerSiteName": { "type": "string" }, "customerState": { "type": "string" }, "customerStreetLine1": { "type": "string" }, "customerStreetLine2": { "type": "string" }, "customerZip": { "type": "string" }, "dateClosed": { "type": "string", "format": "date-time" }, "dropShipCustomerFlag": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "freightCost": { "type": "number", "format": "double", "nullable": true }, "freightPackingSlip": { "type": "string" }, "freightTaxTotal": { "type": "number", "format": "double", "nullable": true }, "internalNotes": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "poDate": { "type": "string", "description": " Required On Updates;", "format": "date-time" }, "poNumber": { "type": "string", "description": " Required On Updates; Max length: 50;" }, "salesTax": { "type": "number", "format": "double", "nullable": true }, "shipmentDate": { "type": "string", "format": "date-time" }, "shipmentMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "shippingInstructions": { "type": "string" }, "status": { "$ref": "#/components/schemas/PurchaseOrderStatusReference" }, "subTotal": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "taxFreightFlag": { "type": "boolean", "nullable": true }, "taxPoFlag": { "type": "boolean", "nullable": true }, "terms": { "$ref": "#/components/schemas/BillingTermsReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "trackingNumber": { "type": "string", "description": " Max length: 50;" }, "updateShipmentInfo": { "type": "boolean", "description": "Determines whether or not to update all of the shipment info for each associated line item when new shipment info is passed in.", "nullable": true }, "updateVendorOrderNumber": { "type": "boolean", "description": "Determines whether or not to update vendor order number for each associated line item when new vendor order number is passed in.", "nullable": true }, "vendorCompany": { "$ref": "#/components/schemas/CompanyReference" }, "vendorContact": { "$ref": "#/components/schemas/ContactReference" }, "vendorInvoiceDate": { "type": "string", "format": "date-time" }, "vendorInvoiceNumber": { "type": "string", "description": " Max length: 50;" }, "vendorOrderNumber": { "type": "string", "description": " Max length: 50;" }, "vendorSite": { "$ref": "#/components/schemas/SiteReference" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseContact": { "$ref": "#/components/schemas/ContactReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "PurchaseOrderInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderLineItem": { "required": [ "description", "lineNumber", "product", "quantity", "unitOfMeasure" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "backorderedFlag": { "type": "boolean", "nullable": true }, "canceledBy": { "type": "string" }, "canceledFlag": { "type": "boolean", "nullable": true }, "canceledReason": { "type": "string", "description": " Max length: 100;" }, "closedFlag": { "type": "boolean", "nullable": true }, "dateCanceled": { "type": "string", "format": "date-time" }, "dateCanceledUtc": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": " Max length: 6000;" }, "displayInternalNotesFlag": { "type": "boolean", "nullable": true }, "expectedShipDate": { "type": "string", "format": "date-time" }, "internalNotes": { "type": "string", "description": " Max length: 1000;" }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true }, "packingSlip": { "type": "string", "description": " Max length: 50;" }, "product": { "$ref": "#/components/schemas/IvItemReference" }, "purchaseOrderId": { "type": "integer", "format": "int32", "nullable": true }, "purchaseOrderNumber": { "type": "string", "description": " Max length: 50;" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "receivedQuantity": { "type": "integer", "format": "int32", "nullable": true }, "serialNumbers": { "type": "string" }, "shipDate": { "type": "string", "format": "date-time" }, "shipmentMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "tax": { "type": "number", "format": "double", "nullable": true }, "trackingNumber": { "type": "string", "description": " Max length: 50;" }, "unitCost": { "type": "number", "format": "double", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasureReference" }, "vendorOrderNumber": { "type": "string", "description": " Max length: 50;" }, "vendorSku": { "type": "string", "description": " Max length: 50;" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "shipSet": { "type": "string", "description": " Max length: 10;" }, "dateReceived": { "type": "string", "format": "date-time" }, "receivedStatus": { "enum": [ "Waiting", "FullyReceived", "PartiallyReceiveCancelRest", "PartiallyReceiveCloneRest" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "extCost": { "type": "number", "format": "double" }, "expectedArrivalDate": { "type": "string", "format": "date-time" }, "isDetachAvailable": { "type": "boolean" }, "batchedFlag": { "type": "boolean" }, "unbatchedRecId": { "type": "integer", "format": "int32", "nullable": true }, "salesOrder": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderReference" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "PurchaseOrderLineItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "purchaseHeaderRecID": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultClosedFlag": { "type": "boolean", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/PurchaseOrderStatusEmailTemplateReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderStatusEmailTemplate": { "required": [ "subject" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/PurchaseOrderStatusReference" }, "useSenderFlag": { "type": "boolean", "nullable": true }, "firstName": { "type": "string", "description": " Max length: 100;" }, "lastName": { "type": "string", "description": " Max length: 100;" }, "emailAddress": { "type": "string", "description": " Max length: 100;" }, "subject": { "type": "string", "description": " Max length: 200;" }, "body": { "type": "string" }, "copySenderFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderStatusEmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultClosedFlag": { "type": "boolean", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderStatusNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "status": { "$ref": "#/components/schemas/PurchaseOrderStatusReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": "Purchase Order Status Notification email must be entered if the notify type is \"Email Address\". Max length: 50;" }, "workflowStep": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchaseOrderStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PurchasingDemand": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDemand" } }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrder" } } }, "QuoteLink": { "required": [ "link" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "link": { "type": "string", "description": " Max length: 2000;" }, "allLocationsFlag": { "type": "boolean", "nullable": true }, "newWindowFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RelationshipReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReminderReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Report": { "type": "object", "properties": { "name": { "type": "string" } } }, "ReportCard": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReportCardDetail": { "required": [ "kpi" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "kpi": { "$ref": "#/components/schemas/KPIReference" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "reportCard": { "$ref": "#/components/schemas/ReportCardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReportCardInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReportCardReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReportColumnDefinition": { "type": "object", "properties": { "type": { "type": "string" }, "isNullable": { "type": "boolean" }, "identityColumn": { "type": "boolean" } } }, "ReportDataResponse": { "type": "object", "properties": { "column_definitions": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReportColumnDefinition" } } }, "row_values": { "type": "array", "items": { "type": "array", "items": { "type": "object" } } } } }, "ReportingService": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "reportingUserName": { "type": "string", "description": " Max length: 50;" }, "reportingPassword": { "type": "string", "description": "To blank out the password, enter an empty string here. Max length: 50;" }, "reportingDomain": { "type": "string", "description": " Max length: 50;" }, "reportingUrl": { "type": "string", "description": " Max length: 100;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RequestPasswordRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "ResultInfo": { "type": "object", "properties": { "success": { "type": "boolean" }, "originalIndex": { "type": "integer", "format": "int32" }, "statusCode": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/IRestIdentifiedItem" }, "error": { "$ref": "#/components/schemas/ErrorResponseMessage" } } }, "RmaAction": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaActionInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaActionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaDisposition": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaDispositionInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaDispositionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/RmaStatusEmailTemplateReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaStatusEmailTemplate": { "required": [ "subject", "body" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/RmaStatusReference" }, "useSenderFlag": { "type": "boolean", "nullable": true }, "firstName": { "type": "string", "description": " Max length: 100;" }, "lastName": { "type": "string", "description": " Max length: 100;" }, "emailAddress": { "type": "string", "description": " Max length: 100;" }, "subject": { "type": "string", "description": " Max length: 200;" }, "body": { "type": "string" }, "copySenderFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaStatusEmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaStatusNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "status": { "$ref": "#/components/schemas/RmaStatusReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": "RMA Status Notification sendEmail must be entered if the notify type is \"Email Address\". Max length: 50;" }, "workflowStep": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RmaTag": { "required": [ "product", "productDescription", "status", "location", "department", "returnedCompany", "rmaDisposition" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serviceTicket": { "$ref": "#/components/schemas/TicketReference" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrderReference" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "summary": { "type": "string", "description": " Max length: 150;" }, "product": { "$ref": "#/components/schemas/IvItemReference" }, "ivDescription": { "type": "string" }, "productDescription": { "type": "string", "description": " Max length: 200;" }, "serialNumber": { "type": "string" }, "mfgItemID": { "type": "string", "description": " Max length: 100;" }, "status": { "$ref": "#/components/schemas/RmaStatusReference" }, "listPrice": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "problemDescription": { "type": "string", "description": " Max length: 1000;" }, "returnedCompany": { "$ref": "#/components/schemas/CompanyReference" }, "returnedContact": { "$ref": "#/components/schemas/ContactReference" }, "returnedContactType": { "type": "string" }, "returnedContactPhone": { "type": "string" }, "returnedContactExtension": { "type": "string" }, "returnedContactEmail": { "type": "string" }, "returnedContactAddressLine1": { "type": "string", "description": " Max length: 50;" }, "returnedContactAddressLine2": { "type": "string", "description": " Max length: 50;" }, "returnedContactCity": { "type": "string", "description": " Max length: 50;" }, "returnedContactState": { "type": "string", "description": " Max length: 50;" }, "returnedContactZip": { "type": "string", "description": " Max length: 12;" }, "returnedContactCountry": { "$ref": "#/components/schemas/CountryReference" }, "rmaDisposition": { "$ref": "#/components/schemas/RmaDispositionReference" }, "returnedSite": { "$ref": "#/components/schemas/SiteReference" }, "purchasedCompany": { "$ref": "#/components/schemas/CompanyReference" }, "purchasedContact": { "$ref": "#/components/schemas/ContactReference" }, "purchasedContactType": { "type": "string" }, "purchasedContactPhone": { "type": "string" }, "purchasedContactExtension": { "type": "string" }, "purchasedContactEmail": { "type": "string" }, "purchasedContactAddressLine1": { "type": "string", "description": " Max length: 50;" }, "purchasedContactAddressLine2": { "type": "string", "description": " Max length: 50;" }, "purchasedContactCity": { "type": "string", "description": " Max length: 50;" }, "purchasedContactState": { "type": "string", "description": " Max length: 50;" }, "purchasedContactZip": { "type": "string", "description": " Max length: 12;" }, "purchasedContactCountry": { "$ref": "#/components/schemas/CountryReference" }, "purchasedInvoiceNumber": { "type": "string", "description": " Max length: 50;" }, "purchasedInvoiceDate": { "type": "string", "format": "date" }, "purchasedOrderNumber": { "type": "string", "description": " Max length: 50;" }, "purchasedVendorAction": { "$ref": "#/components/schemas/RmaActionReference" }, "purchasedVendorRmaNumber": { "type": "string", "description": " Max length: 50;" }, "purchasedSite": { "$ref": "#/components/schemas/SiteReference" }, "purchasedNotes": { "type": "string", "description": " Max length: 1000;" }, "warrantyCompany": { "$ref": "#/components/schemas/CompanyReference" }, "warrantyContact": { "$ref": "#/components/schemas/ContactReference" }, "warrantyContactType": { "type": "string" }, "warrantyContactPhone": { "type": "string" }, "warrantyContactEmail": { "type": "string" }, "warrantyContactExtension": { "type": "string" }, "warrantyContactAddressLine1": { "type": "string", "description": " Max length: 50;" }, "warrantyContactAddressLine2": { "type": "string", "description": " Max length: 50;" }, "warrantyContactCity": { "type": "string", "description": " Max length: 50;" }, "warrantyContactState": { "type": "string", "description": " Max length: 50;" }, "warrantyContactZip": { "type": "string", "description": " Max length: 12;" }, "warrantyContactCountry": { "$ref": "#/components/schemas/CountryReference" }, "warrantySite": { "$ref": "#/components/schemas/SiteReference" }, "warrantyNotes": { "type": "string", "description": " Max length: 1000;" }, "repairCompany": { "$ref": "#/components/schemas/CompanyReference" }, "repairContact": { "$ref": "#/components/schemas/ContactReference" }, "repairContactType": { "type": "string" }, "repairContactPhone": { "type": "string" }, "repairContactExtension": { "type": "string" }, "repairContactEmail": { "type": "string" }, "repairContactAddressLine1": { "type": "string", "description": " Max length: 50;" }, "repairContactAddressLine2": { "type": "string", "description": " Max length: 50;" }, "repairContactCity": { "type": "string", "description": " Max length: 50;" }, "repairContactState": { "type": "string", "description": " Max length: 50;" }, "repairContactZip": { "type": "string", "description": " Max length: 12;" }, "repairContactCountry": { "$ref": "#/components/schemas/CountryReference" }, "repairOrderNumber": { "type": "string", "description": " Max length: 50;" }, "repairSite": { "$ref": "#/components/schemas/SiteReference" }, "repairNotes": { "type": "string", "description": " Max length: 1000;" }, "dropShipFlag": { "type": "boolean", "nullable": true }, "shipMethod": { "$ref": "#/components/schemas/ShipmentMethodReference" }, "shippingDate": { "type": "string", "format": "date" }, "shippingTrackingNumber": { "type": "string", "description": " Max length: 50;" }, "internalNotes": { "type": "string", "description": " Max length: 1000;" }, "closingNotes": { "type": "string", "description": " Max length: 1000;" }, "dateClosed": { "type": "string" }, "accountManager": { "$ref": "#/components/schemas/MemberReference" }, "technicalContact": { "$ref": "#/components/schemas/MemberReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "closedBy": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Role": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesConversion": { "type": "object", "properties": { "parentType": { "type": "string" }, "convertedTo": { "$ref": "#/components/schemas/ConversionTypeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesOrderRecap": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "billableAmount": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "margin": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" } } }, "SalesOrderReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesOrdersLineItem": { "required": [ "salesOrder" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "purchaseOrderNumber": { "type": "string", "description": " Max length: 100;" }, "salesOrder": { "$ref": "#/components/schemas/SalesOrderReference" }, "billStatus": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "quantityCancelled": { "type": "integer", "format": "int32" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesProbability": { "required": [ "probability" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "probability": { "type": "integer", "format": "int32" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesProbabilityInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "probability": { "type": "integer", "format": "int32" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesQuota": { "required": [ "member", "location" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "forecastYear": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "category": { "$ref": "#/components/schemas/ProductCategoryReference" }, "subCategory": { "$ref": "#/components/schemas/ProductSubCategoryReference" }, "januaryRevenue": { "type": "number", "format": "double", "nullable": true }, "januaryMargin": { "type": "number", "format": "double", "nullable": true }, "februaryRevenue": { "type": "number", "format": "double", "nullable": true }, "februaryMargin": { "type": "number", "format": "double", "nullable": true }, "marchRevenue": { "type": "number", "format": "double", "nullable": true }, "marchMargin": { "type": "number", "format": "double", "nullable": true }, "aprilRevenue": { "type": "number", "format": "double", "nullable": true }, "aprilMargin": { "type": "number", "format": "double", "nullable": true }, "mayRevenue": { "type": "number", "format": "double", "nullable": true }, "mayMargin": { "type": "number", "format": "double", "nullable": true }, "juneRevenue": { "type": "number", "format": "double", "nullable": true }, "juneMargin": { "type": "number", "format": "double", "nullable": true }, "julyRevenue": { "type": "number", "format": "double", "nullable": true }, "julyMargin": { "type": "number", "format": "double", "nullable": true }, "augustRevenue": { "type": "number", "format": "double", "nullable": true }, "augustMargin": { "type": "number", "format": "double", "nullable": true }, "septemberRevenue": { "type": "number", "format": "double", "nullable": true }, "septemberMargin": { "type": "number", "format": "double", "nullable": true }, "octoberRevenue": { "type": "number", "format": "double", "nullable": true }, "octoberMargin": { "type": "number", "format": "double", "nullable": true }, "novemberRevenue": { "type": "number", "format": "double", "nullable": true }, "novemberMargin": { "type": "number", "format": "double", "nullable": true }, "decemberRevenue": { "type": "number", "format": "double", "nullable": true }, "decemberMargin": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesTeam": { "required": [ "salesTeamIdentifier", "salesTeamDescription", "salesTeamLocation" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "salesTeamIdentifier": { "type": "string", "description": " Max length: 20;" }, "salesTeamDescription": { "type": "string", "description": " Max length: 50;" }, "salesTeamLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesTeamMember": { "required": [ "member" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "allowAccessFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SalesTeamReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleColor": { "required": [ "color" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "startPercent": { "type": "integer", "description": "A startPercent (0 or higher) is required if endPercent has value.", "format": "int32", "nullable": true }, "endPercent": { "type": "integer", "description": "A endPercent is required if startPercent has value.", "format": "int32", "nullable": true }, "color": { "type": "string", "description": "Must be a valid Hexadecimal Color Code." }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scheduleEntry": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "dateStart": { "type": "string" }, "dateEnd": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleEntry": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "objectId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "description": " Max length: 250;" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "where": { "$ref": "#/components/schemas/ServiceLocationReference" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "reminder": { "$ref": "#/components/schemas/ReminderReference" }, "status": { "$ref": "#/components/schemas/ScheduleStatusReference" }, "type": { "$ref": "#/components/schemas/ScheduleTypeReference" }, "span": { "$ref": "#/components/schemas/ScheduleSpanReference" }, "doneFlag": { "type": "boolean", "nullable": true }, "acknowledgedFlag": { "type": "boolean", "nullable": true }, "ownerFlag": { "type": "boolean", "nullable": true }, "meetingFlag": { "type": "boolean", "nullable": true }, "allowScheduleConflictsFlag": { "type": "boolean", "nullable": true }, "addMemberToProjectFlag": { "type": "boolean", "nullable": true }, "projectRoleId": { "type": "integer", "format": "int32", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "acknowledgedDate": { "type": "string", "format": "date-time" }, "closeDate": { "type": "string", "format": "date-time" }, "notifyResource": { "type": "boolean", "nullable": true }, "notificationSent": { "type": "boolean", "nullable": true }, "notificationResponse": { "type": "string" }, "hours": { "type": "number", "format": "double", "nullable": true }, "startTimeSet": { "type": "boolean", "nullable": true }, "endTimeSet": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleEntryDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scheduleEntry": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "dateStart": { "type": "string" }, "dateEnd": { "type": "string" }, "hoursScheduled": { "type": "number", "format": "double" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleEntryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleReminderTime": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "time": { "type": "integer", "description": "Time is calculated in minutes.", "format": "int32", "nullable": true }, "name": { "type": "string", "description": " Max length: 10;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleSpanReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "showAsTentativeFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "showAsTentativeFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleStopwatch": { "required": [ "member", "scheduleId", "status" ], "type": "object", "properties": { "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "dateEntered": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "internalNotes": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "notes": { "type": "string", "description": " Max length: 4000;" }, "scheduleId": { "type": "integer", "format": "int32", "nullable": true }, "scheduleMobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "startTime": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Reset", "Running", "Paused", "Stopped" ], "type": "string", "nullable": true }, "totalPauseTime": { "type": "integer", "format": "int32", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" } } }, "ScheduleType": { "required": [ "name", "identifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "identifier": { "type": "string", "description": " Max length: 1;" }, "chargeCode": { "$ref": "#/components/schemas/ChargeCodeReference" }, "where": { "$ref": "#/components/schemas/ServiceLocationReference" }, "systemFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "identifier": { "type": "string" }, "chargeCode": { "$ref": "#/components/schemas/ChargeCodeReference" }, "where": { "$ref": "#/components/schemas/ServiceLocationReference" }, "systemFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SchedulingMemberInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "firstName": { "type": "string" }, "middleInitial": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "defaultEmail": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SecurityRole": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "roleType": { "type": "string", "description": " Max length: 30;" }, "adminFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SecurityRoleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "roleType": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SecurityRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SecurityRoleSetting": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "addLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "editLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "deleteLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "inquireLevel": { "enum": [ "None", "My", "All" ], "type": "string", "nullable": true }, "moduleFunctionName": { "type": "string" }, "moduleFunctionDescription": { "type": "string" }, "myAllFlag": { "type": "boolean", "nullable": true }, "moduleFunctionIdentifier": { "type": "string" }, "reportFlag": { "type": "boolean", "nullable": true }, "restrictFlag": { "type": "boolean", "nullable": true }, "customFlag": { "type": "boolean", "nullable": true }, "moduleDescription": { "type": "string" }, "moduleIdentifier": { "type": "string" }, "moduleName": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Service": { "required": [ "srNotify", "scheduleSpan" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "srNotify": { "enum": [ "All", "NewAndClosedRequests", "ClosedRequestsOnly", "NewRequestsOnly", "None" ], "type": "string", "nullable": true }, "scheduleSpan": { "enum": [ "Standard", "OfficeHours", "Overnight" ], "type": "string" }, "hideDelimiterFlag": { "type": "boolean", "nullable": true }, "allowCCFlag": { "type": "boolean", "nullable": true }, "allowTOFlag": { "type": "boolean", "nullable": true }, "headerColor": { "type": "string", "description": " Max length: 50;" }, "memberColor": { "type": "string", "description": " Max length: 50;" }, "contactColor": { "type": "string", "description": " Max length: 50;" }, "unknownColor": { "type": "string", "description": " Max length: 50;" }, "calendarSetup": { "$ref": "#/components/schemas/CalendarSetupReference" }, "headerColorDisableFlag": { "type": "boolean", "nullable": true }, "memberColorDisableFlag": { "type": "boolean", "nullable": true }, "contactColorDisableFlag": { "type": "boolean", "nullable": true }, "unknownColorDisableFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceEmailTemplate": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "Any", "Closed", "Invoice", "New", "SalesOrder", "PurchaseOrder", "RMA", "Specific" ], "type": "string", "nullable": true }, "serviceSurvey": { "$ref": "#/components/schemas/ServiceSurveyReference" }, "serviceBoard": { "$ref": "#/components/schemas/BoardReference" }, "useSenderFlag": { "type": "boolean", "nullable": true }, "firstName": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "lastName": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "emailAddress": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "subject": { "type": "string", "description": " Max length: 200;" }, "body": { "type": "string" }, "copySenderFlag": { "type": "boolean", "nullable": true }, "tasksFlag": { "type": "boolean", "nullable": true }, "resourceRecordsFlag": { "type": "boolean", "nullable": true }, "externalContactNotifications": { "type": "boolean", "nullable": true }, "internalContactNotifications": { "type": "boolean", "nullable": true }, "serviceStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceEmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "headerColor": { "type": "string" }, "memberColor": { "type": "string" }, "contactColor": { "type": "string" }, "unknownColor": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceLocation": { "required": [ "name", "where" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "where": { "enum": [ "OnSite", "Remote", "InHouse" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceLocationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceLocationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "processNotifications": { "type": "boolean", "nullable": true }, "dateCreated": { "type": "string" }, "createdBy": { "type": "string" }, "internalFlag": { "type": "boolean", "nullable": true }, "externalFlag": { "type": "boolean", "nullable": true }, "sentimentScore": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSignoff": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "visibleLogoFlag": { "type": "boolean", "nullable": true }, "companyInfoFlag": { "type": "boolean", "nullable": true }, "billingTermsFlag": { "type": "boolean", "nullable": true }, "summaryFlag": { "type": "boolean", "nullable": true }, "discussionFlag": { "type": "boolean", "nullable": true }, "taskFlag": { "type": "boolean", "description": "On add/post, if this is set to true but no value is set for task, task is defaulted to ServiceTasks.All.", "nullable": true }, "task": { "enum": [ "All", "Closed", "Open" ], "type": "string", "description": "On add/post, if this is set but no value is set for taskFlag, taskFlag is set to true.", "nullable": true }, "configurationsFlag": { "type": "boolean", "nullable": true }, "internalNotesFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "timeFlag": { "type": "boolean", "description": "On add/post, if any time related flag is set to true, this is also set to true.", "nullable": true }, "timeMemberFlag": { "type": "boolean", "nullable": true }, "timeDateFlag": { "type": "boolean", "nullable": true }, "timeStartEndFlag": { "type": "boolean", "nullable": true }, "timeBillFlag": { "type": "boolean", "nullable": true }, "timeHoursFlag": { "type": "boolean", "nullable": true }, "timeRateFlag": { "type": "boolean", "nullable": true }, "timeExtendedAmountFlag": { "type": "boolean", "nullable": true }, "timeWorkTypeFlag": { "type": "boolean", "nullable": true }, "timeAgreementFlag": { "type": "boolean", "nullable": true }, "timeNotesFlag": { "type": "boolean", "nullable": true }, "timeManualFlag": { "type": "boolean", "nullable": true }, "timeManualEntry": { "type": "integer", "format": "int32", "nullable": true }, "timeTaxFlag": { "type": "boolean", "nullable": true }, "expenseFlag": { "type": "boolean", "description": "On add/post, if any expense related flag is set to true, this is also set to true.", "nullable": true }, "expenseDateFlag": { "type": "boolean", "nullable": true }, "expenseMemberFlag": { "type": "boolean", "nullable": true }, "expenseTypeFlag": { "type": "boolean", "nullable": true }, "expenseBillFlag": { "type": "boolean", "nullable": true }, "expenseAmountFlag": { "type": "boolean", "nullable": true }, "expenseAgreementFlag": { "type": "boolean", "nullable": true }, "expenseNotesFlag": { "type": "boolean", "nullable": true }, "expenseTaxFlag": { "type": "boolean", "nullable": true }, "expenseManualFlag": { "type": "boolean", "nullable": true }, "expenseManualEntry": { "type": "integer", "format": "int32", "nullable": true }, "productFlag": { "type": "boolean", "description": "On add/post, if any product related flag is set to true, this is also set to true.", "nullable": true }, "productDescriptionFlag": { "type": "boolean", "nullable": true }, "productBillFlag": { "type": "boolean", "nullable": true }, "productQuantityFlag": { "type": "boolean", "nullable": true }, "productPriceFlag": { "type": "boolean", "nullable": true }, "productExtendedAmountFlag": { "type": "boolean", "nullable": true }, "productAgreementFlag": { "type": "boolean", "nullable": true }, "productManualFlag": { "type": "boolean", "nullable": true }, "productManualEntry": { "type": "integer", "format": "int32", "nullable": true }, "productTaxFlag": { "type": "boolean", "nullable": true }, "technicianSignoffFlag": { "type": "boolean", "nullable": true }, "customerSignoffTextFlag": { "type": "boolean", "description": "On add/post, if customerSignoffText.Length > 0, this is set to true.", "nullable": true }, "customerSignoffText": { "type": "string", "description": " Max length: 4000;" }, "customerSignoffFieldsFlag": { "type": "boolean", "nullable": true }, "billingMethodsTextFlag": { "type": "boolean", "description": "On add/post, if billingMethodsText.Length > 0, this is set to true.", "nullable": true }, "billingMethodsText": { "type": "string", "description": " Max length: 2000;" }, "creditCardFieldsFlag": { "type": "boolean", "nullable": true }, "defaultFFFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSignoffCustomField": { "required": [ "sequenceNumber", "displaySection", "userDefinedField" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "displaySection": { "enum": [ "CustomerInformation", "Detail", "Expenses", "Configurations", "AdditionalSignOffFields", "InternalNotes", "Time", "Products", "Resolution", "Summary", "Tasks" ], "type": "string", "nullable": true }, "userDefinedField": { "$ref": "#/components/schemas/UserDefinedFieldReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSignoffInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSignoffReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSourceReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "sort": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSubTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSurvey": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "headerIncludeLogoFlag": { "type": "boolean", "nullable": true }, "headerText": { "type": "string", "description": " Max length: 4000;" }, "headerTextVisibleFlag": { "type": "boolean", "nullable": true }, "footerText": { "type": "string", "description": " Max length: 500;" }, "footerTextVisibleFlag": { "type": "boolean", "nullable": true }, "thankYouText": { "type": "string", "description": " Max length: 4000;" }, "notifyWho": { "$ref": "#/components/schemas/GenericIdIdentifierReference" }, "notifyWhoVisibleFlag": { "type": "boolean", "nullable": true }, "notifyMember": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSurveyQuestion": { "required": [ "type", "question" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "type": { "enum": [ "OpenEnded", "Selection" ], "type": "string", "nullable": true }, "question": { "type": "string", "description": " Max length: 1000;" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSurveyQuestionOption" } }, "includeFlag": { "type": "boolean", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "noAnswerPoints": { "type": "integer", "format": "int32", "nullable": true }, "surveyId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSurveyQuestionOption": { "type": "object", "properties": { "includeFlag": { "type": "boolean", "nullable": true }, "caption": { "type": "string" }, "points": { "type": "integer", "format": "int32", "nullable": true } } }, "ServiceSurveyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "schedule": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "code": { "$ref": "#/components/schemas/ServiceCodeReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "resolution": { "type": "string" }, "childScheduleAction": { "enum": [ "Transfer", "Delete", "Done" ], "type": "string", "nullable": true }, "childTicketId": { "type": "integer", "format": "int32", "nullable": true }, "summary": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTeam": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "leader": { "$ref": "#/components/schemas/MemberReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "deleteNotifyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTeamReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "subtype": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "assignedNotifyFlag": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "summary": { "type": "string" }, "problem": { "type": "string" }, "hoursBudget": { "type": "number", "format": "double", "nullable": true }, "internalAnalysis": { "type": "string" }, "timeBillableFlag": { "type": "boolean", "nullable": true }, "expenseBillableFlag": { "type": "boolean", "nullable": true }, "purchaseOrderNumber": { "type": "string" }, "reference": { "type": "string" }, "billComplete_Flag": { "type": "boolean", "nullable": true }, "billServiceSeparatelyFlag": { "type": "boolean", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "billUnapprovedTimeAndExpensesFlag": { "type": "boolean", "nullable": true }, "overrideFlag": { "type": "boolean", "nullable": true }, "timeInvoiceFlag": { "type": "boolean", "nullable": true }, "expenseInvoiceFlag": { "type": "boolean", "nullable": true }, "productInvoiceFlag": { "type": "boolean", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string" }, "severity": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "impact": { "enum": [ "Low", "Medium", "High" ], "type": "string" }, "assignedBy": { "$ref": "#/components/schemas/MemberReference" }, "scheduleDaysBefore": { "type": "integer", "format": "int32", "nullable": true }, "serviceDaysBefore": { "type": "integer", "format": "int32", "nullable": true }, "attachScheduleToNewServiceFlag": { "type": "boolean", "nullable": true }, "templateFlag": { "type": "boolean", "nullable": true }, "emailContactFlag": { "type": "boolean", "nullable": true }, "emailResourceFlag": { "type": "boolean", "nullable": true }, "emailCCFlag": { "type": "boolean", "nullable": true }, "emailCC": { "type": "string" }, "restrictDownpaymentFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplateInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "templateFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "summary": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTicketLink": { "required": [ "name", "linkText", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "enabledFlag": { "type": "boolean", "nullable": true }, "linkText": { "type": "string", "description": " Max length: 50;" }, "url": { "type": "string", "description": " Max length: 1000;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTicketLinkInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "linkText": { "type": "string" }, "url": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTicketNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "noteType": { "enum": [ "TicketNote", "TimeEntryNote", "MeetingNote" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "text": { "type": "string" }, "isMarkdownFlag": { "type": "boolean", "nullable": true }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "timeStart": { "type": "string" }, "timeEnd": { "type": "string" }, "bundledFlag": { "type": "boolean", "nullable": true }, "mergedFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "originalAuthor": { "type": "string" }, "createdByParentFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SetupScreen": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "moduleDescription": { "type": "string" }, "moduleIdentifier": { "type": "string" }, "moduleName": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Severity": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "description": " Max length: 200;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ShipmentMethod": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "trackingUrl": { "type": "string", "description": " Max length: 200;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ShipmentMethodInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "trackingUrl": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ShipmentMethodReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SicCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SiteReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Skill": { "required": [ "name", "category" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "category": { "$ref": "#/components/schemas/SkillCategoryReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SkillCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SkillCategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SkillInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SkillReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SLA": { "required": [ "name", "basedOn" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 25;" }, "basedOn": { "enum": [ "AllHours", "Customer", "MyCalendar", "Custom" ], "type": "string", "nullable": true }, "customCalendar": { "$ref": "#/components/schemas/CalendarReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "applicationOrder": { "type": "integer", "format": "int32", "nullable": true }, "hiImpactHiUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "hiImpactMedUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "hiImpactLowUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "medImpactHiUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "medImpactMedUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "medImpactLowUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "lowImpactHiUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "lowImpactMedUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "lowImpactLowUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "respondHours": { "type": "number", "format": "double", "nullable": true }, "respondPercent": { "type": "integer", "format": "int32", "nullable": true }, "planWithin": { "type": "number", "format": "double", "nullable": true }, "planWithinPercent": { "type": "integer", "format": "int32", "nullable": true }, "resolutionHours": { "type": "number", "format": "double", "nullable": true }, "resolutionPercent": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SLAInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SLAPriority": { "required": [ "priority" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "respondHours": { "type": "number", "format": "double", "nullable": true }, "respondPercent": { "type": "integer", "format": "int32", "nullable": true }, "planWithin": { "type": "number", "format": "double", "nullable": true }, "planWithinPercent": { "type": "integer", "format": "int32", "nullable": true }, "resolutionHours": { "type": "number", "format": "double", "nullable": true }, "resolutionPercent": { "type": "integer", "format": "int32", "nullable": true }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SLAReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Source": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "dateEntered": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SourceInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SsoConfiguration": { "required": [ "name", "ssoType", "locationIds" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the SSO Configuration", "format": "int32" }, "name": { "type": "string", "description": "Descriptor of the SSO Configuration Max length: 100;" }, "ssoType": { "enum": [ "CWSSO", "SAML" ], "type": "string", "description": "Type of SSO Configuration", "nullable": true }, "inactiveFlag": { "type": "boolean", "description": "Whether the SSO configuration is not active", "nullable": true }, "samlEntityId": { "type": "string", "description": "SAML Identity Provider Id Max length: 1000;" }, "samlSignInUrl": { "type": "string", "description": "Sign in url for the SAML Identity Provider Max length: 1000;" }, "samlIdpCertificate": { "type": "string", "description": "Public certificate for Identity Provider signatures" }, "samlCertificateName": { "type": "string", "description": "Name of the SAML certificate. Metadata on SAML_Idp_Certificate" }, "samlCertificateIssuedTo": { "type": "string", "description": "Who the SAML certificate was issued to. Metadata on SAML_Idp_Certificate" }, "samlCertificateThumbprint": { "type": "string", "description": "Thumbprint of the SAML certificate. Metadata on SAML_Idp_Certificate" }, "samlCertificateValidFrom": { "type": "string", "description": "Date when the SAML certificate becomes valid. Metadata on SAML_Idp_Certificate", "format": "date-time" }, "samlCertificateValidTo": { "type": "string", "description": "Date when the SAML certificate is no longer valid. Metadata on SAML_Idp_Certificate", "format": "date-time" }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The locations where the SAML Idp Configuration is used" }, "clientId": { "type": "string", "description": "Client identity for this configuration of ConnectWise SSO Max length: 1000;" }, "stsBaseUrl": { "type": "string", "description": "Sign in URL for ConnectWise SSO" }, "stsUserAdminUrl": { "type": "string", "description": "User Admin Url for ConnectWise SSO" }, "token": { "type": "string" }, "submittedMemberCount": { "type": "integer", "format": "int32" }, "allMembersSubmitted": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "isSsoOnByDefault": { "type": "boolean" } } }, "SsoUser": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ssoUserId": { "type": "string" }, "userName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "emailConfirmed": { "type": "boolean", "nullable": true }, "disabledFlag": { "type": "boolean", "nullable": true }, "linkedFlag": { "type": "boolean", "nullable": true }, "dateEntered": { "type": "string" }, "lastUpdated": { "type": "string" }, "linkedMember": { "$ref": "#/components/schemas/MemberReference" } } }, "StandardNote": { "required": [ "name", "contents" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "contents": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StandardNoteInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contents": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "State": { "required": [ "identifier", "name", "country" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 50;" }, "name": { "type": "string", "description": " Max length: 50;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StateInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "identifier": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StatusIndicator": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "icon": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StatusIndicatorReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StructureReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SubCategory": { "required": [ "name", "category" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "category": { "$ref": "#/components/schemas/ProductCategoryReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SubCategoryInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "$ref": "#/components/schemas/ProductCategoryReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SuccessResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "Survey": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "instructions": { "type": "string", "description": " Max length: 1000;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyOption": { "required": [ "caption", "points" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "caption": { "type": "string", "description": " Max length: 100;" }, "points": { "type": "integer", "format": "int32", "nullable": true }, "visibleflag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyQuestion": { "required": [ "fieldType", "entryType", "sequenceNumber", "question" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "survey": { "$ref": "#/components/schemas/SurveyReference" }, "fieldType": { "enum": [ "TextArea", "Button", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "Text", "Password" ], "type": "string", "nullable": true }, "entryType": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "question": { "type": "string", "description": " Max length: 1000;" }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyQuestionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "question": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyQuestionValue": { "required": [ "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "survey": { "$ref": "#/components/schemas/SurveyReference" }, "question": { "$ref": "#/components/schemas/SurveyQuestionReference" }, "value": { "type": "string", "description": " Max length: 1000;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "pointValue": { "type": "integer", "format": "int32", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyResult": { "required": [ "ticketId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "emailAddress": { "type": "string" }, "footerResponse": { "type": "string" }, "contactMeFlag": { "type": "boolean", "nullable": true }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResultDetail" } }, "totalPoints": { "type": "integer", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "surveyId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyResultDetail": { "type": "object", "properties": { "questionId": { "type": "integer", "format": "int32", "nullable": true }, "answer": { "type": "object", "description": "If question type is Selection, this should be the option array index." } } }, "SystemDepartmentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SystemLocationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SystemMenuEntryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SystemSetting": { "required": [ "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "value": { "type": "string" }, "valueType": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxableExpenseTypeLevel": { "required": [ "taxCodeLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxCodeLevel": { "$ref": "#/components/schemas/TaxCodeLevelReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxableProductTypeLevel": { "required": [ "taxCodeLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxCodeLevel": { "$ref": "#/components/schemas/TaxCodeLevelReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxableWorkRoleLevel": { "required": [ "taxCodeLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxCodeLevel": { "$ref": "#/components/schemas/TaxCodeLevelReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxableXRefLevel": { "required": [ "taxCodeLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxCodeLevel": { "$ref": "#/components/schemas/TaxCodeLevelReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCode": { "required": [ "identifier", "description", "invoiceCaption", "effectiveDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 8;" }, "description": { "type": "string", "description": " Max length: 50;" }, "invoiceCaption": { "type": "string", "description": " Max length: 25;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "effectiveDate": { "type": "string", "format": "date-time" }, "defaultFlag": { "type": "boolean", "nullable": true }, "displayOnInvoiceFlag": { "type": "boolean", "nullable": true }, "canadaCalculateGSTFlag": { "type": "boolean", "nullable": true }, "cancelDate": { "type": "string", "format": "date-time" }, "levelOneRate": { "type": "number", "format": "double", "nullable": true }, "levelOneRateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "levelOneTaxableMax": { "type": "number", "format": "double", "nullable": true }, "levelOneCaption": { "type": "string", "description": " Max length: 25;" }, "levelOneTaxCodeXref": { "type": "string", "description": " Max length: 50;" }, "levelOneAgencyXref": { "type": "string", "description": " Max length: 100;" }, "levelOneServicesFlag": { "type": "boolean", "nullable": true }, "levelOneExpensesFlag": { "type": "boolean", "nullable": true }, "levelOneProductsFlag": { "type": "boolean", "nullable": true }, "levelOneApplySingleUnitFlag": { "type": "boolean", "nullable": true }, "levelOneApplySingleUnitMin": { "type": "number", "format": "double", "nullable": true }, "levelOneApplySingleUnitMax": { "type": "number", "format": "double", "nullable": true }, "levelTwoRate": { "type": "number", "format": "double", "nullable": true }, "levelTwoRateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "levelTwoTaxableMax": { "type": "number", "format": "double", "nullable": true }, "levelTwoCaption": { "type": "string", "description": " Max length: 25;" }, "levelTwoTaxCodeXref": { "type": "string", "description": " Max length: 50;" }, "levelTwoAgencyXref": { "type": "string", "description": " Max length: 100;" }, "levelTwoServicesFlag": { "type": "boolean", "nullable": true }, "levelTwoExpensesFlag": { "type": "boolean", "nullable": true }, "levelTwoProductsFlag": { "type": "boolean", "nullable": true }, "levelTwoApplySingleUnitFlag": { "type": "boolean", "nullable": true }, "levelTwoApplySingleUnitMin": { "type": "number", "format": "double", "nullable": true }, "levelTwoApplySingleUnitMax": { "type": "number", "format": "double", "nullable": true }, "levelThreeRate": { "type": "number", "format": "double", "nullable": true }, "levelThreeRateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "levelThreeTaxableMax": { "type": "number", "format": "double", "nullable": true }, "levelThreeCaption": { "type": "string", "description": " Max length: 25;" }, "levelThreeTaxCodeXref": { "type": "string", "description": " Max length: 50;" }, "levelThreeAgencyXref": { "type": "string", "description": " Max length: 100;" }, "levelThreeServicesFlag": { "type": "boolean", "nullable": true }, "levelThreeExpensesFlag": { "type": "boolean", "nullable": true }, "levelThreeProductsFlag": { "type": "boolean", "nullable": true }, "levelThreeApplySingleUnitFlag": { "type": "boolean", "nullable": true }, "levelThreeApplySingleUnitMin": { "type": "number", "format": "double", "nullable": true }, "levelThreeApplySingleUnitMax": { "type": "number", "format": "double", "nullable": true }, "levelFourRate": { "type": "number", "format": "double", "nullable": true }, "levelFourRateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "levelFourTaxableMax": { "type": "number", "format": "double", "nullable": true }, "levelFourCaption": { "type": "string", "description": " Max length: 25;" }, "levelFourTaxCodeXref": { "type": "string", "description": " Max length: 50;" }, "levelFourAgencyXref": { "type": "string", "description": " Max length: 100;" }, "levelFourServicesFlag": { "type": "boolean", "nullable": true }, "levelFourExpensesFlag": { "type": "boolean", "nullable": true }, "levelFourProductsFlag": { "type": "boolean", "nullable": true }, "levelFourApplySingleUnitFlag": { "type": "boolean", "nullable": true }, "levelFourApplySingleUnitMin": { "type": "number", "format": "double", "nullable": true }, "levelFourApplySingleUnitMax": { "type": "number", "format": "double", "nullable": true }, "levelFiveRate": { "type": "number", "format": "double", "nullable": true }, "levelFiveRateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "levelFiveTaxableMax": { "type": "number", "format": "double", "nullable": true }, "levelFiveCaption": { "type": "string", "description": " Max length: 25;" }, "levelFiveTaxCodeXref": { "type": "string", "description": " Max length: 50;" }, "levelFiveAgencyXref": { "type": "string", "description": " Max length: 100;" }, "levelFiveServicesFlag": { "type": "boolean", "nullable": true }, "levelFiveExpensesFlag": { "type": "boolean", "nullable": true }, "levelFiveProductsFlag": { "type": "boolean", "nullable": true }, "levelFiveApplySingleUnitFlag": { "type": "boolean", "nullable": true }, "levelFiveApplySingleUnitMin": { "type": "number", "format": "double", "nullable": true }, "levelFiveApplySingleUnitMax": { "type": "number", "format": "double", "nullable": true }, "levelSixRate": { "type": "number", "format": "double", "nullable": true }, "levelSixRateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "levelSixTaxableMax": { "type": "number", "format": "double", "nullable": true }, "levelSixCaption": { "type": "string", "description": " Max length: 25;" }, "levelSixTaxCodeXref": { "type": "string", "description": " Max length: 50;" }, "levelSixAgencyXref": { "type": "string", "description": " Max length: 100;" }, "levelSixServicesFlag": { "type": "boolean", "nullable": true }, "levelSixExpensesFlag": { "type": "boolean", "nullable": true }, "levelSixProductsFlag": { "type": "boolean", "nullable": true }, "levelSixApplySingleUnitFlag": { "type": "boolean", "nullable": true }, "levelSixApplySingleUnitMin": { "type": "number", "format": "double", "nullable": true }, "levelSixApplySingleUnitMax": { "type": "number", "format": "double", "nullable": true }, "workRoleIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Array of work role exemptions for the tax code." }, "addAllWorkRoles": { "type": "boolean", "nullable": true }, "removeAllWorkRoles": { "type": "boolean", "nullable": true }, "expenseTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Array of expense type exemptions for the tax code." }, "addAllExpenseTypes": { "type": "boolean", "nullable": true }, "removeAllExpenseTypes": { "type": "boolean", "nullable": true }, "productTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Array of product type exemptions for the tax code." }, "addAllProductTypes": { "type": "boolean", "nullable": true }, "removeAllProductTypes": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCodeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "effectiveDate": { "type": "string" }, "cancelDate": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "levelOneRate": { "type": "number", "format": "double", "nullable": true }, "levelTwoRate": { "type": "number", "format": "double", "nullable": true }, "levelThreeRate": { "type": "number", "format": "double", "nullable": true }, "levelFourRate": { "type": "number", "format": "double", "nullable": true }, "levelFiveRate": { "type": "number", "format": "double", "nullable": true }, "levelSixRate": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCodeLevel": { "required": [ "taxRate", "rateType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxLevel": { "type": "integer", "format": "int32" }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "rateType": { "enum": [ "Amount", "Percent" ], "type": "string", "nullable": true }, "taxableMax": { "type": "number", "format": "double", "nullable": true }, "caption": { "type": "string", "description": " Max length: 25;" }, "taxCodeXref": { "type": "string", "description": " Max length: 50;" }, "agencyXref": { "type": "string", "description": " Max length: 100;" }, "taxServicesFlag": { "type": "boolean", "nullable": true }, "taxExpensesFlag": { "type": "boolean", "nullable": true }, "taxProductsFlag": { "type": "boolean", "nullable": true }, "singleUnitFlag": { "type": "boolean", "nullable": true }, "singleUnitMinimum": { "type": "number", "format": "double", "nullable": true }, "singleUnitMaximum": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCodeLevelReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCodeXRef": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "levelOne": { "enum": [ "NonTaxable", "Taxable" ], "type": "string", "nullable": true }, "levelTwo": { "enum": [ "NonTaxable", "Taxable" ], "type": "string", "nullable": true }, "levelThree": { "enum": [ "NonTaxable", "Taxable" ], "type": "string", "nullable": true }, "levelFour": { "enum": [ "NonTaxable", "Taxable" ], "type": "string", "nullable": true }, "levelFive": { "enum": [ "NonTaxable", "Taxable" ], "type": "string", "nullable": true }, "levelSix": { "enum": [ "NonTaxable", "Taxable" ], "type": "string", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "taxableLevels": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxIntegration": { "type": "object", "properties": { "taxIntegrationType": { "enum": [ "Avalara" ], "type": "string" }, "id": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string", "description": " Max length: 50;" }, "licenseKey": { "type": "string", "description": " Max length: 50;" }, "serviceUrl": { "type": "string", "description": " Max length: 250;" }, "companyCode": { "type": "string", "description": " Max length: 50;" }, "timeTaxCode": { "type": "string", "description": " Max length: 50;" }, "expenseTaxCode": { "type": "string", "description": " Max length: 50;" }, "productTaxCode": { "type": "string", "description": " Max length: 50;" }, "invoiceAmountTaxCode": { "type": "string", "description": " Max length: 50;" }, "enabledFlag": { "type": "boolean", "nullable": true }, "commitTransactionsFlag": { "type": "boolean", "nullable": true }, "salesInvoiceFlag": { "type": "boolean", "nullable": true }, "freightTaxCode": { "type": "string", "description": " Max length: 50;" }, "accountingIntegrationFlag": { "type": "boolean", "nullable": true }, "taxLineFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxIntegrationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "enabledFlag": { "type": "boolean" }, "taxIntegrationType": { "enum": [ "Avalara" ], "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Team": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "Individual", "Team" ], "type": "string", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "salesTeam": { "$ref": "#/components/schemas/SalesTeamReference" }, "commissionPercent": { "type": "integer", "format": "int32", "nullable": true }, "referralFlag": { "type": "boolean", "nullable": true }, "opportunityId": { "type": "integer", "format": "int32", "nullable": true }, "responsibleFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TeamMember": { "required": [ "team", "member" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "teamLeaderFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TeamRole": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 20;" }, "accountManagerFlag": { "type": "boolean", "nullable": true }, "techFlag": { "type": "boolean", "nullable": true }, "salesFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TeamRoleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TeamRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TemplateGeneratedCountsModel": { "type": "object", "properties": { "serviceCount": { "type": "integer", "format": "int32" }, "scheduleCount": { "type": "integer", "format": "int32" } } }, "TemplatePhase": { "type": "object", "properties": { "parentPhase": { "$ref": "#/components/schemas/ProjectTemplatePhaseReference" }, "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "notes": { "type": "string" }, "markAsMilestoneFlag": { "type": "boolean", "nullable": true }, "billPhaseSeparately": { "type": "boolean", "nullable": true }, "wbsCode": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Ticket": { "required": [ "summary", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string", "description": " Max length: 100;" }, "recordType": { "enum": [ "ProjectIssue", "ProjectTicket", "ServiceTicket" ], "type": "string", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "siteName": { "type": "string", "description": " Max length: 50;" }, "addressLine1": { "type": "string", "description": " Max length: 50;" }, "addressLine2": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "stateIdentifier": { "type": "string", "description": " Max length: 50;" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "contactName": { "type": "string", "description": " Max length: 62;" }, "contactPhoneNumber": { "type": "string", "description": " Max length: 20;" }, "contactPhoneExtension": { "type": "string", "description": " Max length: 15;" }, "contactEmailAddress": { "type": "string", "description": " Max length: 250;" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "owner": { "$ref": "#/components/schemas/MemberReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "requiredDate": { "type": "string", "format": "date-time" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementType": { "type": "string" }, "severity": { "enum": [ "Low", "Medium", "High" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "impact": { "enum": [ "Low", "Medium", "High" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "externalXRef": { "type": "string", "description": " Max length: 100;" }, "poNumber": { "type": "string", "description": " Max length: 50;" }, "knowledgeBaseCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseSubCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "allowAllClientsPortalView": { "type": "boolean", "nullable": true }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "automaticEmailContactFlag": { "type": "boolean", "nullable": true }, "automaticEmailResourceFlag": { "type": "boolean", "nullable": true }, "automaticEmailCcFlag": { "type": "boolean", "nullable": true }, "automaticEmailCc": { "type": "string", "description": " Max length: 1000;" }, "initialDescription": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialInternalAnalysis": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialResolution": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialDescriptionFrom": { "type": "string" }, "contactEmailLookup": { "type": "string" }, "processNotifications": { "type": "boolean", "description": "Can be set to false to skip notification processing when adding or updating a ticket (Defaults to True).", "nullable": true }, "skipCallback": { "type": "boolean", "nullable": true }, "closedDate": { "type": "string" }, "closedBy": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "approved": { "type": "boolean", "nullable": true }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "subBillingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "subBillingAmount": { "type": "number", "format": "double", "nullable": true }, "subDateAccepted": { "type": "string" }, "dateResolved": { "type": "string" }, "dateResplan": { "type": "string" }, "dateResponded": { "type": "string" }, "resolveMinutes": { "type": "integer", "format": "int32", "nullable": true }, "resPlanMinutes": { "type": "integer", "format": "int32", "nullable": true }, "respondMinutes": { "type": "integer", "format": "int32", "nullable": true }, "isInSla": { "type": "boolean", "nullable": true }, "knowledgeBaseLinkId": { "type": "integer", "format": "int32", "nullable": true }, "resources": { "type": "string" }, "parentTicketId": { "type": "integer", "format": "int32", "nullable": true }, "hasChildTicket": { "type": "boolean", "nullable": true }, "hasMergedChildTicketFlag": { "type": "boolean", "nullable": true }, "knowledgeBaseLinkType": { "enum": [ "Activity", "ProjectIssue", "KnowledgeBaseArticle", "ProjectTicket", "ServiceTicket", "Time" ], "type": "string", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "predecessorType": { "enum": [ "Ticket", "Phase" ], "type": "string", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorClosedFlag": { "type": "boolean", "nullable": true }, "lagDays": { "type": "integer", "format": "int32", "nullable": true }, "lagNonworkingDaysFlag": { "type": "boolean", "nullable": true }, "estimatedStartDate": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "slaStatus": { "type": "string" }, "requestForChangeFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "mergedParentTicket": { "$ref": "#/components/schemas/TicketReference" }, "integratorTags": { "type": "array", "items": { "type": "string" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "escalationStartDateUTC": { "type": "string" }, "escalationLevel": { "type": "integer", "format": "int32", "nullable": true }, "minutesBeforeWaiting": { "type": "integer", "format": "int32", "nullable": true }, "respondedSkippedMinutes": { "type": "integer", "format": "int32", "nullable": true }, "resplanSkippedMinutes": { "type": "integer", "format": "int32", "nullable": true }, "respondedHours": { "type": "number", "format": "double", "nullable": true }, "respondedBy": { "type": "string" }, "resplanHours": { "type": "number", "format": "double", "nullable": true }, "resplanBy": { "type": "string" }, "resolutionHours": { "type": "number", "format": "double", "nullable": true }, "resolvedBy": { "type": "string" }, "minutesWaiting": { "type": "integer", "format": "int32", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "TicketBundle": { "type": "object", "properties": { "childTicketIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "TicketChangeLog": { "type": "object", "properties": { "id": { "type": "integer", "description": "Ticket Change Log ID", "format": "int32" }, "partnerId": { "type": "string", "description": "Partner ID." }, "productInstanceId": { "type": "string", "description": "Product Instance ID." }, "action": { "type": "string", "description": "Action." }, "boardId": { "type": "integer", "description": "Board ID.", "format": "int32", "nullable": true }, "boardName": { "type": "string", "description": "Board Name." }, "companyIdentifier": { "type": "integer", "description": "Company Identifier.", "format": "int32", "nullable": true }, "companyName": { "type": "string", "description": "Company Name." }, "contactId": { "type": "integer", "description": "Contact ID.", "format": "int32", "nullable": true }, "contactName": { "type": "string", "description": "Contact Name." }, "impact": { "type": "string", "description": "Impact." }, "ownerIdentifier": { "type": "integer", "description": "Owner Identifier.", "format": "int32", "nullable": true }, "priorityId": { "type": "integer", "description": "Priority ID.", "format": "int32", "nullable": true }, "priorityLevel": { "type": "string", "description": "Priority Level." }, "priorityName": { "type": "string", "description": "Priority Name." }, "prioritySort": { "type": "integer", "description": "Priority Sort.", "format": "int32", "nullable": true }, "resourceList": { "type": "string", "description": "Resource List." }, "severity": { "type": "string", "description": "Severity." }, "slaName": { "type": "string", "description": "SLA Name." }, "slaStatus": { "type": "string", "description": "SLA Status." }, "status": { "type": "string", "description": "Status." }, "summary": { "type": "string", "description": "Summary." }, "teamName": { "type": "string", "description": "Team Name." }, "ticketNumber": { "type": "integer", "description": "Ticket Number.", "format": "int32", "nullable": true }, "recordType": { "type": "string", "description": "Record Type." }, "ticketOwner": { "type": "string", "description": "Ticket Owner." }, "closedFlag": { "type": "boolean", "description": "Closed Flag.", "nullable": true }, "customerUpdatedFlag": { "type": "boolean", "description": "Customer Updated Flag.", "nullable": true }, "processingStatus": { "type": "string", "description": "Processing Status." }, "parentTicketId": { "type": "integer", "description": "Parent Ticket ID.", "format": "int32", "nullable": true }, "mergedParentTicketId": { "type": "integer", "description": "Merged Parent Ticket ID.", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketMerge": { "required": [ "mergeTicketIds", "status" ], "type": "object", "properties": { "mergeTicketIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" } } }, "TicketNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "processNotifications": { "type": "boolean", "nullable": true }, "internalFlag": { "type": "boolean", "nullable": true }, "externalFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "summary": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketStopwatch": { "required": [ "member", "status", "ticket" ], "type": "object", "properties": { "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "dateEntered": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "internalNotes": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "notes": { "type": "string", "description": " Max length: 4000;" }, "serviceStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "startTime": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Reset", "Running", "Paused", "Stopped" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "ticketMobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "totalPauseTime": { "type": "integer", "format": "int32", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "showNotesInDiscussionFlag": { "type": "boolean", "nullable": true }, "showNotesInInternalFlag": { "type": "boolean", "nullable": true }, "showNotesInResolutionFlag": { "type": "boolean", "nullable": true }, "emailNotesToContactFlag": { "type": "boolean", "nullable": true }, "emailNotesToResourcesFlag": { "type": "boolean", "nullable": true } } }, "TicketSync": { "required": [ "name", "vendorType", "integratorLogin", "company", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 80;" }, "vendorType": { "enum": [ "Zenith" ], "type": "string", "nullable": true }, "integratorLogin": { "$ref": "#/components/schemas/IntegratorLoginReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "url": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "psg": { "type": "string" }, "problemDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "schedule": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "code": { "$ref": "#/components/schemas/ServiceCodeReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "resolution": { "type": "string" }, "summary": { "type": "string" }, "childScheduleAction": { "enum": [ "Transfer", "Delete", "Done" ], "type": "string", "nullable": true }, "childTicketId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeAccrual": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "vacationFlag": { "type": "boolean", "description": "if vacationFlag is set to false, system will clear out or ingore the values of vacationAvailableType, vacationCarryoverAllowedFlag, vacationCarryoverLimit", "nullable": true }, "vacationAvailableType": { "enum": [ "AnniversaryYear", "CalendarYear" ], "type": "string", "nullable": true }, "vacationCarryoverAllowedFlag": { "type": "boolean", "nullable": true }, "vacationCarryoverLimit": { "type": "number", "format": "double", "nullable": true }, "sickFlag": { "type": "boolean", "description": "if sickFlag is set to false, system will clear out or ignore the values of sickAvailableType, sickCarryoverAllowedFlag, sickCarryoverLimit", "nullable": true }, "sickAvailableType": { "enum": [ "AnniversaryYear", "CalendarYear" ], "type": "string", "nullable": true }, "sickCarryoverAllowedFlag": { "type": "boolean", "nullable": true }, "sickCarryoverLimit": { "type": "number", "format": "double", "nullable": true }, "ptoFlag": { "type": "boolean", "description": "if ptoFlag is set to false, system will clear out or ignore the values of ptoAvailableType, ptoCarryoverAllowedFlag, ptoCarryoverLimit", "nullable": true }, "ptoAvailableType": { "enum": [ "AnniversaryYear", "CalendarYear" ], "type": "string", "nullable": true }, "ptoCarryoverAllowedFlag": { "type": "boolean", "nullable": true }, "ptoCarryoverLimit": { "type": "number", "format": "double", "nullable": true }, "holidayFlag": { "type": "boolean", "description": "if holidayFlag is set to false, system will clear out or ignore the values of holidayAvailableType, holidayCarryoverAllowedFlag, holidayCarryoverLimit", "nullable": true }, "holidayAvailableType": { "enum": [ "AnniversaryYear", "CalendarYear" ], "type": "string", "nullable": true }, "holidayCarryoverAllowedFlag": { "type": "boolean", "nullable": true }, "holidayCarryoverLimit": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeAccrualDetail": { "required": [ "accrualType", "startYear", "endYear", "hours" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "accrualType": { "enum": [ "Holiday", "PTO", "Sick", "Vacation" ], "type": "string", "description": "Available types are: Holiday, PTO, Sick and Vacation.", "nullable": true }, "startYear": { "type": "integer", "format": "int32", "nullable": true }, "endYear": { "type": "integer", "format": "int32", "nullable": true }, "hours": { "type": "number", "format": "double", "nullable": true }, "timeAccrual": { "$ref": "#/components/schemas/TimeAccrualReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeAccrualReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeEntry": { "required": [ "timeStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyType": { "type": "string" }, "chargeToId": { "type": "integer", "description": "If chargeToId is not specified, we asume you enter time against the company specified", "format": "int32", "nullable": true }, "chargeToType": { "enum": [ "Company", "ServiceTicket", "ProjectTicket", "ChargeCode", "Activity" ], "type": "string", "description": "If chargeToId is not specified, we asume you enter time against the company specified", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "businessGroupDesc": { "type": "string" }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "department": { "$ref": "#/components/schemas/BillingUnitReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementType": { "type": "string" }, "activity": { "$ref": "#/components/schemas/ActivityReference" }, "opportunityRecid": { "type": "integer", "format": "int32", "nullable": true }, "projectActivity": { "type": "string" }, "territory": { "type": "string" }, "timeStart": { "type": "string", "format": "date-time" }, "timeEnd": { "type": "string", "format": "date-time" }, "hoursDeduct": { "type": "number", "format": "double", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "notes": { "type": "string" }, "internalNotes": { "type": "string" }, "addToDetailDescriptionFlag": { "type": "boolean", "nullable": true }, "addToInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "addToResolutionFlag": { "type": "boolean", "nullable": true }, "emailResourceFlag": { "type": "boolean", "description": "This is an action flag. To update this value use the /service/tickets endpoint automaticEmailResourceFlag field", "nullable": true }, "emailContactFlag": { "type": "boolean", "description": "This is an action flag. To update this value use the /service/tickets endpoint automaticEmailContactFlag field", "nullable": true }, "emailCcFlag": { "type": "boolean", "description": "This is an action flag. To update this value use the /service/tickets endpoint automaticEmailCcFlag field", "nullable": true }, "emailCc": { "type": "string", "description": "To update this value use the /service/tickets endpoint automaticEmailCc field" }, "hoursBilled": { "type": "number", "format": "double", "nullable": true }, "invoiceHours": { "type": "number", "format": "double", "nullable": true }, "hourlyCost": { "type": "string" }, "enteredBy": { "type": "string" }, "dateEntered": { "type": "string", "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "hourlyRate": { "type": "number", "description": "This field may only be Updated, it is defaulted on Create", "format": "double", "nullable": true }, "overageRate": { "type": "number", "format": "double", "nullable": true }, "agreementHours": { "type": "number", "format": "double", "nullable": true }, "agreementAmount": { "type": "number", "format": "double", "nullable": true }, "agreementAdjustment": { "type": "number", "format": "double", "nullable": true }, "adjustment": { "type": "number", "format": "double", "nullable": true }, "invoiceReady": { "type": "integer", "format": "int32", "nullable": true }, "timeSheet": { "$ref": "#/components/schemas/TimeSheetReference" }, "status": { "enum": [ "Open", "Rejected", "PendingApproval", "ErrorsCorrected", "PendingProjectApproval", "ApprovedByTierOne", "RejectBySecondTier", "ApprovedByTierTwo", "ReadyToBill", "Billed", "WrittenOff", "BilledAgreement" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "ticketBoard": { "type": "string" }, "ticketStatus": { "type": "string" }, "ticketType": { "type": "string" }, "ticketSubType": { "type": "string" }, "invoiceFlag": { "type": "boolean", "nullable": true }, "extendedInvoiceAmount": { "type": "number", "format": "double", "nullable": true }, "locationName": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "TimeEntryAudit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "source": { "enum": [ "None", "Member", "API", "Workflow", "Portal", "Mobile", "Network", "EmailConnector", "MassMaintenance", "Application", "SystemAPI", "Conversion" ], "type": "string", "nullable": true }, "type": { "enum": [ "Activity", "CloseDate", "Company", "Contact", "Conversion", "Document", "Forecast", "Note", "Notes", "Opportunity", "Products", "Stage", "Status", "Surveys", "Team", "Tracks", "Configuration", "ConfigurationQuestions", "DeviceBackupDetails", "Tickets", "Subject", "ActivityOverview", "Schedule", "Resources", "ExpenseEntry", "Member", "Date", "Classification", "Amount", "ExpenseType", "WorkType", "WorkRole", "Mileage", "Billing", "ExpenseHeader", "Project", "TimeEntry", "TicketStatus", "DateTime", "DeductHours", "ActualHours", "Invoice", "CompanyFinance", "Billable", "SalesOrder", "Shipping", "Profile", "Group", "GroupContact", "GroupCompany", "Options", "Site", "Agreement", "Addition", "Adjustment", "Microsoft365", "API", "ProjectFinance", "CompanyProfile", "CompanyTeam", "CompanyMgmt", "InvoiceTotal", "BillingInformation", "ShippingInformation", "BillingStatus", "Location", "Department", "Territory", "Payment", "Credit", "SubcontractorInformation", "InvoicingParameters", "ApplicationParameters", "Finance", "Invoicing", "Email", "Batching", "KnowledgeBase", "KbArticle", "KnowledgeBaseApproval", "KnowledgeBaseTicket", "ManageNetwork", "Tasks", "CustomField", "ScreenConnect", "SLA", "Ticket", "Workflow", "Record", "CombinedTickets", "Template", "PurchaseOrder", "Meeting", "RmaOverview", "ReturnedBy", "PurchasedFromVendor", "WarrantyVendor", "RepairVendor", "AdditionalDetails", "TicketTemplate", "AutoGeneration", "TimeInternalNote", "TimeDiscussion", "TimeInternal", "TimeResolution", "MemberTemplate", "Delegation", "Skill", "Certification", "Accrual", "ApiKey", "Login", "Notifications", "System", "ServiceBoard", "ProjectBoard", "Scheduling", "TimeBillingExpense", "CRM", "Procurement", "JobRole", "Details", "Authentication" ], "type": "string", "nullable": true }, "message": { "type": "string" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "value": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeEntryChangeLog": { "type": "object", "properties": { "id": { "type": "integer", "description": "Time Entry Change Log ID.", "format": "int32" }, "partnerId": { "type": "string", "description": "Partner ID." }, "productInstanceId": { "type": "string", "description": "Product Instance ID." }, "action": { "type": "string", "description": "Action." }, "activitySubject": { "type": "string", "description": "Activity Subject." }, "actualUtilizedHrs": { "type": "number", "description": "Actual Utilized Hours.", "format": "double", "nullable": true }, "agreementAdjustmentFirm": { "type": "number", "description": "Agreement Adjustment Firm.", "format": "double", "nullable": true }, "agreementAdjustmentTotal": { "type": "number", "description": "Agreement Adjustment Total.", "format": "double", "nullable": true }, "agreementAmountCovered": { "type": "number", "description": "Agreement Amount Covered.", "format": "double", "nullable": true }, "agreementHoursCovered": { "type": "number", "description": "Agreement Hours Covered.", "format": "double", "nullable": true }, "billableAmount": { "type": "number", "description": "Billable Amount.", "format": "double", "nullable": true }, "billableFlag": { "type": "boolean", "description": "Billable Flag.", "nullable": true }, "billableHours": { "type": "number", "description": "Billable Hours.", "format": "double", "nullable": true }, "billableUtilizedHours": { "type": "number", "description": "Billable Utilized Hours.", "format": "double", "nullable": true }, "memberDailyCapacity": { "type": "number", "description": "Member Daily Capacity.", "format": "double", "nullable": true }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": "Billable Option.", "nullable": true }, "businessGroup": { "type": "string", "description": "Business Group." }, "locationName": { "type": "string", "description": "Location Name." }, "chargeCode": { "type": "string", "description": "Charge Code." }, "chargeTo": { "type": "string", "description": "Charge To." }, "chargeToType": { "enum": [ "Company", "ServiceTicket", "ProjectTicket", "ChargeCode", "Activity" ], "type": "string", "description": "Charge To Type.", "nullable": true }, "chargeToRecId": { "type": "integer", "description": "Charge To Record ID.", "format": "int32", "nullable": true }, "companyAndAgreement": { "type": "string", "description": "Company and Agreement." }, "companyName": { "type": "string", "description": "Company Name." }, "timeStart": { "type": "string", "description": "Time Start." }, "timeStartUtc": { "type": "string", "description": "Time Start UTC." }, "timeEnd": { "type": "string", "description": "Time End." }, "timeEndUtc": { "type": "string", "description": "Time End UTC." }, "dateStart": { "type": "string", "description": "Date Start." }, "dateInvoice": { "type": "string", "description": "Date Invoice." }, "firstName": { "type": "string", "description": "First Name." }, "hourlyCost": { "type": "string", "description": "Hourly Cost." }, "hourlyCostDecimal": { "type": "number", "description": "Hourly Cost in Decimal.", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "description": "Hourly Rate.", "format": "double", "nullable": true }, "hoursActual": { "type": "number", "description": "Actual Hours.", "format": "double", "nullable": true }, "internalNote": { "type": "string", "description": "Internal Note." }, "invoiceAdjustmentFirm": { "type": "number", "description": "Invoice Adjustment Firm.", "format": "double", "nullable": true }, "invoiceAdjustmentTotal": { "type": "number", "description": "Invoice Adjustment Total.", "format": "double", "nullable": true }, "invoiceFlag": { "type": "boolean", "description": "Invoice Flag." }, "invoiceNumber": { "type": "string", "description": "Invoice Number." }, "invoiceReady": { "type": "boolean", "description": "Invoice Ready status." }, "lastName": { "type": "string", "description": "Last Name." }, "memberId": { "type": "string", "description": "Member ID." }, "nonBillableAmt": { "type": "number", "description": "Non-Billable Amount.", "format": "double", "nullable": true }, "nonBillableHrs": { "type": "number", "description": "Non-Billable Hours.", "format": "double", "nullable": true }, "notes": { "type": "string", "description": "Notes." }, "opportunityRecId": { "type": "integer", "description": "Opportunity Record ID.", "format": "int32", "nullable": true }, "optionId": { "type": "string", "description": "Option ID." }, "projectActivity": { "type": "string", "description": "Project Activity." }, "projectName": { "type": "string", "description": "Project Name." }, "projectPhase": { "type": "string", "description": "Project Phase." }, "serviceRequestStatus": { "type": "string", "description": "Service Request Status." }, "serviceRequestSummary": { "type": "string", "description": "Service Request Summary." }, "territory": { "type": "string", "description": "Territory." }, "timeRecId": { "type": "integer", "description": "Time Record ID.", "format": "int32" }, "timeStatus": { "type": "string", "description": "Time Status." }, "utilizationFlag": { "type": "boolean", "description": "Utilization Flag.", "nullable": true }, "companyType": { "type": "string", "description": "Company Type." }, "ticketCurrentBoard": { "type": "string", "description": "Current Board of the Ticket." }, "ticketType": { "type": "string", "description": "Type of the Ticket." }, "ticketSubtype": { "type": "string", "description": "Subtype of the Ticket." }, "agreementType": { "type": "string", "description": "Type of the Agreement." }, "billingStatus": { "type": "string", "description": "Billing Status." }, "processingStatus": { "type": "string", "description": "Processing Status." }, "invoicedhours": { "type": "number", "description": "Invoiced Hours.", "format": "double", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "activity": { "$ref": "#/components/schemas/ActivityReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeEntryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeExpense": { "required": [ "internalCompany" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tier1ApprovalFlag": { "type": "boolean", "nullable": true }, "tier2ApprovalFlag": { "type": "boolean", "nullable": true }, "disableTimeEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeNoteFlag": { "type": "boolean", "nullable": true }, "requireExpenseNoteFlag": { "type": "boolean", "nullable": true }, "roundingFactor": { "type": "number", "format": "double", "nullable": true }, "invoiceStart": { "type": "integer", "format": "int32", "nullable": true }, "defaultSpecialInvoiceType": { "enum": [ "Agreement", "CreditMemo", "DownPayment", "Miscellaneous", "Progress", "Standard" ], "type": "string", "nullable": true }, "internalCompany": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimePeriod": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "timePeriodSetup": { "$ref": "#/components/schemas/TimePeriodSetupReference" }, "period": { "type": "integer", "format": "int32", "nullable": true }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "deadlineDate": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimePeriodSetup": { "required": [ "periodApplyTo", "year", "numberFuturePeriods", "type", "firstPeriodEndDate", "daysPastEndDate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "periodApplyTo": { "enum": [ "Both", "Expense", "Time" ], "type": "string", "nullable": true }, "year": { "type": "integer", "format": "int32", "nullable": true }, "numberFuturePeriods": { "type": "integer", "format": "int32", "nullable": true }, "type": { "enum": [ "Weekly", "BiWeekly", "SemiMonthly", "Monthly" ], "type": "string", "nullable": true }, "description": { "type": "string", "description": " Max length: 100;" }, "firstPeriodEndDate": { "type": "string", "format": "date" }, "monthlyPeriodEnds": { "type": "integer", "description": "Only needed when type is monthly", "format": "int32", "nullable": true }, "semiMonthlyFirstPeriod": { "type": "integer", "description": "Only needed when type is semi-monthly", "format": "int32", "nullable": true }, "semiMonthlySecondPeriod": { "type": "integer", "description": "Only needed when type is semi-monthly", "format": "int32", "nullable": true }, "semiMonthlyLastDayFlag": { "type": "boolean", "nullable": true }, "lastDayFlag": { "type": "boolean", "description": "Only needed when type is monthly", "nullable": true }, "daysPastEndDate": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimePeriodSetupDefaults": { "type": "object" }, "TimePeriodSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeSheet": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "year": { "type": "integer", "format": "int32", "nullable": true }, "period": { "type": "integer", "format": "int32", "nullable": true }, "dateStart": { "type": "string" }, "dateEnd": { "type": "string" }, "status": { "enum": [ "Open", "Rejected", "PendingApproval", "ErrorsCorrected", "PendingProjectApproval", "ApprovedByTierOne", "RejectBySecondTier", "ApprovedByTierTwo", "ReadyToBill", "Billed", "WrittenOff", "BilledAgreement" ], "type": "string", "nullable": true }, "hours": { "type": "number", "format": "double", "nullable": true }, "deadline": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeSheetAudit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "source": { "enum": [ "None", "Member", "API", "Workflow", "Portal", "Mobile", "Network", "EmailConnector", "MassMaintenance", "Application", "SystemAPI", "Conversion" ], "type": "string", "nullable": true }, "type": { "enum": [ "Activity", "CloseDate", "Company", "Contact", "Conversion", "Document", "Forecast", "Note", "Notes", "Opportunity", "Products", "Stage", "Status", "Surveys", "Team", "Tracks", "Configuration", "ConfigurationQuestions", "DeviceBackupDetails", "Tickets", "Subject", "ActivityOverview", "Schedule", "Resources", "ExpenseEntry", "Member", "Date", "Classification", "Amount", "ExpenseType", "WorkType", "WorkRole", "Mileage", "Billing", "ExpenseHeader", "Project", "TimeEntry", "TicketStatus", "DateTime", "DeductHours", "ActualHours", "Invoice", "CompanyFinance", "Billable", "SalesOrder", "Shipping", "Profile", "Group", "GroupContact", "GroupCompany", "Options", "Site", "Agreement", "Addition", "Adjustment", "Microsoft365", "API", "ProjectFinance", "CompanyProfile", "CompanyTeam", "CompanyMgmt", "InvoiceTotal", "BillingInformation", "ShippingInformation", "BillingStatus", "Location", "Department", "Territory", "Payment", "Credit", "SubcontractorInformation", "InvoicingParameters", "ApplicationParameters", "Finance", "Invoicing", "Email", "Batching", "KnowledgeBase", "KbArticle", "KnowledgeBaseApproval", "KnowledgeBaseTicket", "ManageNetwork", "Tasks", "CustomField", "ScreenConnect", "SLA", "Ticket", "Workflow", "Record", "CombinedTickets", "Template", "PurchaseOrder", "Meeting", "RmaOverview", "ReturnedBy", "PurchasedFromVendor", "WarrantyVendor", "RepairVendor", "AdditionalDetails", "TicketTemplate", "AutoGeneration", "TimeInternalNote", "TimeDiscussion", "TimeInternal", "TimeResolution", "MemberTemplate", "Delegation", "Skill", "Certification", "Accrual", "ApiKey", "Login", "Notifications", "System", "ServiceBoard", "ProjectBoard", "Scheduling", "TimeBillingExpense", "CRM", "Procurement", "JobRole", "Details", "Authentication" ], "type": "string", "nullable": true }, "message": { "type": "string" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "value": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeSheetReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeSheetTierUpdate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "approvalType": { "enum": [ "DataEntry", "Tier1Update", "Tier2Update", "Billing", "Service", "Project", "MonthlySummary", "SalesActivity", "Schedule" ], "type": "string", "nullable": true } } }, "TimeZoneReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeZoneSetup": { "required": [ "name", "timeZone" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneReference" }, "offset": { "type": "number", "description": "The hours offset from UTC (+/-)", "format": "double", "nullable": true }, "defaultFlag": { "type": "boolean", "description": "Identifies the default system time zone setup", "nullable": true }, "daylightSavingsFlag": { "type": "boolean", "description": "Determined based on system library value for specified timeZone.\n Not able to be used in query params at this time", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeZoneSetupInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "offset": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeZoneSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TodayPageCategory": { "required": [ "name", "sortOrder" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Token": { "type": "object", "properties": { "publicKey": { "type": "string" }, "privateKey": { "type": "string" }, "expiration": { "type": "string" } } }, "Track": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "notifyActionIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TrackAction": { "required": [ "notifyType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyType": { "enum": [ "CreateActivity", "SendEmail", "AddToGroup", "AttachTrack", "ChangeCompanyStatus", "CreateServiceTicket" ], "type": "string" }, "serviceTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "specificMemberTo": { "$ref": "#/components/schemas/MemberReference" }, "emailRecipient": { "type": "string", "description": " Max length: 250;" }, "specificMemberFrom": { "$ref": "#/components/schemas/MemberReference" }, "emailFrom": { "type": "string", "description": " Max length: 250;" }, "subject": { "type": "string", "description": " Max length: 100;" }, "notes": { "type": "string" }, "activityType": { "$ref": "#/components/schemas/ActivityTypeReference" }, "activityStatus": { "$ref": "#/components/schemas/ActivityStatusReference" }, "companyStatus": { "$ref": "#/components/schemas/CompanyStatusReference" }, "track": { "$ref": "#/components/schemas/TrackReference" }, "attachedTrack": { "$ref": "#/components/schemas/TrackReference" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "ccContact": { "$ref": "#/components/schemas/ContactReference" }, "bccContact": { "$ref": "#/components/schemas/ContactReference" }, "daysToExecute": { "type": "integer", "format": "int32", "nullable": true }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "notifyFrom": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TrackReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Type.SubType.CampaignSubType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnitOfMeasure": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "uomScheduleXref": { "type": "string", "description": " Max length: 31;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnitOfMeasureReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnpostedExpense": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "departmentId": { "type": "integer", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "accountNumber": { "type": "string" }, "creditAccount": { "type": "string" }, "expenseDetailId": { "type": "integer", "format": "int32", "nullable": true }, "expenseType": { "$ref": "#/components/schemas/ExpenseTypeReference" }, "classification": { "enum": [ "NonReimbursable", "Reimbursable", "Personal" ], "type": "string", "nullable": true }, "glType": { "enum": [ "AP", "AR", "EE", "EI", "EO", "IA", "IT", "P", "PF", "R", "RA", "RD", "RE", "RP", "ST", "SD", "ET", "FT", "PT", "WP", "WR" ], "type": "string", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "dateExpense": { "type": "string" }, "chargeCode": { "$ref": "#/components/schemas/ChargeCodeReference" }, "chargeDescription": { "type": "string" }, "inPolicy": { "type": "boolean", "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "billableAmount": { "type": "number", "format": "double", "nullable": true }, "nonBillableAmount": { "type": "number", "format": "double", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementAmountCovered": { "type": "number", "format": "double", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "projectPhase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "avalaraTaxFlag": { "type": "boolean", "description": "Used to determine if Avalara tax is enabled.", "nullable": true }, "itemTaxableFlag": { "type": "boolean", "nullable": true }, "salesTaxAmount": { "type": "number", "format": "double", "nullable": true }, "stateTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the state level.", "nullable": true }, "stateTaxXref": { "type": "string" }, "stateTaxAmount": { "type": "number", "format": "double", "nullable": true }, "countyTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the county level.", "nullable": true }, "countyTaxXref": { "type": "string" }, "countyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "cityTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the city level.", "nullable": true }, "cityTaxXref": { "type": "string" }, "cityTaxAmount": { "type": "number", "format": "double", "nullable": true }, "countryTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the country level.", "nullable": true }, "countryTaxXref": { "type": "string" }, "countryTaxAmount": { "type": "number", "format": "double", "nullable": true }, "compositeTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the composite level.", "nullable": true }, "compositeTaxXref": { "type": "string" }, "compositeTaxAmount": { "type": "number", "format": "double", "nullable": true }, "levelSixTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at level six.", "nullable": true }, "levelSixTaxXref": { "type": "string" }, "levelSixTaxAmount": { "type": "number", "format": "double", "nullable": true }, "dateClosed": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnpostedExpenseTaxableLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxLevel": { "type": "integer", "format": "int32" }, "taxCodeXref": { "type": "string" }, "taxAmount": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnpostedInvoice": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "billingLogId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "departmentId": { "type": "integer", "format": "int32", "nullable": true }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "accountNumber": { "type": "string" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "type": "string" }, "invoiceType": { "enum": [ "Agreement", "CreditMemo", "DownPayment", "Miscellaneous", "Progress", "Standard" ], "type": "string", "nullable": true }, "description": { "type": "string" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "dueDays": { "type": "string" }, "dueDate": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "subTotal": { "type": "number", "format": "double", "nullable": true }, "total": { "type": "number", "format": "double", "nullable": true }, "hasTime": { "type": "boolean" }, "hasExpenses": { "type": "boolean" }, "hasProducts": { "type": "boolean" }, "invoiceTaxableFlag": { "type": "boolean", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "avalaraTaxFlag": { "type": "boolean", "description": "Used to determine if Avalara tax is enabled.", "nullable": true }, "itemTaxableFlag": { "type": "boolean", "nullable": true }, "salesTaxAmount": { "type": "number", "format": "double", "nullable": true }, "stateTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the state level.", "nullable": true }, "stateTaxXref": { "type": "string" }, "stateTaxAmount": { "type": "number", "format": "double", "nullable": true }, "countyTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the county level.", "nullable": true }, "countyTaxXref": { "type": "string" }, "countyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "cityTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the city level.", "nullable": true }, "cityTaxXref": { "type": "string" }, "cityTaxAmount": { "type": "number", "format": "double", "nullable": true }, "countryTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the country level.", "nullable": true }, "countryTaxXref": { "type": "string" }, "countryTaxAmount": { "type": "number", "format": "double", "nullable": true }, "compositeTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the composite level.", "nullable": true }, "compositeTaxXref": { "type": "string" }, "compositeTaxAmount": { "type": "number", "format": "double", "nullable": true }, "levelSixTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at level six.", "nullable": true }, "levelSixTaxXref": { "type": "string" }, "levelSixTaxAmount": { "type": "number", "format": "double", "nullable": true }, "createdBy": { "type": "string" }, "dateClosed": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnpostedInvoiceTaxableLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxLevel": { "type": "integer", "format": "int32" }, "taxCodeXref": { "type": "string" }, "taxAmount": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnpostedPayments": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "source": { "enum": [ "Default", "WisePay" ], "type": "string" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "amount": { "type": "number", "format": "double", "nullable": true }, "paymentDate": { "type": "string" }, "appliedBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "wisePayPayment": { "$ref": "#/components/schemas/WisePayPayment" }, "paymentSyncStatus": { "type": "string" }, "paymentSyncDate": { "type": "string" }, "paymentAccount": { "type": "string" }, "aRPaymentAccount": { "type": "string" } } }, "UnpostedProcurement": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "unpostedProductId": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "departmentId": { "type": "integer", "format": "int32", "nullable": true }, "procurementType": { "enum": [ "Purchase", "Adjustment", "Transfer" ], "type": "string", "nullable": true }, "purchaseOrder": { "$ref": "#/components/schemas/PurchaseOrderReference" }, "purchaseDate": { "type": "string" }, "trackingNumber": { "type": "string" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "total": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "avalaraTaxFlag": { "type": "boolean", "description": "Used to determine if Avalara tax is enabled.", "nullable": true }, "itemTaxableFlag": { "type": "boolean", "nullable": true }, "purchaseOrderTaxableFlag": { "type": "boolean", "nullable": true }, "stateTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the state level.", "nullable": true }, "stateTaxXref": { "type": "string" }, "stateTaxAmount": { "type": "number", "format": "double", "nullable": true }, "countyTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the county level.", "nullable": true }, "countyTaxXref": { "type": "string" }, "countyTaxAmount": { "type": "number", "format": "double", "nullable": true }, "cityTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the city level.", "nullable": true }, "cityTaxXref": { "type": "string" }, "cityTaxAmount": { "type": "number", "format": "double", "nullable": true }, "countryTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the country level.", "nullable": true }, "countryTaxXref": { "type": "string" }, "countryTaxAmount": { "type": "number", "format": "double", "nullable": true }, "compositeTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at the composite level.", "nullable": true }, "compositeTaxXref": { "type": "string" }, "compositeTaxAmount": { "type": "number", "format": "double", "nullable": true }, "levelSixTaxFlag": { "type": "boolean", "description": "Set to true if transaction is taxable at level six.", "nullable": true }, "levelSixTaxXref": { "type": "string" }, "levelSixTaxAmount": { "type": "number", "format": "double", "nullable": true }, "taxTotal": { "type": "number", "format": "double", "nullable": true }, "customer": { "$ref": "#/components/schemas/CompanyReference" }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "vendorAccountNumber": { "type": "string" }, "vendorInvoiceNumber": { "type": "string" }, "vendorInvoiceDate": { "type": "string" }, "taxFreightFlag": { "type": "boolean", "nullable": true }, "freightTaxTotal": { "type": "number", "format": "double", "nullable": true }, "freightCost": { "type": "number", "format": "double", "nullable": true }, "dateClosed": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UnpostedProcurementTaxableLevel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "taxLevel": { "type": "integer", "format": "int32" }, "taxCodeXref": { "type": "string" }, "taxAmount": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Usage": { "type": "object", "properties": { "type": { "type": "string" }, "count": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "hyperlink": { "type": "string" }, "typeKey": { "type": "string" } } }, "UserDefinedField": { "required": [ "podId", "caption", "sequenceNumber", "fieldTypeIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the custom user defined field", "format": "int32" }, "podId": { "type": "integer", "description": "Id of the Pod where the custom field will be placed", "format": "int32", "nullable": true }, "caption": { "type": "string", "description": "Field caption Max length: 25;" }, "sequenceNumber": { "type": "integer", "description": "Must be between 1 and 500. This defines the order in which the custom fields will appear", "format": "int32", "nullable": true }, "screenId": { "type": "string", "description": "Field ScreenID Max length: 25;" }, "helpText": { "type": "string", "description": "Help text to accompany the custom field Max length: 1000;" }, "fieldTypeIdentifier": { "enum": [ "TextArea", "Button", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "PhoneNumber", "Text", "Password" ], "type": "string", "nullable": true }, "numberDecimals": { "type": "integer", "description": "Only valid for Number or percent", "format": "int32", "nullable": true }, "entryTypeIdentifier": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "displayOnScreenFlag": { "type": "boolean", "nullable": true }, "readOnlyFlag": { "type": "boolean", "nullable": true }, "listViewFlag": { "type": "boolean", "description": "Denotes that this custom field is included on a list view", "nullable": true }, "buttonUrl": { "type": "string", "description": "Only available with Button Field Type. Required when entryTypeIdentifier is button Max length: 1000;" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldOption" } }, "businessUnitIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllBusinessUnits": { "type": "boolean", "nullable": true }, "removeAllBusinessUnits": { "type": "boolean", "nullable": true }, "addAllLocations": { "type": "boolean", "nullable": true }, "removeAllLocations": { "type": "boolean", "nullable": true }, "connectWiseID": { "type": "string" }, "dateCreated": { "type": "string", "description": "Date in UTC the custom field was created", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserDefinedFieldInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the custom user defined field", "format": "int32" }, "podId": { "type": "integer", "description": "Id of the Pod where the custom field will be placed", "format": "int32", "nullable": true }, "caption": { "type": "string", "description": "Field caption" }, "sequenceNumber": { "type": "integer", "description": "Must be between 1 and 500. This defines the order in which the custom fields will appear", "format": "int32", "nullable": true }, "helpText": { "type": "string", "description": "Help text to accompany the custom field" }, "fieldTypeIdentifier": { "enum": [ "TextArea", "Button", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "PhoneNumber", "Text", "Password" ], "type": "string", "nullable": true }, "numberDecimals": { "type": "integer", "description": "Only valid for Number or percent", "format": "int32", "nullable": true }, "entryTypeIdentifier": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "displayOnScreenFlag": { "type": "boolean", "nullable": true }, "readOnlyFlag": { "type": "boolean", "nullable": true }, "listViewFlag": { "type": "boolean", "description": "Denotes that this custom field is included on a list view", "nullable": true }, "buttonUrl": { "type": "string", "description": "Only available with Button Field Type. Required when entryTypeIdentifier is button" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldOption" } }, "businessUnitIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "List of business unit ids using custom field" }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "List of locations ids using custom field" }, "dateCreated": { "type": "string", "description": "Date in UTC the custom field was created" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserDefinedFieldOption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "optionValue": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true } } }, "UserDefinedFieldReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserDefinedFieldValueModel": { "type": "object", "properties": { "userDefinedFieldRecId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "rowNum": { "type": "integer", "format": "int32" }, "skipLocationAndBillingUnit": { "type": "boolean" }, "filtered": { "type": "boolean" } } }, "UserEmail": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "userPrincipalName": { "type": "string" } } }, "ValidatePortalRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "ValidatePortalResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "contactId": { "type": "integer", "format": "int32" } } }, "ValidationError": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "resource": { "type": "string" }, "field": { "type": "string" }, "details": { "type": "string" } } }, "Version": { "type": "object", "properties": { "major": { "type": "integer", "format": "int32" }, "minor": { "type": "integer", "format": "int32" }, "build": { "type": "integer", "format": "int32" }, "revision": { "type": "integer", "format": "int32" }, "majorRevision": { "type": "integer", "format": "int32" }, "minorRevision": { "type": "integer", "format": "int32" } } }, "Warehouse": { "required": [ "name", "location", "department" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "manager": { "$ref": "#/components/schemas/MemberReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "locationXref": { "type": "string", "description": " Max length: 10;" }, "locationDefaultFlag": { "type": "boolean", "nullable": true }, "overallDefaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "lockedFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WarehouseBin": { "required": [ "name", "warehouse" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "minQuantity": { "type": "number", "format": "double", "nullable": true }, "maxQuantity": { "type": "number", "format": "double", "nullable": true }, "overflowBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "manager": { "$ref": "#/components/schemas/MemberReference" }, "length": { "type": "number", "format": "double", "nullable": true }, "width": { "type": "number", "format": "double", "nullable": true }, "height": { "type": "number", "format": "double", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "quantityOnHand": { "type": "integer", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "transferBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WarehouseBinInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WarehouseBinReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WarehouseInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "overallDefaultFlag": { "type": "boolean", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WarehouseReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "lockedFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WisePayBatchPayment": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true }, "wisePayHref": { "type": "string" } } }, "WisePayFeeInvoice": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "invoiceNumber": { "type": "string" }, "amount": { "type": "number", "format": "double", "nullable": true }, "invoiceHref": { "type": "string" } } }, "WisePayPayment": { "type": "object", "properties": { "paymentDateUtc": { "type": "string" }, "wisePayReference": { "type": "string" }, "batchPayment": { "$ref": "#/components/schemas/WisePayBatchPayment" }, "feeInvoice": { "$ref": "#/components/schemas/WisePayFeeInvoice" } } }, "WonRevenueReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "revenue": { "type": "number", "format": "double", "nullable": true }, "cost": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "percentage": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Workflow": { "required": [ "name", "tableType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "tableType": { "$ref": "#/components/schemas/WorkflowTableTypeReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "activateFlag": { "type": "boolean", "description": "Batches can not be turned on until after the workflow is created and it has atleast one event associated with it", "nullable": true }, "batchInterval": { "type": "integer", "format": "int32", "nullable": true }, "batchFrequencyUnit": { "enum": [ "Minutes", "Hours", "Days" ], "type": "string", "description": "If not specified, defaults to Minutes. Months is not supported as month length varies", "nullable": true }, "batchLastRan": { "type": "string", "format": "date-time" }, "batchSchedule": { "enum": [ "AnyTime", "MyCompanyOfficeHours", "SlaHours" ], "type": "string", "description": "If activateFlag is true, batchSchedule is required", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "connectWiseID": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowAction": { "required": [ "notifyType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyType": { "$ref": "#/components/schemas/NotifyTypeReference" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "specificMemberTo": { "$ref": "#/components/schemas/MemberReference" }, "emailRecipient": { "type": "string", "description": "Required when notifyWho is set to: \"Email Address\" Max length: 250;" }, "notifyFrom": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "specificMemberFrom": { "$ref": "#/components/schemas/MemberReference" }, "emailFrom": { "type": "string", "description": "Required when notifyFrom is set to: \"Email Address\" Max length: 250;" }, "ccContact": { "$ref": "#/components/schemas/ContactReference" }, "bccContact": { "$ref": "#/components/schemas/ContactReference" }, "subject": { "type": "string", "description": "Required when notifyType is set to: \"Create Activity\", \"Send Email\", \"Assign Resource\" Max length: 100;" }, "notes": { "type": "string" }, "activityStatus": { "$ref": "#/components/schemas/ActivityStatusReference" }, "activityType": { "$ref": "#/components/schemas/ActivityTypeReference" }, "attachedTrack": { "$ref": "#/components/schemas/TrackReference" }, "daysToExecute": { "type": "integer", "format": "int32", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "boardStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "serviceSubType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "serviceItem": { "$ref": "#/components/schemas/ServiceItemReference" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "serviceTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "invoiceMinDays": { "type": "integer", "format": "int32", "nullable": true }, "automateScript": { "$ref": "#/components/schemas/AutomateScriptReference" }, "scriptSuccessStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "scriptFailStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "detailNotesFlag": { "type": "boolean", "nullable": true }, "internalNotesFlag": { "type": "boolean", "nullable": true }, "auditNotesFlag": { "type": "boolean", "nullable": true }, "servicePriority": { "$ref": "#/components/schemas/PriorityReference" }, "updateOwnerFlag": { "type": "boolean", "nullable": true }, "salesOrderStatus": { "$ref": "#/components/schemas/OrderStatusReference" }, "projectStatus": { "$ref": "#/components/schemas/ProjectStatusReference" }, "companyStatus": { "$ref": "#/components/schemas/CompanyStatusReference" }, "attachments": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serviceSurvey": { "$ref": "#/components/schemas/ServiceSurveyReference" }, "specificTeamTo": { "$ref": "#/components/schemas/GenericBoardTeamReference" }, "attachConfigurationsFor": { "enum": [ "Company", "Contact" ], "type": "string", "description": "Required when notifyType is set to: \"Attach Configuration\"", "nullable": true }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "configurationStatus": { "$ref": "#/components/schemas/ConfigurationStatusReference" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyEvents_RecID", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowActionAutomateParameter": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "string" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyActions_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowActionUserDefinedField": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "eventId": { "type": "integer", "format": "int32" }, "actionId": { "type": "integer", "format": "int32" }, "caption": { "type": "string" }, "userDefinedFieldId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "overwriteFlag": { "type": "boolean", "nullable": true }, "podDescription": { "type": "string" }, "fieldTypeId": { "type": "string" }, "entryTypeId": { "type": "string" }, "requiredFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyActions_RecID", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "description": "WF_NotifyEvents_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowAttachment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowEvent": { "required": [ "eventCondition" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "eventCondition": { "type": "string" }, "frequencyUnit": { "enum": [ "Minutes", "Hours", "Days", "Months" ], "type": "string", "description": "Required when exectionTimes is set to MultipleTimes or Continuously", "nullable": true }, "frequencyOfExecution": { "type": "integer", "description": "Required when exectionTimes is set to MultipleTimes or Continuously", "format": "int32", "nullable": true }, "maxNumberOfExecution": { "type": "integer", "description": "Required when exectionTimes is set to MultipleTimes", "format": "int32", "nullable": true }, "executionTime": { "enum": [ "Once", "MultipleTimes", "Continuously" ], "type": "string", "description": "Defaults to Once when not specified", "nullable": true }, "dateTestedUTC": { "type": "string", "format": "date-time" }, "testRecordsMatched": { "type": "integer", "format": "int32", "nullable": true }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowNotifyType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "isSetupFlag": { "type": "boolean", "description": "If the current action is available because it is already set up. Pertains to integrations such as Automate", "nullable": true }, "externalFlag": { "type": "boolean", "description": "If the current action effects external objects e.g. integrations or sending an email", "nullable": true }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowNotifyTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "isSetupFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTableType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "connectWiseID": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTableTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTableTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTrigger": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "hasOptionsFlag": { "type": "boolean", "nullable": true }, "hasOperatorFlag": { "type": "boolean", "nullable": true }, "customField": { "$ref": "#/components/schemas/UserDefinedFieldReference" }, "expectedType": { "type": "string" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTriggerOption": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "customField": { "$ref": "#/components/schemas/UserDefinedFieldReference" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRole": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "addAllLocations": { "type": "boolean", "nullable": true }, "removeAllLocations": { "type": "boolean", "nullable": true }, "addAllAgreementExclusions": { "type": "boolean", "description": "Used only on create to add the work role to all agreement and agreement type exclusion lists", "nullable": true }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRoleExemption": { "required": [ "workRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "taxableLevels": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRoleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRoleLocation": { "required": [ "location" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkType": { "required": [ "name", "billTime", "rateType", "rate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge" ], "type": "string", "nullable": true }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "hoursMin": { "type": "number", "format": "double", "nullable": true }, "hoursMax": { "type": "number", "format": "double", "nullable": true }, "roundBillHoursTo": { "type": "number", "format": "double", "nullable": true }, "accrualType": { "enum": [ "Holiday", "PTO", "Sick", "Vacation" ], "type": "string", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "overallDefaultFlag": { "type": "boolean", "nullable": true }, "activityDefaultFlag": { "type": "boolean", "nullable": true }, "utilizationFlag": { "type": "boolean", "nullable": true }, "costMultiplier": { "type": "number", "format": "double", "nullable": true }, "integrationXRef": { "type": "string", "description": " Max length: 50;" }, "addAllAgreementExclusions": { "type": "boolean", "description": "Used only on create to add the work type to all agreement and agreement type exclusion lists", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "activityDefaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "utilizationFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } } }