REST API Products, pricing, quotes and currenciesQuotes

Quotes

Priced offers for a customer, with line items and a total, moving through the steps of a quote process.

A create needs name, owner_id, step_id (a step of a quote process) and total_amount.

What the API requires

total_amount is a currency object. The spec marks base_value, currency_id and value_foreign as required; the API needs only one of them.

Method	Path	Operation
GET	`/entities/Quotes`	List quotes
POST	`/entities/Quotes`	Create a quote
GET	`/entities/Quotes/{id}`	Get a quote
PATCH	`/entities/Quotes/{id}`	Update a quote
DEL	`/entities/Quotes/{id}`	Delete a quote
POST	`/entities/Quotes/batch-modify`	Create or update quotes in a batch
POST	`/entities/Quotes/batch-delete`	Delete quotes in a batch
POST	`/entities/Quotes/batch-restore`	Restore deleted quotes

GET List quotes

Returns the quotes the API application can read, one page at a time.

Query parameters

Name	Type	Description
`include-deleted`	boolean	Include soft-deleted records. Lists only; get-by-id refuses it.
`first`	integer	Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
`last`	integer	Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100.
`before`	string	Cursor from `page_info.start_cursor`, to page backwards. URL-encode it.
`after`	string	Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`.
`order-by`	string	Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields.
`filter`	object	`filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.
`filter-op`	object	`filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.
`load-only`	string	Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Responses

200 Page of Quote records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes",
    params={
      "first": "10",
      "filter[name]": "north",
      "filter-op[name]": "icontains"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create a quote

Creates one quote and answers 201 with the record. name, owner_id, step_id and total_amount are required.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The new record's fields. Relations are set by id. Schema createQuoteInput; the fields are in Quote fields. Required: name, owner_id, step_id, total_amount.

Responses

201 The created Quote record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind Analytics - Q-1001",
  "owner_id": "37000000-0000-4000-a000-000000000001",
  "step_id": "d4000000-0000-4000-a000-000000000002",
  "total_amount": {
    "base_value": 24000
  }
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Northwind Analytics - Q-1001',
    owner_id: '37000000-0000-4000-a000-000000000001',
    step_id: 'd4000000-0000-4000-a000-000000000002',
    total_amount: {
      base_value: 24000
    }
  })
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "name": "Northwind Analytics - Q-1001",
      "owner_id": "37000000-0000-4000-a000-000000000001",
      "step_id": "d4000000-0000-4000-a000-000000000002",
      "total_amount": {
        "base_value": 24000
      }
    }
)

GET Get a quote

Returns one quote by id.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the Quote record to retrieve. Required

Query parameters

Name	Type	Description
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The Quote record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001?expand=owner' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001?expand=owner', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001",
    params={
      "expand": "owner"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH Update a quote

Changes the fields you send and leaves the rest as they are.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the Quote record to update. Required

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The fields to change. Schema updateQuoteInput; the fields are in Quote fields.

Responses

200 The changed Quote record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind quote (renamed)"
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001', {
  method: 'PATCH',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Northwind quote (renamed)'
  })
})

import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "name": "Northwind quote (renamed)"
    }
)

DEL Delete a quote

Soft-deletes one quote and answers with its id.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the Quote record to delete. Required

Responses

200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001', {
  method: 'DELETE',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.delete(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/4c000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create or update quotes in a batch

An item with an id updates that quote; an item without one creates a quote. By default one invalid item fails the whole call with HTTP 422.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of records: an item with an id updates, an item without one creates. Schema batchQuoteInput; the fields are in Quote fields. Required: name, owner_id, step_id, total_amount.

Responses

200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "name": "Northwind quote",
    "owner_id": "37000000-0000-4000-a000-000000000001",
    "step_id": "d4000000-0000-4000-a000-000000000001",
    "total_amount": {
      "base_value": 1000
    }
  },
  {
    "id": "4c000000-0000-4000-a000-000000000001",
    "name": "Northwind quote (renamed)"
  }
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-modify', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      name: 'Northwind quote',
      owner_id: '37000000-0000-4000-a000-000000000001',
      step_id: 'd4000000-0000-4000-a000-000000000001',
      total_amount: {
        base_value: 1000
      }
    },
    {
      id: '4c000000-0000-4000-a000-000000000001',
      name: 'Northwind quote (renamed)'
    }
  ])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-modify",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      {
        "name": "Northwind quote",
        "owner_id": "37000000-0000-4000-a000-000000000001",
        "step_id": "d4000000-0000-4000-a000-000000000001",
        "total_amount": {
          "base_value": 1000
        }
      },
      {
        "id": "4c000000-0000-4000-a000-000000000001",
        "name": "Northwind quote (renamed)"
      }
    ]
)

POST Delete quotes in a batch

Soft-deletes the quotes whose ids are in the body, a JSON array.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "4c000000-0000-4000-a000-000000000001",
  "4c000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['4c000000-0000-4000-a000-000000000001', '4c000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-delete",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "4c000000-0000-4000-a000-000000000001",
      "4c000000-0000-4000-a000-000000000002"
    ]
)

POST Restore deleted quotes

Restores the soft-deleted quotes whose ids are in the body, a JSON array.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "4c000000-0000-4000-a000-000000000001",
  "4c000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-restore', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['4c000000-0000-4000-a000-000000000001', '4c000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Quotes/batch-restore",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "4c000000-0000-4000-a000-000000000001",
      "4c000000-0000-4000-a000-000000000002"
    ]
)

Quote fields

Field	Type	Notes
`id`	uuid	Read-only Unique identifier of entity.
`name`	string	Required on create Name of the entity and its default text representation.
`owner_id`	uuid → Clients	Required on create Id of the quote owner.
`step_id`	uuid → Steps	Required on create Id of the quote-process step.
`total_amount`	object	Required on create Total monetary value of the quote in the team space base currency, with the foreign value and currency code preserved alongside.
`currency_exchange_rates_list_id`	uuid → CurrencyExchangeRatesLists	Id of the currency exchange rate list applied to this quote.
`description`	string	Free-form description of the quote.
`expiration_date`	date	Date after which the quote is no longer considered valid.
`is_archived`	boolean	True when the quote has been archived (lost).
`oppty_id`	uuid → Opportunities	Id of the opportunity.
`product_currency_id`	uuid → Currencies	Id of the currency used for product line-item prices on this quote.
`product_price_list_id`	uuid → ProductPriceLists	Id of the price list that supplies prices for product line items added to this quote, or empty to use catalog defaults.
`product_sections`	object	Product sections grouping the record's line items, as a JSON array of {"id": <UUID>, "name": <string>} objects.
`quick_account_email`	string	Free-text company email captured at quote creation when no Account record has been linked yet.
`quick_account_name`	string	Free-text company name captured at quote creation when no Account record has been linked yet.

Show all 55 fields

Field	Type	Notes
`quick_account_phone`	string	Free-text company phone captured at quote creation when no Account record has been linked yet.
`quick_contact_name`	string	Free-text contact name captured at quote creation when no Contact record has been linked yet.
`quick_email`	string	Free-text contact email captured at quote creation when no Contact record has been linked yet.
`quick_phone`	string	Free-text contact phone captured at quote creation when no Contact record has been linked yet.
`quote_type_id`	uuid → QuoteTypes	Id of the quote type that classifies this quote.
`reason_of_close_description`	string	Free-form note explaining why the quote was archived (lost).
`reason_of_close_id`	uuid → Data	Id of the reason of close option selected when the quote was archived (lost).
`share_mode`	integer	Sharing model applied on top of the owner/unit visibility (e.g.0 Standard · 1 Private · 2 AllView · 3 AllEdit
`unit_id`	uuid → SalesUnits	Id of the sales unit.
`version`	integer	Revision number of the quote, incremented when a new version of the same quote is created.
`revision`	integer	Revision when entity was lastly changed.
`product_relations`	array of uri → OpptyProductRelations	Product line items on this quote.
`contact_relations`	array of uri → QuoteContactRelations	Contacts linked to this quote.
`account_relations`	array of uri → QuoteAccountRelations	Accounts linked to this quote, including the primary-account flag.
`documents`	array of uri → CloudObjectRelations	Documents linked to this quote.
`sharing_units`	array of uri → QuoteSharingSalesUnitRelations	Sales units that have been granted shared access to this quote.
`sharing_clients`	array of uri → QuoteSharingClientRelations	Users that have been granted shared access to this quote.
`is_active_in_opportunity`	boolean	If quote is set as active in opportunity.
`static_profiles`	array of uri → ProfileRelations	Saved view profiles this quote currently matches.
`tags`	array of uri → TagRelations	Tag labels applied to this quote.
`is_delete_protected`	boolean	Read-only True when the record is protected against deletion because it must always exist in the space.
`is_deleted`	boolean	Read-only Specifies if the entity is considered deleted.
`modified`	date-time	Read-only Last modification time.
`created`	date-time	Read-only Creation time.
`currency_exchange_rates_list`	uri → CurrencyExchangeRatesLists	Read-only Currency exchange rate list used to convert monetary fields linked to this quote.
`oppty`	uri → Opportunities	Read-only Opportunity this quote was prepared for.
`owner`	uri → Clients	Read-only Sales user who owns this quote.
`product_currency`	uri → Currencies	Read-only Currency used for product line-item prices on this quote.
`product_price_list`	uri → ProductPriceLists	Read-only Product price list used to populate prices for product line items added to this quote.
`quote_type`	uri → QuoteTypes	Read-only Quote type that classifies this quote.
`reason_of_close`	uri → Data	Read-only Configurable reason recorded when the quote is archived (lost).
`step`	uri → Steps	Read-only Quote-process step the quote is currently sitting in.
`unit`	uri → SalesUnits	Read-only Sales unit this quote is assigned to.
`quote_number`	string	Read-only Auto-generated sequential identifier of the quote, used for human-readable reference.
`primary_contact`	uri → Contacts	Read-only Primary contact of this quote.
`primary_account`	uri → Accounts	Read-only Primary account of this quote.
`status`	integer	Read-only Current status of the quote (Open, Lost, Accepted).1 Open · 2 Lost · 3 Accepted
`formatted_name`	string	Read-only Display version of the quote name, used in lists and references.
`is_favorite`	boolean	Read-only True when the current authenticated user has marked this quote as favorite.
`modified_by_user`	date-time	Read-only Timestamp of the most recent modification made by an end user (excluding system changes).

Custom fields appear in your space's live spec: fetch it with your credentials.

Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.

HTTP	When
400	Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
401	Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404	No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
422	Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
429	Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500	Unexpected server error (code 1000, ERROR_UNKNOWN).

Webhook events for quotes

Quote.Create Quote.Delete Quote.DocumentLinked Quote.Lost Quote.Move Quote.OwnerChanged Quote.Update Quote.Won See payloads

Subscribe with Create a webhook.