コンテンツにスキップ
Taylorz CRM Developers
Esc
↑↓移動↵開く⌘Jプレビュー

Read one version of a quote

The same shape as reading the quote, with the version asked for in place of the current one.

GET/api/v1/quotes/{id}/versions/{version}
認証
AuthorizationOAuth2 アクセストークン · header必須

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

スコープ:api.access
パスパラメーター
idstring必須

A quote's id

最小長 1 · 最大長 255
versioninteger必須

The version to read, counting from 1

最小 1
レスポンス
200

The quote at that version

linesQuoteLine[]必須
プロパティを表示
QuoteLine の配列
chargeTypestring必須
許可される値:one_timerecurringmilestone
componentKindstring必須
許可される値:producthardwaresoftwareserviceoptionpackage
createdAtstring<date-time>必須
^(?:(?:\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))$ に一致
descriptionstring必須
discountAmountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
groupNamestring | null必須
idstring必須
最小長 1 · 最大長 255
netAmountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
organizationIdstring必須
最小長 1 · 最大長 255
positioninteger必須
最小 -9007199254740991 · 最大 9007199254740991
priceSnapshotobject必須
pricingMethodstring必須
許可される値:catalogcost_plusgross_marginmanualresale
productIdstring | null必須
プロパティを表示
いずれか:
string
string
null
null
quantitystring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
quoteVersionIdstring必須
最小長 1 · 最大長 255
sourceCostEntryIdstring | null必須
プロパティを表示
いずれか:
string
string
null
null
sourcePriceEntryIdstring | null必須
プロパティを表示
いずれか:
string
string
null
null
taxRatestring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
unitstring必須
unitCoststring | null必須
プロパティを表示
いずれか:
string
string
null
null
unitPricestring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
quoteQuote必須
プロパティを表示
accountRecordIdstring必須
最小長 1 · 最大長 255
createdAtstring<date-time>必須
^(?:(?:\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))$ に一致
idstring必須
最小長 1 · 最大長 255
numberstring必須
opportunityRecordIdstring | null必須
プロパティを表示
いずれか:
string
string
null
null
organizationIdstring必須
最小長 1 · 最大長 255
recordIdstring必須
最小長 1 · 最大長 255
schedulesobject[]必須
プロパティを表示
object の配列
scheduleQuoteSchedule必須
プロパティを表示
amountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
createdAtstring<date-time>必須
^(?:(?:\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> | null必須
プロパティを表示
いずれか:
string<date>
string<date>
null
null
idstring必須
最小長 1 · 最大長 255
intervalMonthsinteger | null必須
プロパティを表示
いずれか:
integer
integer
null
null
kindstring必須
許可される値:one_timerecurringmilestone
milestoneLabelstring | null必須
organizationIdstring必須
最小長 1 · 最大長 255
quoteLineIdstring必須
最小長 1 · 最大長 255
sequenceinteger必須
最小 -9007199254740991 · 最大 9007199254740991
startsOnstring<date> | null必須
プロパティを表示
いずれか:
string<date>
string<date>
null
null
versionQuoteVersion必須
プロパティを表示
contentHashstring必須
cpqProfilestring必須
許可される値:catalogprocurementhybrid
createdAtstring<date-time>必須
^(?:(?:\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))$ に一致
currencystring必須
^[A-Z]{3}$ に一致
customerSnapshotobject必須
discountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
frozenAtstring<date-time> | null必須
プロパティを表示
いずれか:
string<date-time>
string<date-time>
null
null
idstring必須
最小長 1 · 最大長 255
organizationIdstring必須
最小長 1 · 最大長 255
policySnapshotobject必須
quoteIdstring必須
最小長 1 · 最大長 255
statestring必須
許可される値:draftsubmittedapprovedrejectedacceptedsuperseded
subtotalstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
taxstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
taxableAmountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
totalstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
versioninteger必須
最小 1 · 最大 2147483647
versionsQuoteVersionSummary[]必須
プロパティを表示
QuoteVersionSummary の配列
contentHashstring必須
discountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
frozenAtstring<date-time> | null必須
プロパティを表示
いずれか:
string<date-time>
string<date-time>
null
null
idstring必須
最小長 1 · 最大長 255
statestring必須
許可される値:draftsubmittedapprovedrejectedacceptedsuperseded
subtotalstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
taxstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
taxableAmountstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
totalstring必須
^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致
versioninteger必須
最小 1 · 最大 2147483647
400

The request body, query or parameters were refused

codestring必須
許可される値:invalid_inputnot_foundconflictforbidden
detailany
errorstring必須
reasonstring
401

The access token is missing, invalid or revoked

errorstring必須
403

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

codestring必須
許可される値:invalid_inputnot_foundconflictforbidden
detailany
errorstring必須
reasonstring
404

No such record, or none the caller may read

codestring必須
許可される値:invalid_inputnot_foundconflictforbidden
detailany
errorstring必須
reasonstring
413

The request exceeds the route's body limit

errorstring必須
500

An unexpected failure

errorstring必須
リクエスト
curl -X GET '/api/v1/api/v1/quotes/string/versions/1' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'
レスポンス
{
  "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
    }
  ]
}

このページは役に立ちましたか？