GraphQL RepositoriesquoteProcess

`entities.quoteProcess`

Read quote process records with the quoteProcess repository, and change them with the quote process mutations. Same records as the REST QuoteProcesses entity.

Example: first three quote process recordsGraphQLcURL

query FirstQuoteProcesss {
  entities {
    quoteProcess {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstQuoteProcesss { entities { quoteProcess { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { quoteProcess { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	QuoteProcessEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[QuoteProcessEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: QuoteProcessFilterInput, orderBy: [QuoteProcessOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[QuoteProcessEntity!]!
QUERY	`getByCriteria`(filter: QuoteProcessFilterInput, orderBy: [QuoteProcessOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	QuoteProcessEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`changeQuoteProcess`(input: ChangeQuoteProcessInput!)	Moves the quote to another quote process by changing its quote type and step, optionally changing its owner at the same time. Both quoteTypeId and stepId must be sent. GraphQL only	ChangeQuoteProcessPayload
MUTATION	`createQuoteProcess`(input: CreateQuoteProcessInput!, validationLevel: [ValidationLevel!])	Create one record	CreateQuoteProcessPayload
MUTATION	`updateQuoteProcess`(input: UpdateQuoteProcessInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateQuoteProcessPayload
MUTATION	`bulkUpdateQuoteProcess`(input: [CreateOrUpdateQuoteProcessInput!]!, deleteInput: [DeleteQuoteProcessInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateQuoteProcessPayload
MUTATION	`deleteQuoteProcess`(input: DeleteQuoteProcessInput!)	Soft-delete	DeleteQuoteProcessPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

QuoteProcessEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Quote process: the ordered steps that quotes of its quote types move through.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`color`	Int	Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[StepEntity!]!	Steps that make up this quote process, in evaluation order.
`quoteTypes`	[QuoteTypeEntity!]!	Quote types that follow this quote process.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

QuoteProcessEntityConnection object pageInfo: PageInfo!, edges: [QuoteProcessEntityEdge]!, totalCount: Int

Paginated list of QuoteProcess records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[QuoteProcessEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

QuoteProcessEntityEdge object node: QuoteProcessEntity, cursor: String!

A Relay edge containing a QuoteProcessEntity and its cursor.

Field	Type	Description
`node`	QuoteProcessEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

QuoteProcessFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for QuoteProcess records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[QuoteProcessFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[QuoteProcessFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	QuoteProcessFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`color`	EntityFilterNumberField	Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

QuoteProcessOrderByInput input Asc or Desc per field

Sorting of QuoteProcess records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`color`	OrderByEnum	Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	OrderByEnum	Name of the entity and its default text representation.
`revision`	OrderByEnum	Revision when entity was lastly changed.

ChangeQuoteProcessInput input entity: UpdateQuoteInput!, keepOwnerAsEditor: Boolean!, transferLinkedRecords: Boolean!, clientMutationId: String

Parameters of the changeQuoteProcess mutation.

Input field	Type	Description
`entity`	UpdateQuoteInput!	Id of the quote, the new quoteTypeId and stepId, an optional new ownerId or unitId, and any other field values to save.
`keepOwnerAsEditor`	Boolean!	Adds the previous owner as an editor of the quote; a private quote becomes shared.
`transferLinkedRecords`	Boolean!	Gives the new owner the quote's open activities and its notes.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateOrUpdateQuoteProcessInput input 8 fields: clientMutationId, id, modified, …

Field values of a QuoteProcess record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`color`	Int	Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[CreateOrUpdateStepNoQuoteProcessBackrefInput!]	Steps that make up this quote process, in evaluation order.

CreateOrUpdateStepNoQuoteProcessBackrefInput input 15 fields: id, modified, created, …

Field values of a Step record to create, or to update when its id is set, together with the record it belongs to.

Input field	Type	Description
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description shown in the step UI.
`hasReadonlyForm`	Boolean	When true, the record form is read-only while a record is in this step.
`hasVersionIncrement`	Boolean	When true, transitioning a record into this step bumps its version counter.
`leadProcessId`	ID	Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
`name`	String	Name of the entity and its default text representation.
`percent`	Int	Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
`pipelineId`	ID	Id of the opportunity pipeline.
`sortOrder`	Int	Position of the step within its pipeline or process; lower values appear first.
`timeframe`	Int	Expected number of days a record should spend in this step. Used to flag overdue records.
`revision`	Int	Revision when entity was lastly changed.
`documents`	[CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!]	Files attached to the step (e.g. step-specific documentation or templates).
`stepChecklists`	[CreateOrUpdateStepChecklistNoStepBackrefInput!]	Checklist items the user must complete before moving a record out of this step.

CreateQuoteProcessInput input 7 fields: clientMutationId, modified, created, …

Field values of a new QuoteProcess record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`color`	Int	Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	String!	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[CreateStepNoQuoteProcessBackrefInput!]!	Steps that make up this quote process, in evaluation order.

CreateStepNoQuoteProcessBackrefInput input 14 fields: modified, created, description, …

Field values of a new Step record, created together with the record it belongs to.

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`description`	String	Free-text description shown in the step UI.
`hasReadonlyForm`	Boolean	When true, the record form is read-only while a record is in this step.
`hasVersionIncrement`	Boolean	When true, transitioning a record into this step bumps its version counter.
`leadProcessId`	ID	Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
`name`	String!	Name of the entity and its default text representation.
`percent`	Int	Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
`pipelineId`	ID	Id of the opportunity pipeline.
`sortOrder`	Int	Position of the step within its pipeline or process; lower values appear first.
`timeframe`	Int	Expected number of days a record should spend in this step. Used to flag overdue records.
`revision`	Int	Revision when entity was lastly changed.
`documents`	[CreateCloudObjectStepRelationNoStepBackrefInput!]	Files attached to the step (e.g. step-specific documentation or templates).
`stepChecklists`	[CreateStepChecklistNoStepBackrefInput!]	Checklist items the user must complete before moving a record out of this step.

DeleteQuoteProcessInput input clientMutationId: String, id: ID!

Id of the QuoteProcess record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateQuoteProcessInput input 8 fields: clientMutationId, id, modified, …

Id of a QuoteProcess record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`color`	Int	Display color of the quote process label, encoded as an integer packing the RGB components: (red << 16) \| (green << 8) \| blue.
`name`	String	Name of the entity and its default text representation.
`revision`	Int	Revision when entity was lastly changed.
`steps`	[CreateOrUpdateStepNoQuoteProcessBackrefInput!]	Steps that make up this quote process, in evaluation order.

BulkUpdateQuoteProcessPayload object result: BulkUpdateResults!

Result of the bulkUpdateQuoteProcess mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

ChangeQuoteProcessPayload object result: QuoteEntity, clientMutationId: String

Result of the changeQuoteProcess mutation.

Field	Type	Description
`result`	QuoteEntity	The updated quote.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateQuoteProcessPayload object quoteProcess: QuoteProcessEntity, clientMutationId: String

Result of the createQuoteProcess mutation.

Field	Type	Description
`quoteProcess`	QuoteProcessEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteQuoteProcessPayload object quoteProcess: QuoteProcessEntity, clientMutationId: String

Result of the deleteQuoteProcess mutation.

Field	Type	Description
`quoteProcess`	QuoteProcessEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateQuoteProcessPayload object quoteProcess: QuoteProcessEntity, clientMutationId: String

Result of the updateQuoteProcess mutation.

Field	Type	Description
`quoteProcess`	QuoteProcessEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).