openapi: 3.2.0 info: title: Pipeliner Cloud Account API version: '100' servers: - url: https://us-east.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://eu-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ca-central.api.pipelinersales.com/api/v100/rest/spaces/{space_id} - url: https://ap-southeast.api.pipelinersales.com/api/v100/rest/spaces/{space_id} tags: - name: Account paths: /entities/Accounts/{id}: get: description: Returns Account with given id operationId: Accounts.get summary: Accounts.get tags: - Account parameters: - name: id in: path description: ID of Account to retrieve required: true schema: type: string format: uuid responses: '200': description: Account data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Account' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes Account with given id operationId: Accounts.delete summary: Accounts.delete tags: - Account parameters: - name: id in: path description: ID of Account to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Account on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted Account type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies Account or Accounts with given id(s) parameters: - name: id in: path description: ID of Account to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Account on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: Accounts.update summary: Accounts.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountInput' responses: '200': description: Modification confirmation. Returns resulting Account content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Account' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Accounts: get: description: Returns all defined Accounts operationId: Accounts.list summary: Accounts.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted Accounts are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of Accounts content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/Account' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new Account operationId: Accounts.create summary: Accounts.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of Account on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new Account required: true content: application / json: schema: $ref: '#/components/schemas/createAccountInput' responses: '201': description: Creation confirmation. Returns created Account content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Account' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Accounts/merge: post: description: Merger multiple Accounts into master record. operationId: Accounts.merge summary: Accounts.merge tags: - Account parameters: [] requestBody: description: Entity . required: true content: application/json: schema: type: object properties: master: $ref: '#/components/schemas/batchAccountInput' secondary_ids: type: array items: type: string description: An id of secondary Account. format: uuid responses: '200': description: Merged entity content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Account' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Accounts/batch-delete: post: description: Removes Accounts with given list of ids operationId: Accounts.batch_delete summary: Accounts.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of Accounts on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity Account to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted Account. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Accounts/batch-modify: post: description: Create or update an batch of Accounts operationId: Accounts.batch_create_or_update summary: Accounts.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of Accounts on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Account required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Accounts content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Accounts/batch-restore: post: description: Restores Accounts with given list of ids operationId: Accounts.batch_restore summary: Accounts.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of Accounts on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for Accounts. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity Account to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored Account. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountDataExRelations/{id}: get: description: Returns AccountDataExRelation with given id operationId: AccountDataExRelations.get summary: AccountDataExRelations.get tags: - Account parameters: - name: id in: path description: ID of AccountDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountDataExRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountDataExRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountDataExRelations: get: description: Returns all defined AccountDataExRelations operationId: AccountDataExRelations.list summary: AccountDataExRelations.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountDataExRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountDataExRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountDataExRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountKPIs/{id}: get: description: Returns AccountKPI with given id operationId: AccountKPIs.get summary: AccountKPIs.get tags: - Account parameters: - name: id in: path description: ID of AccountKPI to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountKPI data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountKPI' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountKPI with given id operationId: AccountKPIs.delete summary: AccountKPIs.delete tags: - Account parameters: - name: id in: path description: ID of AccountKPI to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountKPI on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountKPI type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountKPI or AccountKPIs with given id(s) parameters: - name: id in: path description: ID of AccountKPI to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountKPI on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountKPIs.update summary: AccountKPIs.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountKPIInput' responses: '200': description: Modification confirmation. Returns resulting AccountKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountKPI' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountKPIs: get: description: Returns all defined AccountKPIs operationId: AccountKPIs.list summary: AccountKPIs.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountKPIs are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountKPIs content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountKPI' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountKPI operationId: AccountKPIs.create summary: AccountKPIs.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountKPI on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountKPI required: true content: application / json: schema: $ref: '#/components/schemas/createAccountKPIInput' responses: '201': description: Creation confirmation. Returns created AccountKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountKPI' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountKPIs/batch-delete: post: description: Removes AccountKPIs with given list of ids operationId: AccountKPIs.batch_delete summary: AccountKPIs.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountKPIs on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountKPI to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountKPIs/batch-modify: post: description: Create or update an batch of AccountKPIs operationId: AccountKPIs.batch_create_or_update summary: AccountKPIs.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountKPIs on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountKPI required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountKPIInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountKPIs content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountKPIs/batch-restore: post: description: Restores AccountKPIs with given list of ids operationId: AccountKPIs.batch_restore summary: AccountKPIs.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountKPIs on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountKPI to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountProductPricings/{id}: get: description: Returns AccountProductPricing with given id operationId: AccountProductPricings.get summary: AccountProductPricings.get tags: - Account parameters: - name: id in: path description: ID of AccountProductPricing to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountProductPricing data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountProductPricing' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountProductPricing with given id operationId: AccountProductPricings.delete summary: AccountProductPricings.delete tags: - Account parameters: - name: id in: path description: ID of AccountProductPricing to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountProductPricing on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountProductPricing type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountProductPricing or AccountProductPricings with given id(s) parameters: - name: id in: path description: ID of AccountProductPricing to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountProductPricing on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountProductPricings.update summary: AccountProductPricings.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountProductPricingInput' responses: '200': description: Modification confirmation. Returns resulting AccountProductPricing content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountProductPricing' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountProductPricings: get: description: Returns all defined AccountProductPricings operationId: AccountProductPricings.list summary: AccountProductPricings.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountProductPricings are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountProductPricings content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountProductPricing' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountProductPricing operationId: AccountProductPricings.create summary: AccountProductPricings.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountProductPricing on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountProductPricing required: true content: application / json: schema: $ref: '#/components/schemas/createAccountProductPricingInput' responses: '201': description: Creation confirmation. Returns created AccountProductPricing content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountProductPricing' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountProductPricings/batch-delete: post: description: Removes AccountProductPricings with given list of ids operationId: AccountProductPricings.batch_delete summary: AccountProductPricings.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountProductPricings on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountProductPricings. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountProductPricing to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountProductPricing. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountProductPricings/batch-modify: post: description: Create or update an batch of AccountProductPricings operationId: AccountProductPricings.batch_create_or_update summary: AccountProductPricings.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountProductPricings on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountProductPricings. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountProductPricing required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountProductPricingInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountProductPricings content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountProductPricings/batch-restore: post: description: Restores AccountProductPricings with given list of ids operationId: AccountProductPricings.batch_restore summary: AccountProductPricings.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountProductPricings on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountProductPricings. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountProductPricing to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountProductPricing. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelations/{id}: get: description: Returns AccountRelation with given id operationId: AccountRelations.get summary: AccountRelations.get tags: - Account parameters: - name: id in: path description: ID of AccountRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountRelation with given id operationId: AccountRelations.delete summary: AccountRelations.delete tags: - Account parameters: - name: id in: path description: ID of AccountRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountRelation or AccountRelations with given id(s) parameters: - name: id in: path description: ID of AccountRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountRelations.update summary: AccountRelations.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting AccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelations: get: description: Returns all defined AccountRelations operationId: AccountRelations.list summary: AccountRelations.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountRelation operationId: AccountRelations.create summary: AccountRelations.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRelationInput' responses: '201': description: Creation confirmation. Returns created AccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelations/batch-delete: post: description: Removes AccountRelations with given list of ids operationId: AccountRelations.batch_delete summary: AccountRelations.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelations/batch-modify: post: description: Create or update an batch of AccountRelations operationId: AccountRelations.batch_create_or_update summary: AccountRelations.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelations/batch-restore: post: description: Restores AccountRelations with given list of ids operationId: AccountRelations.batch_restore summary: AccountRelations.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationLabels/{id}: get: description: Returns AccountRelationLabel with given id operationId: AccountRelationLabels.get summary: AccountRelationLabels.get tags: - Account parameters: - name: id in: path description: ID of AccountRelationLabel to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountRelationLabel data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelationLabel' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountRelationLabel with given id operationId: AccountRelationLabels.delete summary: AccountRelationLabels.delete tags: - Account parameters: - name: id in: path description: ID of AccountRelationLabel to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRelationLabel on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountRelationLabel type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountRelationLabel or AccountRelationLabels with given id(s) parameters: - name: id in: path description: ID of AccountRelationLabel to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRelationLabel on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountRelationLabels.update summary: AccountRelationLabels.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRelationLabelInput' responses: '200': description: Modification confirmation. Returns resulting AccountRelationLabel content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelationLabel' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationLabels: get: description: Returns all defined AccountRelationLabels operationId: AccountRelationLabels.list summary: AccountRelationLabels.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountRelationLabels are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRelationLabels content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountRelationLabel' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountRelationLabel operationId: AccountRelationLabels.create summary: AccountRelationLabels.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationLabel on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountRelationLabel required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRelationLabelInput' responses: '201': description: Creation confirmation. Returns created AccountRelationLabel content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelationLabel' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationLabels/batch-delete: post: description: Removes AccountRelationLabels with given list of ids operationId: AccountRelationLabels.batch_delete summary: AccountRelationLabels.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationLabels on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRelationLabel to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountRelationLabel. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationLabels/batch-modify: post: description: Create or update an batch of AccountRelationLabels operationId: AccountRelationLabels.batch_create_or_update summary: AccountRelationLabels.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationLabels on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountRelationLabel required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountRelationLabelInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountRelationLabels content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationLabels/batch-restore: post: description: Restores AccountRelationLabels with given list of ids operationId: AccountRelationLabels.batch_restore summary: AccountRelationLabels.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationLabels on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelationLabels. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRelationLabel to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountRelationLabel. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationTypes/{id}: get: description: Returns AccountRelationType with given id operationId: AccountRelationTypes.get summary: AccountRelationTypes.get tags: - Account parameters: - name: id in: path description: ID of AccountRelationType to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountRelationType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelationType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountRelationType with given id operationId: AccountRelationTypes.delete summary: AccountRelationTypes.delete tags: - Account parameters: - name: id in: path description: ID of AccountRelationType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRelationType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountRelationType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountRelationType or AccountRelationTypes with given id(s) parameters: - name: id in: path description: ID of AccountRelationType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRelationType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountRelationTypes.update summary: AccountRelationTypes.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRelationTypeInput' responses: '200': description: Modification confirmation. Returns resulting AccountRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelationType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationTypes: get: description: Returns all defined AccountRelationTypes operationId: AccountRelationTypes.list summary: AccountRelationTypes.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountRelationTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRelationTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountRelationType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountRelationType operationId: AccountRelationTypes.create summary: AccountRelationTypes.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRelationTypeInput' responses: '201': description: Creation confirmation. Returns created AccountRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRelationType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationTypes/batch-delete: post: description: Removes AccountRelationTypes with given list of ids operationId: AccountRelationTypes.batch_delete summary: AccountRelationTypes.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRelationType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationTypes/batch-modify: post: description: Create or update an batch of AccountRelationTypes operationId: AccountRelationTypes.batch_create_or_update summary: AccountRelationTypes.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountRelationType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountRelationTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountRelationTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRelationTypes/batch-restore: post: description: Restores AccountRelationTypes with given list of ids operationId: AccountRelationTypes.batch_restore summary: AccountRelationTypes.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRelationType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRoles/{id}: get: description: Returns AccountRole with given id operationId: AccountRoles.get summary: AccountRoles.get tags: - Account parameters: - name: id in: path description: ID of AccountRole to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountRole data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRole' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountRole with given id operationId: AccountRoles.delete summary: AccountRoles.delete tags: - Account parameters: - name: id in: path description: ID of AccountRole to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRole on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountRole type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountRole or AccountRoles with given id(s) parameters: - name: id in: path description: ID of AccountRole to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountRole on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountRoles.update summary: AccountRoles.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountRoleInput' responses: '200': description: Modification confirmation. Returns resulting AccountRole content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRole' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRoles: get: description: Returns all defined AccountRoles operationId: AccountRoles.list summary: AccountRoles.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountRoles are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountRoles content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountRole' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountRole operationId: AccountRoles.create summary: AccountRoles.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRole on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountRole required: true content: application / json: schema: $ref: '#/components/schemas/createAccountRoleInput' responses: '201': description: Creation confirmation. Returns created AccountRole content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountRole' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRoles/batch-delete: post: description: Removes AccountRoles with given list of ids operationId: AccountRoles.batch_delete summary: AccountRoles.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRoles on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRole to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountRole. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRoles/batch-modify: post: description: Create or update an batch of AccountRoles operationId: AccountRoles.batch_create_or_update summary: AccountRoles.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRoles on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountRole required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountRoleInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountRoles content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountRoles/batch-restore: post: description: Restores AccountRoles with given list of ids operationId: AccountRoles.batch_restore summary: AccountRoles.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountRoles on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountRoles. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountRole to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountRole. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingClientRelations/{id}: get: description: Returns AccountSharingClientRelation with given id operationId: AccountSharingClientRelations.get summary: AccountSharingClientRelations.get tags: - Account parameters: - name: id in: path description: ID of AccountSharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountSharingClientRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountSharingClientRelation with given id operationId: AccountSharingClientRelations.delete summary: AccountSharingClientRelations.delete tags: - Account parameters: - name: id in: path description: ID of AccountSharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountSharingClientRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountSharingClientRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountSharingClientRelation or AccountSharingClientRelations with given id(s) parameters: - name: id in: path description: ID of AccountSharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountSharingClientRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountSharingClientRelations.update summary: AccountSharingClientRelations.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountSharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting AccountSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSharingClientRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingClientRelations: get: description: Returns all defined AccountSharingClientRelations operationId: AccountSharingClientRelations.list summary: AccountSharingClientRelations.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountSharingClientRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountSharingClientRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountSharingClientRelation operationId: AccountSharingClientRelations.create summary: AccountSharingClientRelations.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingClientRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created AccountSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingClientRelations/batch-delete: post: description: Removes AccountSharingClientRelations with given list of ids operationId: AccountSharingClientRelations.batch_delete summary: AccountSharingClientRelations.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingClientRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountSharingClientRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingClientRelations/batch-modify: post: description: Create or update an batch of AccountSharingClientRelations operationId: AccountSharingClientRelations.batch_create_or_update summary: AccountSharingClientRelations.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingClientRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountSharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountSharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountSharingClientRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingClientRelations/batch-restore: post: description: Restores AccountSharingClientRelations with given list of ids operationId: AccountSharingClientRelations.batch_restore summary: AccountSharingClientRelations.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingClientRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountSharingClientRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingSalesUnitRelations/{id}: get: description: Returns AccountSharingSalesUnitRelation with given id operationId: AccountSharingSalesUnitRelations.get summary: AccountSharingSalesUnitRelations.get tags: - Account parameters: - name: id in: path description: ID of AccountSharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountSharingSalesUnitRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountSharingSalesUnitRelation with given id operationId: AccountSharingSalesUnitRelations.delete summary: AccountSharingSalesUnitRelations.delete tags: - Account parameters: - name: id in: path description: ID of AccountSharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountSharingSalesUnitRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountSharingSalesUnitRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountSharingSalesUnitRelation or AccountSharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of AccountSharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountSharingSalesUnitRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountSharingSalesUnitRelations.update summary: AccountSharingSalesUnitRelations.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountSharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting AccountSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingSalesUnitRelations: get: description: Returns all defined AccountSharingSalesUnitRelations operationId: AccountSharingSalesUnitRelations.list summary: AccountSharingSalesUnitRelations.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountSharingSalesUnitRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountSharingSalesUnitRelation operationId: AccountSharingSalesUnitRelations.create summary: AccountSharingSalesUnitRelations.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingSalesUnitRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created AccountSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingSalesUnitRelations/batch-delete: post: description: Removes AccountSharingSalesUnitRelations with given list of ids operationId: AccountSharingSalesUnitRelations.batch_delete summary: AccountSharingSalesUnitRelations.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingSalesUnitRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountSharingSalesUnitRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of AccountSharingSalesUnitRelations operationId: AccountSharingSalesUnitRelations.batch_create_or_update summary: AccountSharingSalesUnitRelations.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingSalesUnitRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountSharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountSharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountSharingSalesUnitRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSharingSalesUnitRelations/batch-restore: post: description: Restores AccountSharingSalesUnitRelations with given list of ids operationId: AccountSharingSalesUnitRelations.batch_restore summary: AccountSharingSalesUnitRelations.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSharingSalesUnitRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountSharingSalesUnitRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSocialRelations/{id}: get: description: Returns AccountSocialRelation with given id operationId: AccountSocialRelations.get summary: AccountSocialRelations.get tags: - Account parameters: - name: id in: path description: ID of AccountSocialRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountSocialRelation data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSocialRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountSocialRelation with given id operationId: AccountSocialRelations.delete summary: AccountSocialRelations.delete tags: - Account parameters: - name: id in: path description: ID of AccountSocialRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountSocialRelation on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountSocialRelation type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountSocialRelation or AccountSocialRelations with given id(s) parameters: - name: id in: path description: ID of AccountSocialRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountSocialRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountSocialRelations.update summary: AccountSocialRelations.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountSocialRelationInput' responses: '200': description: Modification confirmation. Returns resulting AccountSocialRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSocialRelation' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSocialRelations: get: description: Returns all defined AccountSocialRelations operationId: AccountSocialRelations.list summary: AccountSocialRelations.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountSocialRelations are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountSocialRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountSocialRelation' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountSocialRelation operationId: AccountSocialRelations.create summary: AccountSocialRelations.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSocialRelation on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountSocialRelation required: true content: application / json: schema: $ref: '#/components/schemas/createAccountSocialRelationInput' responses: '201': description: Creation confirmation. Returns created AccountSocialRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountSocialRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSocialRelations/batch-delete: post: description: Removes AccountSocialRelations with given list of ids operationId: AccountSocialRelations.batch_delete summary: AccountSocialRelations.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSocialRelations on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountSocialRelation to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountSocialRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSocialRelations/batch-modify: post: description: Create or update an batch of AccountSocialRelations operationId: AccountSocialRelations.batch_create_or_update summary: AccountSocialRelations.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSocialRelations on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountSocialRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountSocialRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountSocialRelations content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountSocialRelations/batch-restore: post: description: Restores AccountSocialRelations with given list of ids operationId: AccountSocialRelations.batch_restore summary: AccountSocialRelations.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountSocialRelations on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountSocialRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountSocialRelation to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountSocialRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountTypes/{id}: get: description: Returns AccountType with given id operationId: AccountTypes.get summary: AccountTypes.get tags: - Account parameters: - name: id in: path description: ID of AccountType to retrieve required: true schema: type: string format: uuid responses: '200': description: AccountType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes AccountType with given id operationId: AccountTypes.delete summary: AccountTypes.delete tags: - Account parameters: - name: id in: path description: ID of AccountType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted AccountType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies AccountType or AccountTypes with given id(s) parameters: - name: id in: path description: ID of AccountType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of AccountType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: AccountTypes.update summary: AccountTypes.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateAccountTypeInput' responses: '200': description: Modification confirmation. Returns resulting AccountType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountTypes: get: description: Returns all defined AccountTypes operationId: AccountTypes.list summary: AccountTypes.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted AccountTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of AccountTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/AccountType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new AccountType operationId: AccountTypes.create summary: AccountTypes.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new AccountType required: true content: application / json: schema: $ref: '#/components/schemas/createAccountTypeInput' responses: '201': description: Creation confirmation. Returns created AccountType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/AccountType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountTypes/batch-delete: post: description: Removes AccountTypes with given list of ids operationId: AccountTypes.batch_delete summary: AccountTypes.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted AccountType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountTypes/batch-modify: post: description: Create or update an batch of AccountTypes operationId: AccountTypes.batch_create_or_update summary: AccountTypes.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new AccountType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchAccountTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated AccountTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/AccountTypes/batch-restore: post: description: Restores AccountTypes with given list of ids operationId: AccountTypes.batch_restore summary: AccountTypes.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of AccountTypes on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for AccountTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity AccountType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored AccountType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EntityHealths/{id}: get: description: Returns EntityHealth with given id operationId: EntityHealths.get summary: EntityHealths.get tags: - Account parameters: - name: id in: path description: ID of EntityHealth to retrieve required: true schema: type: string format: uuid responses: '200': description: EntityHealth data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EntityHealth' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes EntityHealth with given id operationId: EntityHealths.delete summary: EntityHealths.delete tags: - Account parameters: - name: id in: path description: ID of EntityHealth to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EntityHealth on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted EntityHealth type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies EntityHealth or EntityHealths with given id(s) parameters: - name: id in: path description: ID of EntityHealth to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of EntityHealth on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: EntityHealths.update summary: EntityHealths.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateEntityHealthInput' responses: '200': description: Modification confirmation. Returns resulting EntityHealth content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EntityHealth' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EntityHealths: get: description: Returns all defined EntityHealths operationId: EntityHealths.list summary: EntityHealths.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted EntityHealths are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of EntityHealths content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/EntityHealth' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new EntityHealth operationId: EntityHealths.create summary: EntityHealths.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of EntityHealth on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new EntityHealth required: true content: application / json: schema: $ref: '#/components/schemas/createEntityHealthInput' responses: '201': description: Creation confirmation. Returns created EntityHealth content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/EntityHealth' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EntityHealths/batch-delete: post: description: Removes EntityHealths with given list of ids operationId: EntityHealths.batch_delete summary: EntityHealths.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of EntityHealths on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity EntityHealth to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted EntityHealth. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EntityHealths/batch-modify: post: description: Create or update an batch of EntityHealths operationId: EntityHealths.batch_create_or_update summary: EntityHealths.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of EntityHealths on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new EntityHealth required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchEntityHealthInput' responses: '200': description: Creation confirmation. Returns a list of created / updated EntityHealths content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/EntityHealths/batch-restore: post: description: Restores EntityHealths with given list of ids operationId: EntityHealths.batch_restore summary: EntityHealths.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of EntityHealths on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for EntityHealths. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity EntityHealth to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored EntityHealth. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ParentAccountRelationTypes/{id}: get: description: Returns ParentAccountRelationType with given id operationId: ParentAccountRelationTypes.get summary: ParentAccountRelationTypes.get tags: - Account parameters: - name: id in: path description: ID of ParentAccountRelationType to retrieve required: true schema: type: string format: uuid responses: '200': description: ParentAccountRelationType data content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ParentAccountRelationType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' delete: description: Removes ParentAccountRelationType with given id operationId: ParentAccountRelationTypes.delete summary: ParentAccountRelationTypes.delete tags: - Account parameters: - name: id in: path description: ID of ParentAccountRelationType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ParentAccountRelationType on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 responses: '200': description: Removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: description: id of deleted ParentAccountRelationType type: string format: uuid '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' patch: description: Modifies ParentAccountRelationType or ParentAccountRelationTypes with given id(s) parameters: - name: id in: path description: ID of ParentAccountRelationType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of ParentAccountRelationType on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 operationId: ParentAccountRelationTypes.update summary: ParentAccountRelationTypes.update tags: - Account requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateParentAccountRelationTypeInput' responses: '200': description: Modification confirmation. Returns resulting ParentAccountRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ParentAccountRelationType' '404': description: Sent when invalid ID is given content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ParentAccountRelationTypes: get: description: Returns all defined ParentAccountRelationTypes operationId: ParentAccountRelationTypes.list summary: ParentAccountRelationTypes.list tags: - Account parameters: - name: include-deleted in: query description: if enabled, deleted ParentAccountRelationTypes are returned as well required: false schema: type: boolean - name: first in: query description: 'Number of entities to return from beginning of the result set. Max: 100. Default: 30' required: false schema: type: integer format: int32 - name: last in: query description: Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records. required: false schema: type: integer format: int32 - name: before in: query description: Cursor until which to take entities to result set. required: false schema: type: string - name: after in: query description: Cursor after which to start taking entities to result set. required: false schema: type: string - name: expand in: query description: Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well. required: false example: expand=owner,sales_unit,account_relations.account schema: type: string - name: order-by in: query description: Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon. example: order-by=created,-modified required: false schema: type: string - name: filter in: query description: Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter. example: filter[name]=Example required: false schema: type: object style: deepObject allowReserved: true - name: filter-op in: query description: 'Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].' example: filter-op[name]=eq required: false schema: type: object style: deepObject allowReserved: true - name: load-only in: query description: Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well. required: false example: load-only=id,name,owner.id schema: type: string responses: '200': description: list of ParentAccountRelationTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: $ref: '#/components/schemas/ParentAccountRelationType' page_info: type: object properties: start_cursor: type: string example: WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ== description: Start cursor of result set. end_cursor: type: string example: WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ== description: End cursor of result set. has_previous_page: type: boolean example: true description: If result set has previous page (if yes, use start_cursor value in before parameter to load it). has_next_page: type: boolean example: true description: If result set has next page (if yes, use end_cursor value in after parameter to load it). description: Page info result set. Please note it is returned only when legacy limit & offset parameters are not used. '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' post: description: Creates new ParentAccountRelationType operationId: ParentAccountRelationTypes.create summary: ParentAccountRelationTypes.create tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of ParentAccountRelationType on create. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 requestBody: description: data of new ParentAccountRelationType required: true content: application / json: schema: $ref: '#/components/schemas/createParentAccountRelationTypeInput' responses: '201': description: Creation confirmation. Returns created ParentAccountRelationType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/ParentAccountRelationType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ParentAccountRelationTypes/batch-delete: post: description: Removes ParentAccountRelationTypes with given list of ids operationId: ParentAccountRelationTypes.batch_delete summary: ParentAccountRelationTypes.batch_delete tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of ParentAccountRelationTypes on delete. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to delete. required: true content: application / json: schema: type: array items: type: string description: An id of entity ParentAccountRelationType to delete. format: uuid responses: '200': description: Batch removal confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of deleted ParentAccountRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ParentAccountRelationTypes/batch-modify: post: description: Create or update an batch of ParentAccountRelationTypes operationId: ParentAccountRelationTypes.batch_create_or_update summary: ParentAccountRelationTypes.batch_create_or_update tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of ParentAccountRelationTypes on change. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new ParentAccountRelationType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchParentAccountRelationTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated ParentAccountRelationTypes content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/ParentAccountRelationTypes/batch-restore: post: description: Restores ParentAccountRelationTypes with given list of ids operationId: ParentAccountRelationTypes.batch_restore summary: ParentAccountRelationTypes.batch_restore tags: - Account parameters: - name: validation-level in: query description: 'Specify validation level of ParentAccountRelationTypes on restore. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.' schema: type: integer format: int32 - name: rollback-method in: query description: Specify rollback method for ParentAccountRelationTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: List of ids to restore. required: true content: application / json: schema: type: array items: type: string description: An id of entity ParentAccountRelationType to restore. format: uuid responses: '200': description: Batch restoration confirmation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: An id of restored ParentAccountRelationType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: batchAccountInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. picture: type: object properties: id: type: string format: uri description: 'Profile picture or company logo associated with the account. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' account_class: type: integer description: 'Manual classification grade assigned to the account. Used in segmentation and reporting. Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD' example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type assigned to this account. address: type: string example: string description: Street address of the account. city: type: string example: string description: City of the account address. comments: type: string example: string description: Free-form notes describing the account. country: type: string example: string description: Country of the account address. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this account. customer_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the customer type. email1: type: string example: string description: Primary email address of the account. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. home_page: type: string example: string description: Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. industry_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the industry classification. is_archived: type: boolean example: false description: True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. last_ai_account_hierarchy_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested account hierarchy was last applied to this account. last_ai_org_chart_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested org chart was last applied to this account. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner. parent_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent account. parent_account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent-account relationship type. phone1: type: string example: string description: Primary phone number of the account. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. quick_parent_account_name: type: string example: string description: Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 state_province: type: string example: string description: State or province of the account address. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the account address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. social_media: type: object properties: id: type: string format: uri description: 'Social network profiles linked to this account (e.g. LinkedIn, Facebook). Relation to AccountSocialRelation, see: ''updateAccountSocialRelationInput'' object for properties.' sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to AccountSharingSalesUnitRelation, see: ''updateAccountSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to AccountSharingClientRelation, see: ''updateAccountSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this account. Editable only when share_mode allows user sharing. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this account. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this account currently matches. id: description: ID of object to update. type: string format: uuid AccountDataExRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account this data relation row belongs to. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' data: type: string format: uri description: 'Data record holding the additional fields linked to the account. Relation to Data. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Data'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the data set the linked fields belong to. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - data - account_id - data_id - data_set_id createAccountSharingSalesUnitRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_id - unit_id AccountRelationLabel: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_relation: type: string format: uri description: 'Account relationship being labelled. Relation to AccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountRelation'' object for properties.' account_relation_type: type: string format: uri description: 'Type of the relationship (e.g. partner, supplier). Relation to AccountRelationType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountRelationType'' object for properties.' account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account relationship. account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account_relation - account_relation_type - account_relation_id - account_relation_type_id createAccountSocialRelationInput: properties: id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with Account id. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true angellist_url: type: string example: string description: AngelList profile URL of the account. crunchbase_url: type: string example: string description: Crunchbase profile URL of the account. disqus_url: type: string example: string description: Disqus profile URL of the account. facebook_id: type: string example: string description: Facebook page or profile id of the account. facebook_url: type: string example: string description: Facebook profile URL of the account. flickr_url: type: string example: string description: Flickr profile URL of the account. foursquare_url: type: string example: string description: Foursquare profile URL of the account. google_id: type: string example: string description: Google business or profile id of the account. google_plus_url: type: string example: string description: Google+ profile URL of the account. gravatar_url: type: string example: string description: Gravatar profile URL of the account. klout_url: type: string example: string description: Klout profile URL of the account. linkedin_id: type: string example: string description: LinkedIn company or profile id of the account. linkedin_url: type: string example: string description: LinkedIn profile URL of the account. pinterest_url: type: string example: string description: Pinterest profile URL of the account. quora_url: type: string example: string description: Quora profile URL of the account. reddit_url: type: string example: string description: Reddit profile URL of the account. skype_url: type: string example: string description: Skype contact URL or username of the account. slideshare_url: type: string example: string description: SlideShare profile URL of the account. twitter_id: type: string example: string description: Twitter (X) user id of the account. twitter_url: type: string example: string description: Twitter (X) profile URL of the account. vimeo_url: type: string example: string description: Vimeo profile URL of the account. wordpress_url: type: string example: string description: WordPress site URL of the account. xing_url: type: string example: string description: XING profile URL of the account. yahoo_url: type: string example: string description: Yahoo profile URL of the account. yelp_url: type: string example: string description: Yelp business URL of the account. youtube_url: type: string example: string description: YouTube channel URL of the account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - id createEntityHealthInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true is_enabled: type: boolean example: false description: When false, health is configured but not evaluated for records of this type. last_recalculation: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the last full health recalculation across all matching records. type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_enabled - type_id batchEntityHealthInput: properties: is_enabled: type: boolean example: false description: When false, health is configured but not evaluated for records of this type. last_recalculation: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the last full health recalculation across all matching records. type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. settings: type: string format: binary example: blob description: 'Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry.' id: description: ID of object to update. type: string format: uuid createAccountRelationLabelInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_relation: type: object properties: id: type: string format: uri description: 'Account relationship being labelled. Relation to AccountRelation, see: ''createAccountRelationInput'' object for properties.' account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account relationship. account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_relation - account_relation_id - account_relation_type_id updateAccountTypeInput: properties: form_edit: type: object description: JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the account type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. Account: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. account_type: type: string format: uri description: 'Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. Relation to AccountType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountType'' object for properties.' currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CurrencyExchangeRatesList'' object for properties.' customer_type: type: string format: uri description: 'Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. Relation to Data. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Data'' object for properties.' industry: type: string format: uri description: 'Industry the account operates in. Configurable per team space. Relation to Data. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Data'' object for properties.' owner: type: string format: uri description: 'Sales user who owns this account. Relation to Client. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Client'' object for properties.' parent_account: type: string format: uri description: 'Parent account in a corporate hierarchy. Empty for top-level accounts. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' parent_account_relation_type: type: string format: uri description: 'Type of relationship to the parent account (e.g. subsidiary, branch). Required when parent_account is set. Relation to ParentAccountRelationType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ParentAccountRelationType'' object for properties.' picture: type: string format: uri description: 'Profile picture or company logo associated with the account. Relation to CloudObject. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObject'' object for properties.' unit: type: string format: uri description: 'Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''SalesUnit'' object for properties.' account_class: type: integer description: 'Manual classification grade assigned to the account. Used in segmentation and reporting. Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD' example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type assigned to this account. address: type: string example: string description: Street address of the account. city: type: string example: string description: City of the account address. comments: type: string example: string description: Free-form notes describing the account. country: type: string example: string description: Country of the account address. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this account. customer_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the customer type. email1: type: string example: string description: Primary email address of the account. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. health_category: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Coarser bucket of health_status used for grouping and reporting. Read-only. health_status: type: integer format: int32 example: 1 description: Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. home_page: type: string example: string description: Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. industry_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the industry classification. is_archived: type: boolean example: false description: True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. last_ai_account_hierarchy_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested account hierarchy was last applied to this account. last_ai_org_chart_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested org chart was last applied to this account. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner. parent_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent account. parent_account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent-account relationship type. phone1: type: string example: string description: Primary phone number of the account. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. quick_parent_account_name: type: string example: string description: Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 state_province: type: string example: string description: State or province of the account address. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the account address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. formatted_name: type: string example: string description: Display version of the account name, used in lists and references. social_media: type: string format: uri description: 'Social network profiles linked to this account (e.g. LinkedIn, Facebook). Relation to AccountSocialRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountSocialRelation'' object for properties.' sharing_units: type: array items: type: string format: uri description: 'Relation to AccountSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountSharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: string format: uri description: 'Relation to AccountSharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountSharingClientRelation'' object for properties.' description: Users that have been granted shared access to this account. Editable only when share_mode allows user sharing. documents: type: array items: type: string format: uri description: 'Relation to CloudObjectRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''CloudObjectRelation'' object for properties.' description: Documents linked to this account. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this account as favorite. Per-user. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. tags: type: array items: type: string format: uri description: 'Relation to TagRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''TagRelation'' object for properties.' description: Tag labels applied to this account. static_profiles: type: array items: type: string format: uri description: 'Relation to ProfileRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProfileRelation'' object for properties.' description: Saved view profiles this account currently matches. health: type: object description: Composite entity-health summary, combining current and previous state with last-calculation metadata. Read-only; computed by Coevera. modified_by_user: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. required: - is_delete_protected - id - account_type - owner - unit - name - owner_id - formatted_name - is_favorite Error: properties: http_status: description: HTTP status code type: integer example: 400 code: description: Internal API error code type: integer example: 117 name: description: Name of the API error type: string example: ERROR_PARAMETER_INVALID message: description: Description of the API error type: string success: description: Always false on error. type: boolean example: false required: - success - http_status batchAccountProductPricingInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency. price: type: number format: double example: '4.32' description: Price applied for this product when sold to this account, in the specified currency. product_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid AccountRelationType: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the account-to-account relationship type (e.g. Partner, Supplier). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - color updateAccountRelationInput: properties: account1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related account. account2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateAccountSharingClientRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateAccountProductPricingInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency. price: type: number format: double example: '4.32' description: Price applied for this product when sold to this account, in the specified currency. product_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. AccountKPI: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account this KPI event relates to. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' client: type: string format: uri description: 'User who triggered the KPI event (e.g. created or archived the account, sent the first email). Relation to Client. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Client'' object for properties.' owner: type: string format: uri description: 'Account owner at the time the KPI event occurred. Relation to Client. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Client'' object for properties.' unit: type: string format: uri description: 'Sales unit the triggering user belonged to at the time of the event. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''SalesUnit'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - owner - account_id - kpi - owner_id updateEntityHealthInput: properties: is_enabled: type: boolean example: false description: When false, health is configured but not evaluated for records of this type. last_recalculation: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the last full health recalculation across all matching records. type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. settings: type: string format: binary example: blob description: 'Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry.' ParentAccountRelationType: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true child_label: type: string example: string description: Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). parent_label: type: string example: string description: Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - child_label - parent_label createAccountTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the account type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_readonly - name - settings createAccountRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related account. account2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account1_id - account2_id batchAccountRoleInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid EntityHealth: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true type: type: string format: uri description: 'Account type this health configuration applies to. Relation to AccountType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''AccountType'' object for properties.' entity_type: type: integer description: 'Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product' example: 1 enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 is_enabled: type: boolean example: false description: When false, health is configured but not evaluated for records of this type. last_recalculation: type: string format: date-time example: '2019-01-01T00:00:00' description: Timestamp of the last full health recalculation across all matching records. type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. settings: type: string format: binary example: blob description: 'Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry.' calculation_progress: type: integer format: int32 example: 1 description: Progress of the in-flight health recalculation as a percentage (0-100). Null when no recalculation has been queued. required: - is_delete_protected - id - type - entity_type - is_enabled - type_id - settings AccountProductPricing: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account that this price override applies to. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' currency: type: string format: uri description: 'Currency of the override price. Relation to Currency. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Currency'' object for properties.' product: type: string format: uri description: 'Product whose price is overridden for this account. Relation to Product. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Product'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency. price: type: number format: double example: '4.32' description: Price applied for this product when sold to this account, in the specified currency. product_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - currency - product - account_id - currency_id - product_id createAccountSharingClientRelationInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_id - client_id createAccountKPIInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_id - kpi - owner_id AccountRole: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - color - label updateAccountInput: properties: created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. picture: type: object properties: id: type: string format: uri description: 'Profile picture or company logo associated with the account. Relation to CloudObject, see: ''updateCloudObjectInput'' object for properties.' account_class: type: integer description: 'Manual classification grade assigned to the account. Used in segmentation and reporting. Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD' example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type assigned to this account. address: type: string example: string description: Street address of the account. city: type: string example: string description: City of the account address. comments: type: string example: string description: Free-form notes describing the account. country: type: string example: string description: Country of the account address. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this account. customer_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the customer type. email1: type: string example: string description: Primary email address of the account. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. home_page: type: string example: string description: Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. industry_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the industry classification. is_archived: type: boolean example: false description: True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. last_ai_account_hierarchy_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested account hierarchy was last applied to this account. last_ai_org_chart_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested org chart was last applied to this account. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner. parent_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent account. parent_account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent-account relationship type. phone1: type: string example: string description: Primary phone number of the account. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. quick_parent_account_name: type: string example: string description: Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 state_province: type: string example: string description: State or province of the account address. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the account address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. social_media: type: object properties: id: type: string format: uri description: 'Social network profiles linked to this account (e.g. LinkedIn, Facebook). Relation to AccountSocialRelation, see: ''updateAccountSocialRelationInput'' object for properties.' sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to AccountSharingSalesUnitRelation, see: ''updateAccountSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to AccountSharingClientRelation, see: ''updateAccountSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this account. Editable only when share_mode allows user sharing. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''updateCloudObjectRelationInput'' object for properties.' description: Documents linked to this account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''updateTagRelationInput'' object for properties.' description: Tag labels applied to this account. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''updateProfileRelationInput'' object for properties.' description: Saved view profiles this account currently matches. updateAccountSocialRelationInput: properties: angellist_url: type: string example: string description: AngelList profile URL of the account. crunchbase_url: type: string example: string description: Crunchbase profile URL of the account. disqus_url: type: string example: string description: Disqus profile URL of the account. facebook_id: type: string example: string description: Facebook page or profile id of the account. facebook_url: type: string example: string description: Facebook profile URL of the account. flickr_url: type: string example: string description: Flickr profile URL of the account. foursquare_url: type: string example: string description: Foursquare profile URL of the account. google_id: type: string example: string description: Google business or profile id of the account. google_plus_url: type: string example: string description: Google+ profile URL of the account. gravatar_url: type: string example: string description: Gravatar profile URL of the account. klout_url: type: string example: string description: Klout profile URL of the account. linkedin_id: type: string example: string description: LinkedIn company or profile id of the account. linkedin_url: type: string example: string description: LinkedIn profile URL of the account. pinterest_url: type: string example: string description: Pinterest profile URL of the account. quora_url: type: string example: string description: Quora profile URL of the account. reddit_url: type: string example: string description: Reddit profile URL of the account. skype_url: type: string example: string description: Skype contact URL or username of the account. slideshare_url: type: string example: string description: SlideShare profile URL of the account. twitter_id: type: string example: string description: Twitter (X) user id of the account. twitter_url: type: string example: string description: Twitter (X) profile URL of the account. vimeo_url: type: string example: string description: Vimeo profile URL of the account. wordpress_url: type: string example: string description: WordPress site URL of the account. xing_url: type: string example: string description: XING profile URL of the account. yahoo_url: type: string example: string description: Yahoo profile URL of the account. yelp_url: type: string example: string description: Yelp business URL of the account. youtube_url: type: string example: string description: YouTube channel URL of the account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. createParentAccountRelationTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true child_label: type: string example: string description: Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). parent_label: type: string example: string description: Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - child_label - parent_label batchAccountRelationTypeInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the account-to-account relationship type (e.g. Partner, Supplier). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchAccountSharingSalesUnitRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchAccountRelationLabelInput: properties: account_relation: type: object properties: id: type: string format: uri description: 'Account relationship being labelled. Relation to AccountRelation, see: ''updateAccountRelationInput'' object for properties.' account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account relationship. account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchAccountSharingClientRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid createAccountInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. picture: type: object properties: id: type: string format: uri description: 'Profile picture or company logo associated with the account. Relation to CloudObject, see: ''createCloudObjectInput'' object for properties.' account_class: type: integer description: 'Manual classification grade assigned to the account. Used in segmentation and reporting. Integer enum value: 1 - NoClass, 2 - ClassA, 3 - ClassB, 4 - ClassC, 5 - ClassD' example: 1 enum: - 1 - 2 - 3 - 4 - 5 account_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account type assigned to this account. address: type: string example: string description: Street address of the account. city: type: string example: string description: City of the account address. comments: type: string example: string description: Free-form notes describing the account. country: type: string example: string description: Country of the account address. currency_exchange_rates_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency exchange rate list applied to this account. customer_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the customer type. email1: type: string example: string description: Primary email address of the account. Used as default recipient for emails sent from Coevera. email2: type: string example: string description: Additional email address. email3: type: string example: string description: Additional email address. email4: type: string example: string description: Additional email address. email5: type: string example: string description: Additional email address. home_page: type: string example: string description: Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. industry_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the industry classification. is_archived: type: boolean example: false description: True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. last_ai_account_hierarchy_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested account hierarchy was last applied to this account. last_ai_org_chart_applied: type: string format: date-time example: '2019-01-01T00:00:00' description: Time when an AI-suggested org chart was last applied to this account. name: type: string example: string description: Name of the entity and its default text representation. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner. parent_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent account. parent_account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the parent-account relationship type. phone1: type: string example: string description: Primary phone number of the account. Used as default target for click-to-call. phone2: type: string example: string description: Additional phone number. phone3: type: string example: string description: Additional phone number. phone4: type: string example: string description: Additional phone number. phone5: type: string example: string description: Additional phone number. picture_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the profile picture document. quick_parent_account_name: type: string example: string description: Free-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account. share_mode: type: integer description: 'Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit' example: 0 enum: - 0 - 1 - 2 - 3 state_province: type: string example: string description: State or province of the account address. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. zip_code: type: string example: string description: ZIP or postal code of the account address. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. social_media: type: object properties: id: type: string format: uri description: 'Social network profiles linked to this account (e.g. LinkedIn, Facebook). Relation to AccountSocialRelation, see: ''createAccountSocialRelationInput'' object for properties.' sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to AccountSharingSalesUnitRelation, see: ''createAccountSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this account. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to AccountSharingClientRelation, see: ''createAccountSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this account. Editable only when share_mode allows user sharing. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectRelation, see: ''createCloudObjectRelationInput'' object for properties.' description: Documents linked to this account. is_unsubscribed: type: boolean example: false description: If account has any unsubscribed email. tags: type: array items: type: object properties: id: type: string format: uri description: 'Relation to TagRelation, see: ''createTagRelationInput'' object for properties.' description: Tag labels applied to this account. static_profiles: type: array items: type: object properties: id: type: string format: uri description: 'Relation to ProfileRelation, see: ''createProfileRelationInput'' object for properties.' description: Saved view profiles this account currently matches. required: - name - owner_id createAccountProductPricingInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the currency. price: type: number format: double example: '4.32' description: Price applied for this product when sold to this account, in the specified currency. product_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_id - currency_id - product_id batchAccountTypeInput: properties: form_edit: type: object description: JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the account type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid AccountSharingClientRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account being shared. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' client: type: string format: uri description: 'User the account is shared with. Relation to Client. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Client'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - client - account_id - client_id batchParentAccountRelationTypeInput: properties: child_label: type: string example: string description: Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). parent_label: type: string example: string description: Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid AccountType: properties: has_draft: type: boolean example: false description: Set to True if draft for entity exists and can be published is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true form_edit_api: type: object description: API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts. can_change_readonly: type: boolean example: false description: Returns if user can change readonly flag on this entity_type. id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true form_edit: type: object description: JSON definition of the edit form layout used by the UI when creating or editing accounts of this type. Contains tabs, sections, and field placement. is_readonly: type: boolean example: false description: True when the account type is system-managed and cannot be edited or deleted by users. name: type: string example: string description: Name of the entity and its default text representation. settings: type: string format: binary example: blob description: Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type. is_published: type: boolean example: false description: True when the entity configuration is published; false while it exists only as an unpublished draft. readOnly: true revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - has_draft - is_delete_protected - form_edit_api - id - is_readonly - name - settings createAccountRoleInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - color - label createAccountRelationTypeInput: properties: modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true color: type: integer format: int32 example: 1 description: 'Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the account-to-account relationship type (e.g. Partner, Supplier). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - color updateAccountSharingSalesUnitRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateAccountRoleInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the role label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Name of the entity and its default text representation. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. AccountRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account1: type: string format: uri description: 'One side of the account-to-account relationship. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' account2: type: string format: uri description: 'Other side of the account-to-account relationship. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' account1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related account. account2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account1 - account2 - account1_id - account2_id AccountSocialRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. Must match with Account id. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true angellist_url: type: string example: string description: AngelList profile URL of the account. crunchbase_url: type: string example: string description: Crunchbase profile URL of the account. disqus_url: type: string example: string description: Disqus profile URL of the account. facebook_id: type: string example: string description: Facebook page or profile id of the account. facebook_url: type: string example: string description: Facebook profile URL of the account. flickr_url: type: string example: string description: Flickr profile URL of the account. foursquare_url: type: string example: string description: Foursquare profile URL of the account. google_id: type: string example: string description: Google business or profile id of the account. google_plus_url: type: string example: string description: Google+ profile URL of the account. gravatar_url: type: string example: string description: Gravatar profile URL of the account. klout_url: type: string example: string description: Klout profile URL of the account. linkedin_id: type: string example: string description: LinkedIn company or profile id of the account. linkedin_url: type: string example: string description: LinkedIn profile URL of the account. pinterest_url: type: string example: string description: Pinterest profile URL of the account. quora_url: type: string example: string description: Quora profile URL of the account. reddit_url: type: string example: string description: Reddit profile URL of the account. skype_url: type: string example: string description: Skype contact URL or username of the account. slideshare_url: type: string example: string description: SlideShare profile URL of the account. twitter_id: type: string example: string description: Twitter (X) user id of the account. twitter_url: type: string example: string description: Twitter (X) profile URL of the account. vimeo_url: type: string example: string description: Vimeo profile URL of the account. wordpress_url: type: string example: string description: WordPress site URL of the account. xing_url: type: string example: string description: XING profile URL of the account. yahoo_url: type: string example: string description: Yahoo profile URL of the account. yelp_url: type: string example: string description: Yelp business URL of the account. youtube_url: type: string example: string description: YouTube channel URL of the account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id batchAccountKPIInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid batchAccountSocialRelationInput: properties: angellist_url: type: string example: string description: AngelList profile URL of the account. crunchbase_url: type: string example: string description: Crunchbase profile URL of the account. disqus_url: type: string example: string description: Disqus profile URL of the account. facebook_id: type: string example: string description: Facebook page or profile id of the account. facebook_url: type: string example: string description: Facebook profile URL of the account. flickr_url: type: string example: string description: Flickr profile URL of the account. foursquare_url: type: string example: string description: Foursquare profile URL of the account. google_id: type: string example: string description: Google business or profile id of the account. google_plus_url: type: string example: string description: Google+ profile URL of the account. gravatar_url: type: string example: string description: Gravatar profile URL of the account. klout_url: type: string example: string description: Klout profile URL of the account. linkedin_id: type: string example: string description: LinkedIn company or profile id of the account. linkedin_url: type: string example: string description: LinkedIn profile URL of the account. pinterest_url: type: string example: string description: Pinterest profile URL of the account. quora_url: type: string example: string description: Quora profile URL of the account. reddit_url: type: string example: string description: Reddit profile URL of the account. skype_url: type: string example: string description: Skype contact URL or username of the account. slideshare_url: type: string example: string description: SlideShare profile URL of the account. twitter_id: type: string example: string description: Twitter (X) user id of the account. twitter_url: type: string example: string description: Twitter (X) profile URL of the account. vimeo_url: type: string example: string description: Vimeo profile URL of the account. wordpress_url: type: string example: string description: WordPress site URL of the account. xing_url: type: string example: string description: XING profile URL of the account. yahoo_url: type: string example: string description: Yahoo profile URL of the account. yelp_url: type: string example: string description: Yelp business URL of the account. youtube_url: type: string example: string description: YouTube channel URL of the account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateParentAccountRelationTypeInput: properties: child_label: type: string example: string description: Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). parent_label: type: string example: string description: Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateAccountKPIInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. application_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Application context in which the KPI event was triggered (e.g. browser, automation, third-party integration). client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user who triggered the event. kpi: type: integer description: 'KPI metric this event represents: CreateAccount, FirstEmailSent, LastEmailSent, Archive. Integer enum value: 1 - CreateAccount, 2 - LastEmailSent, 3 - FirstEmailSent, 4 - Archive' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account owner at the time of the event. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchAccountRelationInput: properties: account1_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the first related account. account2_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the second related account. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. id: description: ID of object to update. type: string format: uuid updateAccountRelationTypeInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the relationship type label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' label: type: string example: string description: Display label of the account-to-account relationship type (e.g. Partner, Supplier). revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateAccountRelationLabelInput: properties: account_relation: type: object properties: id: type: string format: uri description: 'Account relationship being labelled. Relation to AccountRelation, see: ''updateAccountRelationInput'' object for properties.' account_relation_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account relationship. account_relation_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the relationship type. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. AccountSharingSalesUnitRelation: properties: is_delete_protected: type: boolean example: false description: Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. readOnly: true id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Unique identifier of entity. readOnly: true is_deleted: type: boolean example: false description: Specifies if the entity is considered deleted. readOnly: true modified: type: string format: date-time example: '2019-01-01T00:00:00' description: Last modification time. readOnly: true created: type: string format: date-time example: '2019-01-01T00:00:00' description: Creation time. readOnly: true account: type: string format: uri description: 'Account being shared. Relation to Account. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Account'' object for properties.' unit: type: string format: uri description: 'Sales unit the account is shared with. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''SalesUnit'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared account. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the account. Integer enum value: 1 - Watcher, 2 - Editor' example: 1 enum: - 1 - 2 unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - unit - account_id - unit_id