TMF648 v4 Customer Quote Management

GET List quotes

GET /quote

Retrieves a Quote entity. Attribute selection is enabled for first-level attributes.

Parameters

fields (query, string) Specifies the comma-separated properties to be included in the response. supported fields are category, description, state, quoteDate
offset (query, integer) Specifies the requested index for the start of the resources to be included in the response.
limit (query, integer) Specifies the requested number of the resources to be included in the response.
category (query, string) Filtering based on category. Category is used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. "enterprise", "residential", ...).
state (query, string) Filtering based on state. state is a quote state type (QuoteStateType). State of the quote described in the state-machine diagram.
quoteDate (query, datetime) Filtering based on quoteDate. quoteDate is a date time (DateTime). Date and time when the quote was created.
Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
Namespace (header, string) Specifies the namespace to use with the URL path.
Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.

Responses

200 Success

Media type: application/json. Schema: array of Quote_retrieve.

Array of Quote_retrieve.

Example

[
  {
    "category": "Existing Customer - Upgrade",
    "description": "TMF648 testing 1",
    "id": "00001204",
    "quoteDate": "2023-09-13T03:46:02Z",
    "state": "Draft",
    "agreement": [
        {
            "id": "00000945",
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contract/00000945"
        }
    ],
    "billingAccount": [
        {
            "id": "CD123",
            "name": "Acme",
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/CD123"
        }
    ],
    "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/quote/00001204",
    "version": "V1",
    "relatedParty": [
        {
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/1234",
            "id": "1234",
            "name": "Common Org Account",
            "role": "Account",
            "@referredType": "Account"
        },
        {
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contact/003Do00000PSgbhIAD",
            "id": "003Do00000PSgbhIAD",
            "name": "common",
            "role": "Contact",
            "@referredType": "Contact"
        }
    ],
    "contactMedium": [
        {
            "mediumType": "Email",
            "characteristic": {
                "contactType": "Email",
                "emailAddress": "abc@salesforce.com"
            }
        },
        {
            "mediumType": "Phone",
            "characteristic": {
                "contactType": "Phone",
                "phoneNumber": "(990) 099-7788"
            }
        },
        {
            "mediumType": "Fax",
            "characteristic": {
                "contactType": "Fax",
                "faxNumber": "abc"
            }
        }
    ],
  "quoteTotalPrice": [
      {
          "price": {
              "taxIncludedAmount": {
                  "unit" : "\$",
                  "value": 10.00
              }
          },
          "priceType": "Recurring"
      },
      {
          "price": {
              "taxIncludedAmount": {
                  "unit" : "\$",
                  "value": 0.00
              }
          },
          "priceType": "One-time"
      }
    ],
  "quoteItem": [
    {
      "id": "00001933",
      "action": "Add",
      "quantity": 1.00,
      "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/QuoteLineItem/00001933",
      "relatedParty": [
          {
              "id": "001Dp00000JGwiTIAT",
              "name": "Test Account",
              "role": "Service Account",
              "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/001Dp00000JGwiTIAT",
              "@referredType": "Account"
          }
      ],
      "productOffering": [
          {
              "id": "686c69b9-9def-2dc2-4f69-11141e9f92c5",
              "name": "TMF648 Product",
              "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Product2/686c69b9-9def-2dc2-4f69-11141e9f92c5",
              "@type": "Product2"
          }
      ]
    }
  ]
  },
  {
    "category": "Existing Customer - Downgrade",
    "description": "TMF648 testing",
    "id": "00001205",
    "quoteDate": "2023-09-13T03:46:20Z",
    "state": "In Review",
    "agreement": [
        {
            "id": "00000944",
            "name": "TMForum",
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contract/00000944"
        }
    ],
    "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/quote/00001205",
    "version": "V1",
    "contactMedium": [
        {
            "mediumType": "Email",
            "characteristic": {
                "contactType": "Email",
                "emailAddress": "abc@salesforce.com"
            }
        },
        {
            "mediumType": "Phone",
            "characteristic": {
                "contactType": "Phone",
                "phoneNumber": "(887) 788-5566"
            }
        },
        {
            "mediumType": "Fax",
            "characteristic": {
                "contactType": "Fax",
                "faxNumber": "xyz"
            }
        }
    ],
    "quoteTotalPrice": [
    {
        "price": {
            "taxIncludedAmount": {
                "unit" : "\$",
                "value": 10.00
            }
        },
        "priceType": "Recurring"
    },
    {
        "price": {
            "taxIncludedAmount": {
                "unit" : "\$",
                "value": 0.00
            }
        },
        "priceType": "One-time"
    }
  ],
  "quoteItem": [
    {
      "id": "00001933",
      "action": "Add",
      "quantity": 1.00,
      "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/QuoteLineItem/00001933",
      "relatedParty": [
          {
              "id": "001Dp00000JGwiTIAT",
              "name": "Test Account",
              "role": "Service Account",
              "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/001Dp00000JGwiTIAT",
              "@referredType": "Account"
          }
      ],
      "productOffering": [
          {
              "id": "686c69b9-9def-2dc2-4f69-11141e9f92c5",
              "name": "TMF648 Product",
              "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Product2/686c69b9-9def-2dc2-4f69-11141e9f92c5",
              "@type": "Product2"
          }
      ]
    }
  ]
  },
  {
    "category": "New Customer",
    "description": "TMF648 Testing 3",
    "id": "00001206",
    "quoteDate": "2023-09-13T03:46:35Z",
    "state": "Accepted",
    "agreement": [
        {
            "id": "00000944",
            "name": "TMForum",
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contract/00000944"
        }
    ],
    "billingAccount": [
        {
            "id": "CD123",
            "name": "Acme",
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/CD123"
        }
    ],
    "quoteTotalPrice": [
      {
          "price": {
              "taxIncludedAmount": {
                  "unit" : "\$",
                  "value": 10.00
              }
          },
          "priceType": "Recurring"
      },
      {
          "price": {
              "taxIncludedAmount": {
                  "unit" : "\$",
                  "value": 0.00
              }
          },
          "priceType": "One-time"
      }
    ],
    "effectiveQuoteCompletionDate": "2023-09-19T13:58:29Z",
    "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/quote/00001206",
    "version": "V1",
    "relatedParty": [
        {
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/1234",
            "id": "1234",
            "name": "Common Org Account",
            "role": "Account",
            "@referredType": "Account"
        },
        {
            "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Contact/003Do00000PSgbhIAD",
            "id": "003Do00000PSgbhIAD",
            "name": "common",
            "role": "Contact",
            "@referredType": "Contact"
        }
    ],
    "quoteItem": [
      {
        "id": "00001933",
        "action": "Add",
        "quantity": 1.00,
        "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/QuoteLineItem/00001933",
        "relatedParty": [
            {
                "id": "001Dp00000JGwiTIAT",
                "name": "Test Account",
                "role": "Service Account",
                "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Account/001Dp00000JGwiTIAT",
                "@referredType": "Account"
            }
        ],
        "productOffering": [
            {
                "id": "686c69b9-9def-2dc2-4f69-11141e9f92c5",
                "name": "TMF648 Product",
                "href": "/services/apexrest/vlocity_cmt/tmforum/quotemanagement/v57.0/Product2/686c69b9-9def-2dc2-4f69-11141e9f92c5",
                "@type": "Product2"
            }
        ]
      }
    ],
    "contactMedium": [
      {
          "mediumType": "Email",
          "characteristic": {
              "contactType": "Email",
              "emailAddress": "xyz@salesforce.com"
          }
      },
      {
          "mediumType": "Phone",
          "characteristic": {
              "contactType": "Phone",
              "phoneNumber": "(999) 222-8881"
          }
      },
      {
          "mediumType": "Fax",
          "characteristic": {
              "contactType": "Fax",
              "faxNumber": "xyz"
          }
      }
    ]
  }
]

404 Resource not found.
Media type: application/json. Schema: Error.

Example
```
code: NOT_FOUND
reason: There are no matching resource.
```
500 Unable to complete the request as the server encountered an error.
Media type: application/json. Schema: Error.

Example
```
code: "500"
reason: Internal Server Error
```