openapi: 3.2.0 info: title: Pipeliner Cloud Quote 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: Quote paths: /entities/Quotes/{id}: get: description: Returns Quote with given id operationId: Quotes.get summary: Quotes.get tags: - Quote parameters: - name: id in: path description: ID of Quote to retrieve required: true schema: type: string format: uuid responses: '200': description: Quote 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/Quote' '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 Quote with given id operationId: Quotes.delete summary: Quotes.delete tags: - Quote parameters: - name: id in: path description: ID of Quote to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Quote 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 Quote 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 Quote or Quotes with given id(s) parameters: - name: id in: path description: ID of Quote to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of Quote 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: Quotes.update summary: Quotes.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteInput' responses: '200': description: Modification confirmation. Returns resulting Quote content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Quote' '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/Quotes: get: description: Returns all defined Quotes operationId: Quotes.list summary: Quotes.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted Quotes 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 Quotes 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/Quote' 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 Quote operationId: Quotes.create summary: Quotes.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of Quote 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 Quote required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteInput' responses: '201': description: Creation confirmation. Returns created Quote content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/Quote' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Quotes/batch-delete: post: description: Removes Quotes with given list of ids operationId: Quotes.batch_delete summary: Quotes.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of Quotes 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 Quotes. 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 Quote 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 Quote. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/Quotes/batch-modify: post: description: Create or update an batch of Quotes operationId: Quotes.batch_create_or_update summary: Quotes.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of Quotes 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 Quotes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new Quote required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteInput' responses: '200': description: Creation confirmation. Returns a list of created / updated Quotes 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/Quotes/batch-restore: post: description: Restores Quotes with given list of ids operationId: Quotes.batch_restore summary: Quotes.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of Quotes 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 Quotes. 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 Quote 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 Quote. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteAccountRelations/{id}: get: description: Returns QuoteAccountRelation with given id operationId: QuoteAccountRelations.get summary: QuoteAccountRelations.get tags: - Quote parameters: - name: id in: path description: ID of QuoteAccountRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteAccountRelation 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/QuoteAccountRelation' '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 QuoteAccountRelation with given id operationId: QuoteAccountRelations.delete summary: QuoteAccountRelations.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteAccountRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteAccountRelation 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 QuoteAccountRelation 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 QuoteAccountRelation or QuoteAccountRelations with given id(s) parameters: - name: id in: path description: ID of QuoteAccountRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteAccountRelation 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: QuoteAccountRelations.update summary: QuoteAccountRelations.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteAccountRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteAccountRelation' '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/QuoteAccountRelations: get: description: Returns all defined QuoteAccountRelations operationId: QuoteAccountRelations.list summary: QuoteAccountRelations.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteAccountRelations 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 QuoteAccountRelations 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/QuoteAccountRelation' 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 QuoteAccountRelation operationId: QuoteAccountRelations.create summary: QuoteAccountRelations.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteAccountRelation 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 QuoteAccountRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteAccountRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteAccountRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteAccountRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteAccountRelations/batch-delete: post: description: Removes QuoteAccountRelations with given list of ids operationId: QuoteAccountRelations.batch_delete summary: QuoteAccountRelations.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteAccountRelations 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 QuoteAccountRelations. 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 QuoteAccountRelation 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 QuoteAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteAccountRelations/batch-modify: post: description: Create or update an batch of QuoteAccountRelations operationId: QuoteAccountRelations.batch_create_or_update summary: QuoteAccountRelations.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteAccountRelations 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 QuoteAccountRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteAccountRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteAccountRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteAccountRelations 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/QuoteAccountRelations/batch-restore: post: description: Restores QuoteAccountRelations with given list of ids operationId: QuoteAccountRelations.batch_restore summary: QuoteAccountRelations.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteAccountRelations 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 QuoteAccountRelations. 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 QuoteAccountRelation 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 QuoteAccountRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteContactRelations/{id}: get: description: Returns QuoteContactRelation with given id operationId: QuoteContactRelations.get summary: QuoteContactRelations.get tags: - Quote parameters: - name: id in: path description: ID of QuoteContactRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteContactRelation 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/QuoteContactRelation' '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 QuoteContactRelation with given id operationId: QuoteContactRelations.delete summary: QuoteContactRelations.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteContactRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteContactRelation 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 QuoteContactRelation 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 QuoteContactRelation or QuoteContactRelations with given id(s) parameters: - name: id in: path description: ID of QuoteContactRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteContactRelation 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: QuoteContactRelations.update summary: QuoteContactRelations.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteContactRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteContactRelation' '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/QuoteContactRelations: get: description: Returns all defined QuoteContactRelations operationId: QuoteContactRelations.list summary: QuoteContactRelations.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteContactRelations 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 QuoteContactRelations 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/QuoteContactRelation' 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 QuoteContactRelation operationId: QuoteContactRelations.create summary: QuoteContactRelations.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteContactRelation 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 QuoteContactRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteContactRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteContactRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteContactRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteContactRelations/batch-delete: post: description: Removes QuoteContactRelations with given list of ids operationId: QuoteContactRelations.batch_delete summary: QuoteContactRelations.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteContactRelations 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 QuoteContactRelations. 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 QuoteContactRelation 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 QuoteContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteContactRelations/batch-modify: post: description: Create or update an batch of QuoteContactRelations operationId: QuoteContactRelations.batch_create_or_update summary: QuoteContactRelations.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteContactRelations 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 QuoteContactRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteContactRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteContactRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteContactRelations 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/QuoteContactRelations/batch-restore: post: description: Restores QuoteContactRelations with given list of ids operationId: QuoteContactRelations.batch_restore summary: QuoteContactRelations.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteContactRelations 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 QuoteContactRelations. 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 QuoteContactRelation 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 QuoteContactRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteDataExRelations/{id}: get: description: Returns QuoteDataExRelation with given id operationId: QuoteDataExRelations.get summary: QuoteDataExRelations.get tags: - Quote parameters: - name: id in: path description: ID of QuoteDataExRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteDataExRelation 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/QuoteDataExRelation' '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 QuoteDataExRelation with given id operationId: QuoteDataExRelations.delete summary: QuoteDataExRelations.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteDataExRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteDataExRelation 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 QuoteDataExRelation 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 QuoteDataExRelation or QuoteDataExRelations with given id(s) parameters: - name: id in: path description: ID of QuoteDataExRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteDataExRelation 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: QuoteDataExRelations.update summary: QuoteDataExRelations.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteDataExRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteDataExRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteDataExRelation' '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/QuoteDataExRelations: get: description: Returns all defined QuoteDataExRelations operationId: QuoteDataExRelations.list summary: QuoteDataExRelations.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteDataExRelations 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 QuoteDataExRelations 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/QuoteDataExRelation' 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 QuoteDataExRelation operationId: QuoteDataExRelations.create summary: QuoteDataExRelations.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteDataExRelation 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 QuoteDataExRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteDataExRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteDataExRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteDataExRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteDataExRelations/batch-delete: post: description: Removes QuoteDataExRelations with given list of ids operationId: QuoteDataExRelations.batch_delete summary: QuoteDataExRelations.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteDataExRelations 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 QuoteDataExRelations. 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 QuoteDataExRelation 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 QuoteDataExRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteDataExRelations/batch-modify: post: description: Create or update an batch of QuoteDataExRelations operationId: QuoteDataExRelations.batch_create_or_update summary: QuoteDataExRelations.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteDataExRelations 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 QuoteDataExRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteDataExRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteDataExRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteDataExRelations 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/QuoteDataExRelations/batch-restore: post: description: Restores QuoteDataExRelations with given list of ids operationId: QuoteDataExRelations.batch_restore summary: QuoteDataExRelations.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteDataExRelations 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 QuoteDataExRelations. 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 QuoteDataExRelation 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 QuoteDataExRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteKPIs/{id}: get: description: Returns QuoteKPI with given id operationId: QuoteKPIs.get summary: QuoteKPIs.get tags: - Quote parameters: - name: id in: path description: ID of QuoteKPI to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteKPI 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/QuoteKPI' '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 QuoteKPI with given id operationId: QuoteKPIs.delete summary: QuoteKPIs.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteKPI to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteKPI 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 QuoteKPI 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 QuoteKPI or QuoteKPIs with given id(s) parameters: - name: id in: path description: ID of QuoteKPI to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteKPI 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: QuoteKPIs.update summary: QuoteKPIs.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteKPIInput' responses: '200': description: Modification confirmation. Returns resulting QuoteKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteKPI' '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/QuoteKPIs: get: description: Returns all defined QuoteKPIs operationId: QuoteKPIs.list summary: QuoteKPIs.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteKPIs 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 QuoteKPIs 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/QuoteKPI' 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 QuoteKPI operationId: QuoteKPIs.create summary: QuoteKPIs.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteKPI 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 QuoteKPI required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteKPIInput' responses: '201': description: Creation confirmation. Returns created QuoteKPI content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteKPI' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteKPIs/batch-delete: post: description: Removes QuoteKPIs with given list of ids operationId: QuoteKPIs.batch_delete summary: QuoteKPIs.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteKPIs 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 QuoteKPIs. 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 QuoteKPI 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 QuoteKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteKPIs/batch-modify: post: description: Create or update an batch of QuoteKPIs operationId: QuoteKPIs.batch_create_or_update summary: QuoteKPIs.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteKPIs 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 QuoteKPIs. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteKPI required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteKPIInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteKPIs 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/QuoteKPIs/batch-restore: post: description: Restores QuoteKPIs with given list of ids operationId: QuoteKPIs.batch_restore summary: QuoteKPIs.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteKPIs 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 QuoteKPIs. 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 QuoteKPI 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 QuoteKPI. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteProcesses/{id}: get: description: Returns QuoteProcess with given id operationId: QuoteProcesses.get summary: QuoteProcesses.get tags: - Quote parameters: - name: id in: path description: ID of QuoteProcess to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteProcess 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/QuoteProcess' '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 QuoteProcess with given id operationId: QuoteProcesses.delete summary: QuoteProcesses.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteProcess to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteProcess 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 QuoteProcess 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 QuoteProcess or QuoteProcesses with given id(s) parameters: - name: id in: path description: ID of QuoteProcess to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteProcess 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: QuoteProcesses.update summary: QuoteProcesses.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteProcessInput' responses: '200': description: Modification confirmation. Returns resulting QuoteProcess content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteProcess' '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/QuoteProcesses: get: description: Returns all defined QuoteProcesses operationId: QuoteProcesses.list summary: QuoteProcesses.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteProcesses 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 QuoteProcesses 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/QuoteProcess' 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 QuoteProcess operationId: QuoteProcesses.create summary: QuoteProcesses.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteProcess 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 QuoteProcess required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteProcessInput' responses: '201': description: Creation confirmation. Returns created QuoteProcess content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteProcess' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteProcesses/batch-delete: post: description: Removes QuoteProcesses with given list of ids operationId: QuoteProcesses.batch_delete summary: QuoteProcesses.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteProcesses 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 QuoteProcesses. 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 QuoteProcess 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 QuoteProcess. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteProcesses/batch-modify: post: description: Create or update an batch of QuoteProcesses operationId: QuoteProcesses.batch_create_or_update summary: QuoteProcesses.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteProcesses 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 QuoteProcesses. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteProcess required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteProcessInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteProcesses 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/QuoteProcesses/batch-restore: post: description: Restores QuoteProcesses with given list of ids operationId: QuoteProcesses.batch_restore summary: QuoteProcesses.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteProcesses 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 QuoteProcesses. 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 QuoteProcess 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 QuoteProcess. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteSharingClientRelations/{id}: get: description: Returns QuoteSharingClientRelation with given id operationId: QuoteSharingClientRelations.get summary: QuoteSharingClientRelations.get tags: - Quote parameters: - name: id in: path description: ID of QuoteSharingClientRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteSharingClientRelation 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/QuoteSharingClientRelation' '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 QuoteSharingClientRelation with given id operationId: QuoteSharingClientRelations.delete summary: QuoteSharingClientRelations.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteSharingClientRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteSharingClientRelation 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 QuoteSharingClientRelation 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 QuoteSharingClientRelation or QuoteSharingClientRelations with given id(s) parameters: - name: id in: path description: ID of QuoteSharingClientRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteSharingClientRelation 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: QuoteSharingClientRelations.update summary: QuoteSharingClientRelations.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteSharingClientRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteSharingClientRelation' '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/QuoteSharingClientRelations: get: description: Returns all defined QuoteSharingClientRelations operationId: QuoteSharingClientRelations.list summary: QuoteSharingClientRelations.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteSharingClientRelations 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 QuoteSharingClientRelations 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/QuoteSharingClientRelation' 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 QuoteSharingClientRelation operationId: QuoteSharingClientRelations.create summary: QuoteSharingClientRelations.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingClientRelation 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 QuoteSharingClientRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteSharingClientRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteSharingClientRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteSharingClientRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteSharingClientRelations/batch-delete: post: description: Removes QuoteSharingClientRelations with given list of ids operationId: QuoteSharingClientRelations.batch_delete summary: QuoteSharingClientRelations.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingClientRelations 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 QuoteSharingClientRelations. 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 QuoteSharingClientRelation 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 QuoteSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteSharingClientRelations/batch-modify: post: description: Create or update an batch of QuoteSharingClientRelations operationId: QuoteSharingClientRelations.batch_create_or_update summary: QuoteSharingClientRelations.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingClientRelations 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 QuoteSharingClientRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteSharingClientRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteSharingClientRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteSharingClientRelations 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/QuoteSharingClientRelations/batch-restore: post: description: Restores QuoteSharingClientRelations with given list of ids operationId: QuoteSharingClientRelations.batch_restore summary: QuoteSharingClientRelations.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingClientRelations 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 QuoteSharingClientRelations. 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 QuoteSharingClientRelation 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 QuoteSharingClientRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteSharingSalesUnitRelations/{id}: get: description: Returns QuoteSharingSalesUnitRelation with given id operationId: QuoteSharingSalesUnitRelations.get summary: QuoteSharingSalesUnitRelations.get tags: - Quote parameters: - name: id in: path description: ID of QuoteSharingSalesUnitRelation to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteSharingSalesUnitRelation 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/QuoteSharingSalesUnitRelation' '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 QuoteSharingSalesUnitRelation with given id operationId: QuoteSharingSalesUnitRelations.delete summary: QuoteSharingSalesUnitRelations.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteSharingSalesUnitRelation to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteSharingSalesUnitRelation 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 QuoteSharingSalesUnitRelation 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 QuoteSharingSalesUnitRelation or QuoteSharingSalesUnitRelations with given id(s) parameters: - name: id in: path description: ID of QuoteSharingSalesUnitRelation to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteSharingSalesUnitRelation 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: QuoteSharingSalesUnitRelations.update summary: QuoteSharingSalesUnitRelations.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteSharingSalesUnitRelationInput' responses: '200': description: Modification confirmation. Returns resulting QuoteSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteSharingSalesUnitRelation' '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/QuoteSharingSalesUnitRelations: get: description: Returns all defined QuoteSharingSalesUnitRelations operationId: QuoteSharingSalesUnitRelations.list summary: QuoteSharingSalesUnitRelations.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteSharingSalesUnitRelations 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 QuoteSharingSalesUnitRelations 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/QuoteSharingSalesUnitRelation' 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 QuoteSharingSalesUnitRelation operationId: QuoteSharingSalesUnitRelations.create summary: QuoteSharingSalesUnitRelations.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingSalesUnitRelation 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 QuoteSharingSalesUnitRelation required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteSharingSalesUnitRelationInput' responses: '201': description: Creation confirmation. Returns created QuoteSharingSalesUnitRelation content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteSharingSalesUnitRelation' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteSharingSalesUnitRelations/batch-delete: post: description: Removes QuoteSharingSalesUnitRelations with given list of ids operationId: QuoteSharingSalesUnitRelations.batch_delete summary: QuoteSharingSalesUnitRelations.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingSalesUnitRelations 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 QuoteSharingSalesUnitRelations. 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 QuoteSharingSalesUnitRelation 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 QuoteSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteSharingSalesUnitRelations/batch-modify: post: description: Create or update an batch of QuoteSharingSalesUnitRelations operationId: QuoteSharingSalesUnitRelations.batch_create_or_update summary: QuoteSharingSalesUnitRelations.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingSalesUnitRelations 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 QuoteSharingSalesUnitRelations. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteSharingSalesUnitRelation required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteSharingSalesUnitRelationInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteSharingSalesUnitRelations 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/QuoteSharingSalesUnitRelations/batch-restore: post: description: Restores QuoteSharingSalesUnitRelations with given list of ids operationId: QuoteSharingSalesUnitRelations.batch_restore summary: QuoteSharingSalesUnitRelations.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteSharingSalesUnitRelations 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 QuoteSharingSalesUnitRelations. 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 QuoteSharingSalesUnitRelation 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 QuoteSharingSalesUnitRelation. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteTypes/{id}: get: description: Returns QuoteType with given id operationId: QuoteTypes.get summary: QuoteTypes.get tags: - Quote parameters: - name: id in: path description: ID of QuoteType to retrieve required: true schema: type: string format: uuid responses: '200': description: QuoteType 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/QuoteType' '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 QuoteType with given id operationId: QuoteTypes.delete summary: QuoteTypes.delete tags: - Quote parameters: - name: id in: path description: ID of QuoteType to delete required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteType 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 QuoteType 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 QuoteType or QuoteTypes with given id(s) parameters: - name: id in: path description: ID of QuoteType to update required: true schema: type: string format: uuid - name: validation-level in: query description: 'Specify validation level of QuoteType 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: QuoteTypes.update summary: QuoteTypes.update tags: - Quote requestBody: description: id(s) of modified item(s) and fields to modify required: true content: application/json: schema: $ref: '#/components/schemas/updateQuoteTypeInput' responses: '200': description: Modification confirmation. Returns resulting QuoteType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteType' '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/QuoteTypes: get: description: Returns all defined QuoteTypes operationId: QuoteTypes.list summary: QuoteTypes.list tags: - Quote parameters: - name: include-deleted in: query description: if enabled, deleted QuoteTypes 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 QuoteTypes 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/QuoteType' 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 QuoteType operationId: QuoteTypes.create summary: QuoteTypes.create tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteType 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 QuoteType required: true content: application / json: schema: $ref: '#/components/schemas/createQuoteTypeInput' responses: '201': description: Creation confirmation. Returns created QuoteType content: application/json: schema: type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: $ref: '#/components/schemas/QuoteType' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteTypes/batch-delete: post: description: Removes QuoteTypes with given list of ids operationId: QuoteTypes.batch_delete summary: QuoteTypes.batch_delete tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteTypes 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 QuoteTypes. 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 QuoteType 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 QuoteType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' /entities/QuoteTypes/batch-modify: post: description: Create or update an batch of QuoteTypes operationId: QuoteTypes.batch_create_or_update summary: QuoteTypes.batch_create_or_update tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteTypes 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 QuoteTypes. 0 - rollback all, 1 - rollback only failed records. schema: type: integer format: int32 requestBody: description: data of new QuoteType required: true content: application / json: schema: type: array items: $ref: '#/components/schemas/batchQuoteTypeInput' responses: '200': description: Creation confirmation. Returns a list of created / updated QuoteTypes 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/QuoteTypes/batch-restore: post: description: Restores QuoteTypes with given list of ids operationId: QuoteTypes.batch_restore summary: QuoteTypes.batch_restore tags: - Quote parameters: - name: validation-level in: query description: 'Specify validation level of QuoteTypes 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 QuoteTypes. 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 QuoteType 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 QuoteType. format: uuid - $ref: '#/components/schemas/Error' '500': description: unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: QuoteSharingSalesUnitRelation: 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 quote: type: string format: uri description: 'Quote being shared. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' unit: type: string format: uri description: 'Sales unit the quote 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.' quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote. 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 - quote - unit - quote_id - unit_id batchQuoteTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing quotes of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a quote of this type. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving quotes of this type. is_readonly: type: boolean example: false description: True when the quote 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. quote_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote process. 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 updateQuoteProcessInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: 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. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this quote process, in evaluation order. batchQuoteSharingSalesUnitRelationInput: properties: quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote. 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 batchQuoteDataExRelationInput: properties: data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the linked fields belong to. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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 QuoteDataExRelation: 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 data: type: string format: uri description: 'Data record holding the additional fields linked to this quote. 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.' quote: type: string format: uri description: 'Quote this data relation row applies to. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the linked fields belong to. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - data - quote - data_id - data_set_id - quote_id 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 createQuoteKPIInput: 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 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: Create, Accept, Archive, LastMove. Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner at the time of the event. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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: - kpi - owner_id - quote_id createQuoteContactRelationInput: 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 contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - contact_id - is_primary - quote_id createQuoteAccountRelationInput: 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. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - account_id - is_primary - quote_id updateQuoteContactRelationInput: properties: contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. QuoteAccountRelation: 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 linked to the quote. 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.' quote: type: string format: uri description: 'Quote the account is linked to. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - account - quote - account_id - is_primary - quote_id createQuoteDataExRelationInput: 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 data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the linked fields belong to. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - data_id - data_set_id - quote_id createQuoteProcessInput: 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 quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: 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. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this quote process, in evaluation order. required: - name - steps batchQuoteKPIInput: properties: 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: Create, Accept, Archive, LastMove. Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner at the time of the event. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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 updateQuoteDataExRelationInput: properties: data_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the linked data record. data_set_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Identifier of the data set the linked fields belong to. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. updateQuoteTypeInput: properties: form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing quotes of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a quote of this type. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving quotes of this type. is_readonly: type: boolean example: false description: True when the quote 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. quote_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote process. 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. updateQuoteSharingSalesUnitRelationInput: properties: quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote. 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. batchQuoteSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote. 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 QuoteSharingClientRelation: 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 client: type: string format: uri description: 'User the quote 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.' quote: type: string format: uri description: 'Quote being shared. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote. 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 - client - quote - client_id - quote_id QuoteType: 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 quote_process: type: string format: uri description: 'Quote process (pipeline) this quote type follows. Relation to QuoteProcess. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteProcess'' object for properties.' form_edit: type: object description: JSON definition of the form layout used by the UI when creating or editing quotes of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a quote of this type. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving quotes of this type. is_readonly: type: boolean example: false description: True when the quote 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. quote_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote process. 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. form_lost_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. required: - has_draft - is_delete_protected - form_edit_api - id - quote_process - form_lost_enabled - is_readonly - name - quote_process_id - settings - form_lost_api Quote: 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 currency_exchange_rates_list: type: string format: uri description: 'Currency exchange rate list used to convert monetary fields linked to this quote. 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.' oppty: type: string format: uri description: 'Opportunity this quote was prepared for. Empty for standalone quotes. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Opportunity'' object for properties.' owner: type: string format: uri description: 'Sales user who owns this quote. 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.' product_currency: type: string format: uri description: 'Currency used for product line-item prices on this quote. 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_price_list: type: string format: uri description: 'Product price list used to populate prices for product line items added to this quote. Empty to use catalog defaults. Relation to ProductPriceList. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''ProductPriceList'' object for properties.' quote_type: type: string format: uri description: 'Quote type that classifies this quote. Each type maps to one quote process and drives which form, fields and stages apply. Relation to QuoteType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteType'' object for properties.' reason_of_close: type: string format: uri description: 'Configurable reason recorded when the quote is archived (lost). Required when the lost form mandates it. 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.' step: type: string format: uri description: 'Quote-process step the quote is currently sitting in. Reaching the last step in the process marks the quote as accepted. Relation to Step. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Step'' object for properties.' unit: type: string format: uri description: 'Sales unit this quote 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.' 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 quote. description: type: string example: string description: Free-form description of the quote. expiration_date: type: string format: date example: '2019-01-01' description: Date after which the quote is no longer considered valid. is_archived: type: boolean example: false description: True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. name: type: string example: string description: Name of the entity and its default text representation. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at quote creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at quote creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at quote creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at quote creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at quote creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at quote creation when no Contact record has been linked yet. quote_number: type: string example: string description: Auto-generated sequential identifier of the quote, used for human-readable reference. readOnly: true quote_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote type. reason_of_close_description: type: string example: string description: Free-form note explaining why the quote was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. 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 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote-process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. version: type: integer format: int32 example: 1 description: Revision number of the quote, incremented when a new version of the same quote is created. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. total_amount: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. product_relations: type: array items: type: string format: uri description: 'Relation to OpptyProductRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''OpptyProductRelation'' object for properties.' description: Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount. primary_contact: type: string format: uri description: 'Primary contact of this quote. Set automatically from the contact relation marked as primary. Relation to Contact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Contact'' object for properties.' primary_account: type: string format: uri description: 'Primary account of this quote. Set automatically from the account relation marked as primary. 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.' contact_relations: type: array items: type: string format: uri description: 'Relation to QuoteContactRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteContactRelation'' object for properties.' description: Contacts linked to this quote. account_relations: type: array items: type: string format: uri description: 'Relation to QuoteAccountRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteAccountRelation'' object for properties.' description: Accounts linked to this quote, including the primary-account flag. 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 quote. sharing_units: type: array items: type: string format: uri description: 'Relation to QuoteSharingSalesUnitRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteSharingSalesUnitRelation'' object for properties.' description: Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: string format: uri description: 'Relation to QuoteSharingClientRelation. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteSharingClientRelation'' object for properties.' description: Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing. status: type: integer description: 'Current status of the quote (Open, Lost, Accepted). Read-only; derived from the current step and the archived flag. Integer enum value: 1 - Open, 2 - Lost, 3 - Accepted' example: 1 enum: - 1 - 2 - 3 readOnly: true formatted_name: type: string example: string description: Display version of the quote name, used in lists and references. is_favorite: type: boolean example: false description: True when the current authenticated user has marked this quote as favorite. Per-user. is_active_in_opportunity: type: boolean example: false description: If quote is set as active in opportunity. 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. 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 quote currently matches. 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 quote. required: - is_delete_protected - id - owner - product_currency - quote_type - step - unit - name - owner_id - step_id - total_amount - status - formatted_name - is_favorite batchQuoteContactRelationInput: properties: contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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 createQuoteTypeInput: 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 form layout used by the UI when creating or editing quotes of this type. form_lost: type: object description: JSON definition of the form shown when archiving (losing) a quote of this type. form_lost_enabled: type: boolean example: false description: True when the lost form is required on archiving quotes of this type. is_readonly: type: boolean example: false description: True when the quote 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. quote_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote process. 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: - form_lost_enabled - is_readonly - name - quote_process_id - settings updateQuoteInput: properties: 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 quote. description: type: string example: string description: Free-form description of the quote. expiration_date: type: string format: date example: '2019-01-01' description: Date after which the quote is no longer considered valid. is_archived: type: boolean example: false description: True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. name: type: string example: string description: Name of the entity and its default text representation. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at quote creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at quote creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at quote creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at quote creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at quote creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at quote creation when no Contact record has been linked yet. quote_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote type. reason_of_close_description: type: string example: string description: Free-form note explaining why the quote was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. 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 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote-process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. version: type: integer format: int32 example: 1 description: Revision number of the quote, incremented when a new version of the same quote is created. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. total_amount: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. product_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OpptyProductRelation, see: ''updateOpptyProductRelationInput'' object for properties.' description: Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteContactRelation, see: ''updateQuoteContactRelationInput'' object for properties.' description: Contacts linked to this quote. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteAccountRelation, see: ''updateQuoteAccountRelationInput'' object for properties.' description: Accounts linked to this quote, including the primary-account flag. 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 quote. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteSharingSalesUnitRelation, see: ''updateQuoteSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteSharingClientRelation, see: ''updateQuoteSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing. is_active_in_opportunity: type: boolean example: false description: If quote is set as active in opportunity. 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 quote currently matches. 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 quote. updateQuoteSharingClientRelationInput: properties: client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote. 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. batchQuoteAccountRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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 updateQuoteAccountRelationInput: properties: account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the account. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. batchQuoteInput: properties: 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 quote. description: type: string example: string description: Free-form description of the quote. expiration_date: type: string format: date example: '2019-01-01' description: Date after which the quote is no longer considered valid. is_archived: type: boolean example: false description: True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. name: type: string example: string description: Name of the entity and its default text representation. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at quote creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at quote creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at quote creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at quote creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at quote creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at quote creation when no Contact record has been linked yet. quote_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote type. reason_of_close_description: type: string example: string description: Free-form note explaining why the quote was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. 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 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote-process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. version: type: integer format: int32 example: 1 description: Revision number of the quote, incremented when a new version of the same quote is created. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. total_amount: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. product_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OpptyProductRelation, see: ''updateOpptyProductRelationInput'' object for properties.' description: Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteContactRelation, see: ''updateQuoteContactRelationInput'' object for properties.' description: Contacts linked to this quote. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteAccountRelation, see: ''updateQuoteAccountRelationInput'' object for properties.' description: Accounts linked to this quote, including the primary-account flag. 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 quote. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteSharingSalesUnitRelation, see: ''updateQuoteSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteSharingClientRelation, see: ''updateQuoteSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing. is_active_in_opportunity: type: boolean example: false description: If quote is set as active in opportunity. 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 quote currently matches. 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 quote. id: description: ID of object to update. type: string format: uuid createQuoteInput: 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 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 quote. description: type: string example: string description: Free-form description of the quote. expiration_date: type: string format: date example: '2019-01-01' description: Date after which the quote is no longer considered valid. is_archived: type: boolean example: false description: True when the quote has been archived (lost). Archived quotes remain readable but are hidden from active lists and cannot be edited until reactivated. name: type: string example: string description: Name of the entity and its default text representation. oppty_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the opportunity. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product currency. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the product price list. product_sections: type: object description: 'Product sections grouping the record''s line items, as a JSON array of {"id": , "name": } objects. Validated on write. Full structure: https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html' quick_account_email: type: string example: string description: Free-text company email captured at quote creation when no Account record has been linked yet. quick_account_name: type: string example: string description: Free-text company name captured at quote creation when no Account record has been linked yet. quick_account_phone: type: string example: string description: Free-text company phone captured at quote creation when no Account record has been linked yet. quick_contact_name: type: string example: string description: Free-text contact name captured at quote creation when no Contact record has been linked yet. quick_email: type: string example: string description: Free-text contact email captured at quote creation when no Contact record has been linked yet. quick_phone: type: string example: string description: Free-text contact phone captured at quote creation when no Contact record has been linked yet. quote_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote type. reason_of_close_description: type: string example: string description: Free-form note explaining why the quote was archived (lost). reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the reason-of-close value. 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 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote-process step. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the sales unit. version: type: integer format: int32 example: 1 description: Revision number of the quote, incremented when a new version of the same quote is created. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. total_amount: type: object properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. required: - base_value - currency_id - value_foreign description: Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside. product_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to OpptyProductRelation, see: ''createOpptyProductRelationInput'' object for properties.' description: Product line items on this quote. Each entry holds the product, quantity, price and discount that contribute to total_amount. contact_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteContactRelation, see: ''createQuoteContactRelationInput'' object for properties.' description: Contacts linked to this quote. account_relations: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteAccountRelation, see: ''createQuoteAccountRelationInput'' object for properties.' description: Accounts linked to this quote, including the primary-account flag. 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 quote. sharing_units: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteSharingSalesUnitRelation, see: ''createQuoteSharingSalesUnitRelationInput'' object for properties.' description: Sales units that have been granted shared access to this quote. Editable only when share_mode allows unit sharing. sharing_clients: type: array items: type: object properties: id: type: string format: uri description: 'Relation to QuoteSharingClientRelation, see: ''createQuoteSharingClientRelationInput'' object for properties.' description: Users that have been granted shared access to this quote. Editable only when share_mode allows user sharing. is_active_in_opportunity: type: boolean example: false description: If quote is set as active in opportunity. 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 quote currently matches. 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 quote. required: - name - owner_id - step_id - total_amount QuoteProcess: 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 quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: 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. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this quote process, in evaluation order. quote_types: type: array items: type: string format: uri description: 'Relation to QuoteType. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''QuoteType'' object for properties.' description: Quote types that follow this quote process. required: - is_delete_protected - id - name - steps - quote_types QuoteContactRelation: 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 contact: type: string format: uri description: 'Contact linked to the quote. Relation to Contact. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Contact'' object for properties.' quote: type: string format: uri description: 'Quote the contact is linked to. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' object for properties.' contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the contact. is_primary: type: boolean example: false description: True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. required: - is_delete_protected - id - contact - quote - contact_id - is_primary - quote_id createQuoteSharingClientRelationInput: 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 client_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the user. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the user a specific access level (e.g. Read, Edit) on the quote. 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: - client_id - quote_id updateQuoteKPIInput: properties: 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: Create, Accept, Archive, LastMove. Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner at the time of the event. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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. batchQuoteProcessInput: properties: color: type: integer format: int32 example: 1 description: 'Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.' name: 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. steps: type: array items: $ref: '#/components/schemas/batchStepInput' description: Steps that make up this quote process, in evaluation order. id: description: ID of object to update. type: string format: uuid batchStepInput: properties: description: type: string example: string description: Free-text description shown in the step UI. has_readonly_form: type: boolean example: false description: When true, the record form is read-only while a record is in this step. has_version_increment: type: boolean example: false description: When true, transitioning a record into this step bumps its version counter. lead_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the lead process. name: type: string example: string description: Name of the entity and its default text representation. percent: type: integer format: int32 example: 1 description: Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps. quote_process_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote process. sort_order: type: integer format: int32 example: 1 description: Position of the step within its pipeline or process; lower values appear first. timeframe: type: integer format: int32 example: 1 description: Expected number of days a record should spend in this step. Used to flag overdue records. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. documents: type: array items: type: object properties: id: type: string format: uri description: 'Relation to CloudObjectStepRelation, see: ''updateCloudObjectStepRelationInput'' object for properties.' description: Files attached to the step (e.g. step-specific documentation or templates). step_checklists: type: array items: type: object properties: id: type: string format: uri description: 'Relation to StepChecklist, see: ''updateStepChecklistInput'' object for properties.' description: Checklist items the user must complete before moving a record out of this step. id: description: ID of object to update. type: string format: uuid createQuoteSharingSalesUnitRelationInput: 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 quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the shared quote. role: type: integer description: 'Sharing role granting the unit a specific access level (e.g. Read, Edit) on the quote. 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: - quote_id - unit_id QuoteKPI: 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 client: type: string format: uri description: 'User who triggered the KPI event (e.g. created the quote, accepted it, archived it, moved the record). 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: 'Quote 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.' quote: type: string format: uri description: 'Quote this KPI event relates to. Relation to Quote. By default it is returned as URI to related resource. Using parameter ''expand'', it will return full entity. See: ''Quote'' 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.' 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: Create, Accept, Archive, LastMove. Integer enum value: 1 - Create, 2 - Accept, 3 - Archive, 4 - LastMove' example: 1 enum: - 1 - 2 - 3 - 4 owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote owner at the time of the event. quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Id of the quote. 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 - owner - quote - kpi - owner_id - quote_id