Skip to content
Taylorz CRM Developers
Esc
↑↓navigate↵open⌘Jpreview

Read a quote

The quote, its current version with every line and schedule, and a summary of each version.

GET/api/v1/quotes/{id}
Authorization
AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access
Path parameters
idstringrequired

A quote's id

min length 1 · max length 255
Responses
200

The quote and its current version

linesQuoteLine[]required
Show properties
Array of QuoteLine
chargeTypestringrequired
Allowed:one_timerecurringmilestone
componentKindstringrequired
Allowed:producthardwaresoftwareserviceoptionpackage
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
descriptionstringrequired
discountAmountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
groupNamestring | nullrequired
idstringrequired
min length 1 · max length 255
netAmountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
organizationIdstringrequired
min length 1 · max length 255
positionintegerrequired
min -9007199254740991 · max 9007199254740991
priceSnapshotobjectrequired
pricingMethodstringrequired
Allowed:catalogcost_plusgross_marginmanualresale
productIdstring | nullrequired
Show properties
Any of:
string
string
null
null
quantitystringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
quoteVersionIdstringrequired
min length 1 · max length 255
sourceCostEntryIdstring | nullrequired
Show properties
Any of:
string
string
null
null
sourcePriceEntryIdstring | nullrequired
Show properties
Any of:
string
string
null
null
taxRatestringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
unitstringrequired
unitCoststring | nullrequired
Show properties
Any of:
string
string
null
null
unitPricestringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
quoteQuoterequired
Show properties
accountRecordIdstringrequired
min length 1 · max length 255
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
idstringrequired
min length 1 · max length 255
numberstringrequired
opportunityRecordIdstring | nullrequired
Show properties
Any of:
string
string
null
null
organizationIdstringrequired
min length 1 · max length 255
recordIdstringrequired
min length 1 · max length 255
schedulesobject[]required
Show properties
Array of object
scheduleQuoteSchedulerequired
Show properties
amountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
endsOnstring<date> | nullrequired
Show properties
Any of:
string<date>
string<date>
null
null
idstringrequired
min length 1 · max length 255
intervalMonthsinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
kindstringrequired
Allowed:one_timerecurringmilestone
milestoneLabelstring | nullrequired
organizationIdstringrequired
min length 1 · max length 255
quoteLineIdstringrequired
min length 1 · max length 255
sequenceintegerrequired
min -9007199254740991 · max 9007199254740991
startsOnstring<date> | nullrequired
Show properties
Any of:
string<date>
string<date>
null
null
versionQuoteVersionrequired
Show properties
contentHashstringrequired
cpqProfilestringrequired
Allowed:catalogprocurementhybrid
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
currencystringrequired
matches ^[A-Z]{3}$
customerSnapshotobjectrequired
discountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
frozenAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
idstringrequired
min length 1 · max length 255
organizationIdstringrequired
min length 1 · max length 255
policySnapshotobjectrequired
quoteIdstringrequired
min length 1 · max length 255
statestringrequired
Allowed:draftsubmittedapprovedrejectedacceptedsuperseded
subtotalstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
taxstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
taxableAmountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
totalstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
versionintegerrequired
min 1 · max 2147483647
versionsQuoteVersionSummary[]required
Show properties
Array of QuoteVersionSummary
contentHashstringrequired
discountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
frozenAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
idstringrequired
min length 1 · max length 255
statestringrequired
Allowed:draftsubmittedapprovedrejectedacceptedsuperseded
subtotalstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
taxstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
taxableAmountstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
totalstringrequired
matches ^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$
versionintegerrequired
min 1 · max 2147483647
400

The request body, query or parameters were refused

codestringrequired
Allowed:invalid_inputnot_foundconflictforbidden
detailany
errorstringrequired
reasonstring
401

The access token is missing, invalid or revoked

errorstringrequired
403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired
Allowed:invalid_inputnot_foundconflictforbidden
detailany
errorstringrequired
reasonstring
404

No such record, or none the caller may read

codestringrequired
Allowed:invalid_inputnot_foundconflictforbidden
detailany
errorstringrequired
reasonstring
413

The request exceeds the route's body limit

errorstringrequired
500

An unexpected failure

errorstringrequired
Request
curl -X GET '/api/v1/api/v1/quotes/string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "lines": [
    {
      "chargeType": "one_time",
      "componentKind": "product",
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "discountAmount": "string",
      "groupName": "string",
      "id": "string",
      "netAmount": "string",
      "organizationId": "string",
      "position": -9007199254740991,
      "priceSnapshot": {
        "property1": "string",
        "property2": "string"
      },
      "pricingMethod": "catalog",
      "productId": "string",
      "quantity": "string",
      "quoteVersionId": "string",
      "sourceCostEntryId": "string",
      "sourcePriceEntryId": "string",
      "taxRate": "string",
      "unit": "string",
      "unitCost": "string",
      "unitPrice": "string"
    }
  ],
  "quote": {
    "accountRecordId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "number": "string",
    "opportunityRecordId": "string",
    "organizationId": "string",
    "recordId": "string"
  },
  "schedules": [
    {
      "schedule": {
        "amount": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "endsOn": "2019-08-24",
        "id": "string",
        "intervalMonths": -9007199254740991,
        "kind": "one_time",
        "milestoneLabel": "string",
        "organizationId": "string",
        "quoteLineId": "string",
        "sequence": -9007199254740991,
        "startsOn": "2019-08-24"
      }
    }
  ],
  "version": {
    "contentHash": "string",
    "cpqProfile": "catalog",
    "createdAt": "2019-08-24T14:15:22Z",
    "currency": "string",
    "customerSnapshot": {
      "property1": "string",
      "property2": "string"
    },
    "discount": "string",
    "frozenAt": "2019-08-24T14:15:22Z",
    "id": "string",
    "organizationId": "string",
    "policySnapshot": {
      "property1": "string",
      "property2": "string"
    },
    "quoteId": "string",
    "state": "draft",
    "subtotal": "string",
    "tax": "string",
    "taxableAmount": "string",
    "total": "string",
    "version": 1
  },
  "versions": [
    {
      "contentHash": "string",
      "discount": "string",
      "frozenAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "state": "draft",
      "subtotal": "string",
      "tax": "string",
      "taxableAmount": "string",
      "total": "string",
      "version": 1
    }
  ]
}

Was this page helpful?