Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Creating and Editing Quotes

This use case describes how to create and edit quotes, which is a formal statement of promise that lists the products and services to be sold to a customer at a defined price. Quote creation involves configuring products and services, pricing them, and generating quotes based on predefined rules. Implementation teams can use these APIs to build quoting functionalities necessary to prepare a quote by providing relevant details.

Creating a Quote

You can create one or more quotes by providing the quote name, price list ID, and price list name in the request. Provide other relevant quote details as it is a good practice to pass as many fields in the request body as are needed to pre-populate the quote. For example, it is recommended to populate the Account related fields.

Prerequisite

You must gather the following details to create a quote.
  • Price List ID
  • Price List Name

You can use the GET/price-lists API to retrieve all price lists in the system. For more information, see Pricing Setup APIs.

Example of Retrieving Quote Details

The following table lists the API method, endpoints, and sample codes for request and response, to retrieve the details of a quote:

Method

GET

Endpoint

/quotes/{quoteId}

Request Parameters

The following URL parameter is used to pass the quote ID. You can use the value 'items' in the includes parameter to proposal line items associated with the given quote. For this example, only the ID of the quote is passed.

Parameters

Values

quoteID

8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863

This quote was generated in the "Create a quote" section, using the POST/quotesAPI and its ID was retrieved using the GET/quotes API.

Request URL

https://<URL_of_the_Instance>/api/quote/v1/quotes/8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863

Response

The API retrieves the structure of the quote.

Response Body Expand source
{
  "ABOType": "New",
  "Account": {
    "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
    "Name": "AutoQuoteRLPAccount_"
  },
  "Amount": null,
  "ApprovalStage": "Draft",
  "AutoActivateOrder": false,
  "AutoCreateBill": false,
  "AutoCreateRevenue": false,
  "BillingPreference": null,
  "BillToAccount": null,
  "ConfigurationEffectiveDate": null,
  "ConfigurationFinalizedDate": null,
  "ConfigurationSyncDate": null,
  "Currency": "USD",
  "Description": "Tier 2 Quote",
  "DisableCartVersioning": false,
  "DiscountPercent": null,
  "ExpectedEndDate": null,
  "ExpectedStartDate": null,
  "GrandTotal": null,
  "Intent": null,
  "InternalDeadline": null,
  "IsAutoAccepted": false,
  "IsPrimary": true,
  "IsSystemGenerated": false,
  "IsTaskPending": false,
  "LegalEntity": null,
  "Location": {
    "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
    "Name": "Ahmedabad"
  },
  "NetAmount": null,
  "Opportunity": {
    "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
    "Name": "AutoQuoteRLPOpportunity"
  },
  "ParentProposal": null,
  "PartnerAccount": null,
  "ProposalPaymentTerm": "Net 30 Days",
  "PaymentTerm": null,
  "PODate": null,
  "PONumber": null,
  "PresentedDate": null,
  "PriceList": {
    "Id": "8bea2478-428c-4421-afcd-97e327dad477",
    "Name": "AutoQuoteRLP_QuotePL"
  },
  "PricingDate": null,
  "PrimaryContact": null,
  "ProposalApprovalDate": null,
  "ProposalCategory": "Quote",
  "ProposalExpirationDate": null,
  "ProposalName": null,
  "PurchaseId": null,
  "QTCProfile": null,
  "ReadyForActivationDate": null,
  "ReadyForBillingDate": null,
  "ReadyForFulfillmentDate": null,
  "ReadyForRevRecDate": null,
  "ReadyToGenerate": true,
  "ReadyToPresent": true,
  "RelatedProposal": null,
  "RFPIntakeDate": null,
  "RFPResponseDueDate": null,
  "RFPStage": null,
  "RFPValue": null,
  "RiskFactors": null,
  "SalesTaxAmount": null,
  "SalesTaxPercent": null,
  "ShippingHandling": null,
  "ShipToAccount": null,
  "SingleTransactionAdjustment": false,
  "SourceChannel": "Direct",
  "SpecialTerms": null,
  "StrategicImportance": null,
  "SyncAssetChangesToQuote": true,
  "UseType": "Main",
  "ValidUntilDate": null,
  "Id": "8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863",
  "Name": "Tier_2",
  "CreatedBy": {
    "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "Name": "Test Manish User"
  },
  "CreatedDate": "2022-12-27T20:04:29",
  "ModifiedBy": {
    "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "Name": "Test Manish User"
  },
  "ModifiedDate": "2022-12-27T20:04:29",
  "ExternalId": null,
  "QuoteAuto_PickList_CstField_c": null,
  "QuoteAuto_String_CstField_c": null,
  "QuoteAuto_Double_CstField_c": null,
  "QuoteAuto_Int_CstField_c": null,
  "QuoteAuto_Boolean_CstField_c": null,
  "QuoteAuto_Currency_CstField_c": null,
  "QuoteAuto_DateTime_CstField_c": null,
  "QuoteAuto_Multipicklist_CstField_c": null
}

Example for Creating Multiple Quotes

The following table list the API method, endpoints, and sample codes for request and responses to create more than one quote:

Method

POST

Endpoint

/quotes

Request URL

https://<URL_of_the_Instance>/api/quote/v1/quotes

Request

The following sample code creates quotes with the following names with AutoQuoteRLP_QuotePL pricelist.

  • Tier_2
  • Tier_3
[
	{
		"Name": "Tier_2",
		"ProposalCategory": "Quote",
		"PriceList": {
		  "Id": "8bea2478-428c-4421-afcd-97e327dad477",
		  "Name": "AutoQuoteRLP_QuotePL"
		},
		"Account": {
		  "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
		  "Name": "AutoQuoteRLPAccount_"
		},
		"Description": "Tier 2 Quote",
		"Location": {
		  "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
		  "Name": "Ahmedabad"
		},
		 "Opportunity": {
		  "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
		  "Name": "AutoQuoteRLPOpportunity"
		}
	},
	{
		"Name": "Tier_3",
		"ProposalCategory": "Quote",
		"PriceList": {
		  "Id": "8bea2478-428c-4421-afcd-97e327dad477",
		  "Name": "AutoQuoteRLP_QuotePL"
		},
		"Account": {
		  "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
		  "Name": "AutoQuoteRLPAccount_"
		},
		"Currency": "USD",
		"Description": "Tier 3 Quote",
		"Location": {
		  "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
		  "Name": "Ahmedabad"
		},
		 "Opportunity": {
		  "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
		  "Name": "AutoQuoteRLPOpportunity"
		}
	}
]

Response

The API returns the structure of the newly created quotes.

Response Body Expand source
[
  {
    "ABOType": "New",
    "Account": {
      "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
      "Name": "AutoQuoteRLPAccount_"
    },
    "Amount": null,
    "ApprovalStage": "Draft",
    "AutoActivateOrder": false,
    "AutoCreateBill": false,
    "AutoCreateRevenue": false,
    "BillingPreference": null,
    "BillToAccount": null,
    "ConfigurationEffectiveDate": null,
    "ConfigurationFinalizedDate": null,
    "ConfigurationSyncDate": null,
    "Currency": "USD",
    "Description": "Tier 2 Quote",
    "DisableCartVersioning": false,
    "DiscountPercent": null,
    "ExpectedEndDate": null,
    "ExpectedStartDate": null,
    "GrandTotal": null,
    "Intent": null,
    "InternalDeadline": null,
    "IsAutoAccepted": false,
    "IsPrimary": true,
    "IsSystemGenerated": false,
    "IsTaskPending": false,
    "LegalEntity": null,
    "Location": {
      "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
      "Name": "Ahmedabad"
    },
    "NetAmount": null,
    "Opportunity": {
      "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
      "Name": "AutoQuoteRLPOpportunity"
    },
    "ParentProposal": null,
    "PartnerAccount": null,
    "ProposalPaymentTerm": "Net 30 Days",
    "PaymentTerm": null,
    "PODate": null,
    "PONumber": null,
    "PresentedDate": null,
    "PriceList": {
      "Id": "8bea2478-428c-4421-afcd-97e327dad477",
      "Name": "AutoQuoteRLP_QuotePL"
    },
    "PricingDate": null,
    "PrimaryContact": null,
    "ProposalApprovalDate": null,
    "ProposalCategory": "Quote",
    "ProposalExpirationDate": null,
    "ProposalName": null,
    "PurchaseId": null,
    "QTCProfile": null,
    "ReadyForActivationDate": null,
    "ReadyForBillingDate": null,
    "ReadyForFulfillmentDate": null,
    "ReadyForRevRecDate": null,
    "ReadyToGenerate": true,
    "ReadyToPresent": true,
    "RelatedProposal": null,
    "RFPIntakeDate": null,
    "RFPResponseDueDate": null,
    "RFPStage": null,
    "RFPValue": null,
    "RiskFactors": null,
    "SalesTaxAmount": null,
    "SalesTaxPercent": null,
    "ShippingHandling": null,
    "ShipToAccount": null,
    "SingleTransactionAdjustment": false,
    "SourceChannel": "Direct",
    "SpecialTerms": null,
    "StrategicImportance": null,
    "SyncAssetChangesToQuote": true,
    "UseType": "Main",
    "ValidUntilDate": null,
    "Id": "8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863",
    "Name": "Tier_2",
    "CreatedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "CreatedDate": "2022-12-27T20:04:29.9468282",
    "ModifiedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "ModifiedDate": "2022-12-27T20:04:29.9468282",
    "ExternalId": null,
    "QuoteAuto_PickList_CstField_c": null,
    "QuoteAuto_String_CstField_c": null,
    "QuoteAuto_Double_CstField_c": null,
    "QuoteAuto_Int_CstField_c": null,
    "QuoteAuto_Boolean_CstField_c": null,
    "QuoteAuto_Currency_CstField_c": null,
    "QuoteAuto_DateTime_CstField_c": null,
    "QuoteAuto_Multipicklist_CstField_c": null
  },
  {
    "ABOType": "New",
    "Account": {
      "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
      "Name": "AutoQuoteRLPAccount_"
    },
    "Amount": null,
    "ApprovalStage": "Draft",
    "AutoActivateOrder": false,
    "AutoCreateBill": false,
    "AutoCreateRevenue": false,
    "BillingPreference": null,
    "BillToAccount": null,
    "ConfigurationEffectiveDate": null,
    "ConfigurationFinalizedDate": null,
    "ConfigurationSyncDate": null,
    "Currency": "USD",
    "Description": "Tier 3 Quote",
    "DisableCartVersioning": false,
    "DiscountPercent": null,
    "ExpectedEndDate": null,
    "ExpectedStartDate": null,
    "GrandTotal": null,
    "Intent": null,
    "InternalDeadline": null,
    "IsAutoAccepted": false,
    "IsPrimary": true,
    "IsSystemGenerated": false,
    "IsTaskPending": false,
    "LegalEntity": null,
    "Location": {
      "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
      "Name": "Ahmedabad"
    },
    "NetAmount": null,
    "Opportunity": {
      "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
      "Name": "AutoQuoteRLPOpportunity"
    },
    "ParentProposal": null,
    "PartnerAccount": null,
    "ProposalPaymentTerm": "Net 30 Days",
    "PaymentTerm": null,
    "PODate": null,
    "PONumber": null,
    "PresentedDate": null,
    "PriceList": {
      "Id": "8bea2478-428c-4421-afcd-97e327dad477",
      "Name": "AutoQuoteRLP_QuotePL"
    },
    "PricingDate": null,
    "PrimaryContact": null,
    "ProposalApprovalDate": null,
    "ProposalCategory": "Quote",
    "ProposalExpirationDate": null,
    "ProposalName": null,
    "PurchaseId": null,
    "QTCProfile": null,
    "ReadyForActivationDate": null,
    "ReadyForBillingDate": null,
    "ReadyForFulfillmentDate": null,
    "ReadyForRevRecDate": null,
    "ReadyToGenerate": true,
    "ReadyToPresent": true,
    "RelatedProposal": null,
    "RFPIntakeDate": null,
    "RFPResponseDueDate": null,
    "RFPStage": null,
    "RFPValue": null,
    "RiskFactors": null,
    "SalesTaxAmount": null,
    "SalesTaxPercent": null,
    "ShippingHandling": null,
    "ShipToAccount": null,
    "SingleTransactionAdjustment": false,
    "SourceChannel": "Direct",
    "SpecialTerms": null,
    "StrategicImportance": null,
    "SyncAssetChangesToQuote": true,
    "UseType": "Main",
    "ValidUntilDate": null,
    "Id": "4d444f87-ff0c-4955-b742-74576f86ba58",
    "Name": "Tier_3",
    "CreatedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "CreatedDate": "2022-12-27T20:04:29.9477331",
    "ModifiedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "ModifiedDate": "2022-12-27T20:04:29.9477331",
    "ExternalId": null,
    "QuoteAuto_PickList_CstField_c": null,
    "QuoteAuto_String_CstField_c": null,
    "QuoteAuto_Double_CstField_c": null,
    "QuoteAuto_Int_CstField_c": null,
    "QuoteAuto_Boolean_CstField_c": null,
    "QuoteAuto_Currency_CstField_c": null,
    "QuoteAuto_DateTime_CstField_c": null,
    "QuoteAuto_Multipicklist_CstField_c": null
  }
]

Retrieving List of Quotes

You can retrieve all quotes with their details where the requester is the creator, owner of, or has access to the quote. Retrieving quotes helps you explore the quote as it moves through the quote life cycle.

Prerequisite

You must have existing quotes in the system which you have created or that you own or have access to.

Example of Retrieving a Quote

The following table lists the API method, endpoints, and sample codes for request and response, to retrieve a quote:

Method

GET

Endpoint

/quotes

Request Parameters

The following URL parameters are used to narrow down the search result to specifically retrieve quote names containing the string "Tier".

Parameters

Values

page

1

limit

2

sort

asc(Name)

filter

like(Name: 'Tier' )

Request URL

https://<URL_of_the_Instance>/api/quote/v1/quotes?filter=like%28Name%3A%20%27Tier%27%20%29&sort=asc%28Name%29&page=1&limit=2

Response

The API returns all details associated with the retrieved quotes.

Response Body Expand source
[
  {
    "ABOType": "New",
    "Account": {
      "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
      "Name": "AutoQuoteRLPAccount_"
    },
    "Amount": null,
    "ApprovalStage": "Draft",
    "AutoActivateOrder": false,
    "AutoCreateBill": false,
    "AutoCreateRevenue": false,
    "BillingPreference": null,
    "BillToAccount": null,
    "ConfigurationEffectiveDate": null,
    "ConfigurationFinalizedDate": null,
    "ConfigurationSyncDate": null,
    "Currency": "USD",
    "Description": "AutoQuoteService_Description1667823791262_57",
    "DisableCartVersioning": false,
    "DiscountPercent": null,
    "ExpectedEndDate": null,
    "ExpectedStartDate": null,
    "GrandTotal": null,
    "Intent": null,
    "InternalDeadline": null,
    "IsAutoAccepted": false,
    "IsPrimary": true,
    "IsSystemGenerated": false,
    "IsTaskPending": false,
    "LegalEntity": null,
    "Location": {
      "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
      "Name": "Ahmedabad"
    },
    "NetAmount": null,
    "Opportunity": {
      "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
      "Name": "AutoQuoteRLPOpportunity"
    },
    "ParentProposal": null,
    "PartnerAccount": null,
    "ProposalPaymentTerm": "Net 30 Days",
    "PaymentTerm": null,
    "PODate": null,
    "PONumber": null,
    "PresentedDate": null,
    "PriceList": {
      "Id": "8bea2478-428c-4421-afcd-97e327dad477",
      "Name": "AutoQuoteRLP_QuotePL"
    },
    "PricingDate": null,
    "PrimaryContact": null,
    "ProposalApprovalDate": null,
    "ProposalCategory": "Quote",
    "ProposalExpirationDate": null,
    "ProposalName": null,
    "PurchaseId": null,
    "QTCProfile": null,
    "ReadyForActivationDate": null,
    "ReadyForBillingDate": null,
    "ReadyForFulfillmentDate": null,
    "ReadyForRevRecDate": null,
    "ReadyToGenerate": true,
    "ReadyToPresent": true,
    "RelatedProposal": null,
    "RFPIntakeDate": null,
    "RFPResponseDueDate": null,
    "RFPStage": null,
    "RFPValue": null,
    "RiskFactors": null,
    "SalesTaxAmount": null,
    "SalesTaxPercent": null,
    "ShippingHandling": null,
    "ShipToAccount": null,
    "SingleTransactionAdjustment": false,
    "SourceChannel": "Direct",
    "SpecialTerms": null,
    "StrategicImportance": null,
    "SyncAssetChangesToQuote": true,
    "UseType": "Main",
    "ValidUntilDate": null,
    "Id": "75723d17-937e-4213-89f8-41a8f2c81594",
    "Name": "Tier_1",
    "CreatedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "CreatedDate": "2022-12-27T18:54:56",
    "ModifiedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "ModifiedDate": "2022-12-27T18:54:56",
    "ExternalId": null,
    "QuoteAuto_PickList_CstField_c": null,
    "QuoteAuto_String_CstField_c": null,
    "QuoteAuto_Double_CstField_c": null,
    "QuoteAuto_Int_CstField_c": null,
    "QuoteAuto_Boolean_CstField_c": null,
    "QuoteAuto_Currency_CstField_c": null,
    "QuoteAuto_DateTime_CstField_c": null,
    "QuoteAuto_Multipicklist_CstField_c": null
  },
  {
    "ABOType": "New",
    "Account": {
      "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
      "Name": "AutoQuoteRLPAccount_"
    },
    "Amount": null,
    "ApprovalStage": "Draft",
    "AutoActivateOrder": false,
    "AutoCreateBill": false,
    "AutoCreateRevenue": false,
    "BillingPreference": null,
    "BillToAccount": null,
    "ConfigurationEffectiveDate": null,
    "ConfigurationFinalizedDate": null,
    "ConfigurationSyncDate": null,
    "Currency": "USD",
    "Description": "Tier 2 Quote",
    "DisableCartVersioning": false,
    "DiscountPercent": null,
    "ExpectedEndDate": null,
    "ExpectedStartDate": null,
    "GrandTotal": null,
    "Intent": null,
    "InternalDeadline": null,
    "IsAutoAccepted": false,
    "IsPrimary": true,
    "IsSystemGenerated": false,
    "IsTaskPending": false,
    "LegalEntity": null,
    "Location": {
      "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
      "Name": "Ahmedabad"
    },
    "NetAmount": null,
    "Opportunity": {
      "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
      "Name": "AutoQuoteRLPOpportunity"
    },
    "ParentProposal": null,
    "PartnerAccount": null,
    "ProposalPaymentTerm": "Net 30 Days",
    "PaymentTerm": null,
    "PODate": null,
    "PONumber": null,
    "PresentedDate": null,
    "PriceList": {
      "Id": "8bea2478-428c-4421-afcd-97e327dad477",
      "Name": "AutoQuoteRLP_QuotePL"
    },
    "PricingDate": null,
    "PrimaryContact": null,
    "ProposalApprovalDate": null,
    "ProposalCategory": "Quote",
    "ProposalExpirationDate": null,
    "ProposalName": null,
    "PurchaseId": null,
    "QTCProfile": null,
    "ReadyForActivationDate": null,
    "ReadyForBillingDate": null,
    "ReadyForFulfillmentDate": null,
    "ReadyForRevRecDate": null,
    "ReadyToGenerate": true,
    "ReadyToPresent": true,
    "RelatedProposal": null,
    "RFPIntakeDate": null,
    "RFPResponseDueDate": null,
    "RFPStage": null,
    "RFPValue": null,
    "RiskFactors": null,
    "SalesTaxAmount": null,
    "SalesTaxPercent": null,
    "ShippingHandling": null,
    "ShipToAccount": null,
    "SingleTransactionAdjustment": false,
    "SourceChannel": "Direct",
    "SpecialTerms": null,
    "StrategicImportance": null,
    "SyncAssetChangesToQuote": true,
    "UseType": "Main",
    "ValidUntilDate": null,
    "Id": "8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863",
    "Name": "Tier_2",
    "CreatedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "CreatedDate": "2022-12-27T20:04:29",
    "ModifiedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "ModifiedDate": "2022-12-27T20:04:29",
    "ExternalId": null,
    "QuoteAuto_PickList_CstField_c": null,
    "QuoteAuto_String_CstField_c": null,
    "QuoteAuto_Double_CstField_c": null,
    "QuoteAuto_Int_CstField_c": null,
    "QuoteAuto_Boolean_CstField_c": null,
    "QuoteAuto_Currency_CstField_c": null,
    "QuoteAuto_DateTime_CstField_c": null,
    "QuoteAuto_Multipicklist_CstField_c": null
  }
]

Retrieving Quote Details: Header Information

You can retrieve the details of a specific quote by passing the quote ID. The API returns the quote header fields, pricing, and quote line items among other details

Prerequisite:

You must have the Quote ID to create a quote.

You can create a new quote and extract the quote ID from the response, create a quote using POST/quotes, or retrieve existing quotes using GET/quotes. For more information, see the "Creating a Quote" and "Retrieving List of Quotes" sections or see Quoting APIs.

Example of Retrieving Quote Details

The following table lists the API method, endpoints, and sample codes for request and response, to retrieve the details of a quote:

Method

GET

Endpoint

/quotes/{quoteId}

Request Parameters

The following URL parameter is used to pass the quote ID. You can use the value 'items' in the includes parameter to proposal line items associated with the given quote. For this example, only the ID of the quote is passed.

Parameters

Values

quoteID

8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863

This quote was generated in the "Create a quote" section, using the POST/quotesAPI and its ID was retrieved using the GET/quotes API.

Request URL

https://<URL_of_the_Instance>/api/quote/v1/quotes/8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863

Response

The API retrieves the structure of the quote.

Response Body Expand source
{
  "ABOType": "New",
  "Account": {
    "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
    "Name": "AutoQuoteRLPAccount_"
  },
  "Amount": null,
  "ApprovalStage": "Draft",
  "AutoActivateOrder": false,
  "AutoCreateBill": false,
  "AutoCreateRevenue": false,
  "BillingPreference": null,
  "BillToAccount": null,
  "ConfigurationEffectiveDate": null,
  "ConfigurationFinalizedDate": null,
  "ConfigurationSyncDate": null,
  "Currency": "USD",
  "Description": "Tier 2 Quote",
  "DisableCartVersioning": false,
  "DiscountPercent": null,
  "ExpectedEndDate": null,
  "ExpectedStartDate": null,
  "GrandTotal": null,
  "Intent": null,
  "InternalDeadline": null,
  "IsAutoAccepted": false,
  "IsPrimary": true,
  "IsSystemGenerated": false,
  "IsTaskPending": false,
  "LegalEntity": null,
  "Location": {
    "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
    "Name": "Ahmedabad"
  },
  "NetAmount": null,
  "Opportunity": {
    "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
    "Name": "AutoQuoteRLPOpportunity"
  },
  "ParentProposal": null,
  "PartnerAccount": null,
  "ProposalPaymentTerm": "Net 30 Days",
  "PaymentTerm": null,
  "PODate": null,
  "PONumber": null,
  "PresentedDate": null,
  "PriceList": {
    "Id": "8bea2478-428c-4421-afcd-97e327dad477",
    "Name": "AutoQuoteRLP_QuotePL"
  },
  "PricingDate": null,
  "PrimaryContact": null,
  "ProposalApprovalDate": null,
  "ProposalCategory": "Quote",
  "ProposalExpirationDate": null,
  "ProposalName": null,
  "PurchaseId": null,
  "QTCProfile": null,
  "ReadyForActivationDate": null,
  "ReadyForBillingDate": null,
  "ReadyForFulfillmentDate": null,
  "ReadyForRevRecDate": null,
  "ReadyToGenerate": true,
  "ReadyToPresent": true,
  "RelatedProposal": null,
  "RFPIntakeDate": null,
  "RFPResponseDueDate": null,
  "RFPStage": null,
  "RFPValue": null,
  "RiskFactors": null,
  "SalesTaxAmount": null,
  "SalesTaxPercent": null,
  "ShippingHandling": null,
  "ShipToAccount": null,
  "SingleTransactionAdjustment": false,
  "SourceChannel": "Direct",
  "SpecialTerms": null,
  "StrategicImportance": null,
  "SyncAssetChangesToQuote": true,
  "UseType": "Main",
  "ValidUntilDate": null,
  "Id": "8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863",
  "Name": "Tier_2",
  "CreatedBy": {
    "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "Name": "Test Manish User"
  },
  "CreatedDate": "2022-12-27T20:04:29",
  "ModifiedBy": {
    "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "Name": "Test Manish User"
  },
  "ModifiedDate": "2022-12-27T20:04:29",
  "ExternalId": null,
  "QuoteAuto_PickList_CstField_c": null,
  "QuoteAuto_String_CstField_c": null,
  "QuoteAuto_Double_CstField_c": null,
  "QuoteAuto_Int_CstField_c": null,
  "QuoteAuto_Boolean_CstField_c": null,
  "QuoteAuto_Currency_CstField_c": null,
  "QuoteAuto_DateTime_CstField_c": null,
  "QuoteAuto_Multipicklist_CstField_c": null
}

Editing a Quote

You can update one or more quotes by passing the updates in the request body. You can update the quote header field details of any quote that is not in the accepted state.

Prerequisites

You must gather the following details to create a quote.

  • Quote ID
  • Quote object details

You can retrieve existing quotes using the GET/quotes API and extract quote ID from the response. In case you have Quote ID, you can also extract the quote object details using the GET/quotes/{quoteId} API For more information, see the "Retrieving List of Quotes" or "Retrieving Quote Details (header information)" sections or see Quoting APIs.

Example of Updating Quotes

The following table lists the API method, endpoints, and sample codes for requests and responses, to update quotes:

Method

PATCH

Endpoint

/quotes

Request URL

https://<URL_of_the_Instance>/api/quote/v1/quotes

Request Body

The below sample code updates the pricelist associated with the quotes with the following IDs, which were generated in the section Creating quotes.

  • 75723d17-937e-4213-89f8-41a8f2c81594
  • 8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863
[
	{
		"Id": "75723d17-937e-4213-89f8-41a8f2c81594",
		"PriceList": {
		  "Id": "b01c1010-9381-4335-88a5-8323378b86a0",
		  "Name": "Auto_IncOtoOPromptELevel2_PL001"
		}
	},
	{
		"Id": "8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863",
		"PriceList": {
		  "Id": "b01c1010-9381-4335-88a5-8323378b86a0",
		  "Name": "Auto_IncOtoOPromptELevel2_PL001"
		}
	}
]

Response

The API returns the structure of the updated quotes.

Response Body Expand source
[
  {
    "ABOType": "New",
    "Account": {
      "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
      "Name": "AutoQuoteRLPAccount_"
    },
    "Amount": null,
    "ApprovalStage": "Draft",
    "AutoActivateOrder": false,
    "AutoCreateBill": false,
    "AutoCreateRevenue": false,
    "BillingPreference": null,
    "BillToAccount": null,
    "ConfigurationEffectiveDate": null,
    "ConfigurationFinalizedDate": null,
    "ConfigurationSyncDate": null,
    "Currency": "USD",
    "Description": "AutoQuoteService_Description1667823791262_57",
    "DisableCartVersioning": false,
    "DiscountPercent": null,
    "ExpectedEndDate": null,
    "ExpectedStartDate": null,
    "GrandTotal": null,
    "Intent": null,
    "InternalDeadline": null,
    "IsAutoAccepted": false,
    "IsPrimary": true,
    "IsSystemGenerated": false,
    "IsTaskPending": false,
    "LegalEntity": null,
    "Location": {
      "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
      "Name": "Ahmedabad"
    },
    "NetAmount": null,
    "Opportunity": {
      "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
      "Name": "AutoQuoteRLPOpportunity"
    },
    "ParentProposal": null,
    "PartnerAccount": null,
    "ProposalPaymentTerm": "Net 30 Days",
    "PaymentTerm": null,
    "PODate": null,
    "PONumber": null,
    "PresentedDate": null,
    "PriceList": {
      "Id": "b01c1010-9381-4335-88a5-8323378b86a0",
      "Name": "Auto_IncOtoOPromptELevel2_PL001"
    },
    "PricingDate": null,
    "PrimaryContact": null,
    "ProposalApprovalDate": null,
    "ProposalCategory": "Quote",
    "ProposalExpirationDate": null,
    "ProposalName": null,
    "PurchaseId": null,
    "QTCProfile": null,
    "ReadyForActivationDate": null,
    "ReadyForBillingDate": null,
    "ReadyForFulfillmentDate": null,
    "ReadyForRevRecDate": null,
    "ReadyToGenerate": true,
    "ReadyToPresent": true,
    "RelatedProposal": null,
    "RFPIntakeDate": null,
    "RFPResponseDueDate": null,
    "RFPStage": null,
    "RFPValue": null,
    "RiskFactors": null,
    "SalesTaxAmount": null,
    "SalesTaxPercent": null,
    "ShippingHandling": null,
    "ShipToAccount": null,
    "SingleTransactionAdjustment": false,
    "SourceChannel": "Direct",
    "SpecialTerms": null,
    "StrategicImportance": null,
    "SyncAssetChangesToQuote": true,
    "UseType": "Main",
    "ValidUntilDate": null,
    "Id": "75723d17-937e-4213-89f8-41a8f2c81594",
    "Name": "Tier_1",
    "CreatedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "CreatedDate": "2022-12-27T18:54:56",
    "ModifiedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "ModifiedDate": "2022-12-27T21:33:46.3875832",
    "ExternalId": null,
    "QuoteAuto_PickList_CstField_c": null,
    "QuoteAuto_String_CstField_c": null,
    "QuoteAuto_Double_CstField_c": null,
    "QuoteAuto_Int_CstField_c": null,
    "QuoteAuto_Boolean_CstField_c": null,
    "QuoteAuto_Currency_CstField_c": null,
    "QuoteAuto_DateTime_CstField_c": null,
    "QuoteAuto_Multipicklist_CstField_c": null
  },
  {
    "ABOType": "New",
    "Account": {
      "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
      "Name": "AutoQuoteRLPAccount_"
    },
    "Amount": null,
    "ApprovalStage": "Draft",
    "AutoActivateOrder": false,
    "AutoCreateBill": false,
    "AutoCreateRevenue": false,
    "BillingPreference": null,
    "BillToAccount": null,
    "ConfigurationEffectiveDate": null,
    "ConfigurationFinalizedDate": null,
    "ConfigurationSyncDate": null,
    "Currency": "USD",
    "Description": "Tier 2 Quote",
    "DisableCartVersioning": false,
    "DiscountPercent": null,
    "ExpectedEndDate": null,
    "ExpectedStartDate": null,
    "GrandTotal": null,
    "Intent": null,
    "InternalDeadline": null,
    "IsAutoAccepted": false,
    "IsPrimary": true,
    "IsSystemGenerated": false,
    "IsTaskPending": false,
    "LegalEntity": null,
    "Location": {
      "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
      "Name": "Ahmedabad"
    },
    "NetAmount": null,
    "Opportunity": {
      "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
      "Name": "AutoQuoteRLPOpportunity"
    },
    "ParentProposal": null,
    "PartnerAccount": null,
    "ProposalPaymentTerm": "Net 30 Days",
    "PaymentTerm": null,
    "PODate": null,
    "PONumber": null,
    "PresentedDate": null,
    "PriceList": {
      "Id": "b01c1010-9381-4335-88a5-8323378b86a0",
      "Name": "Auto_IncOtoOPromptELevel2_PL001"
    },
    "PricingDate": null,
    "PrimaryContact": null,
    "ProposalApprovalDate": null,
    "ProposalCategory": "Quote",
    "ProposalExpirationDate": null,
    "ProposalName": null,
    "PurchaseId": null,
    "QTCProfile": null,
    "ReadyForActivationDate": null,
    "ReadyForBillingDate": null,
    "ReadyForFulfillmentDate": null,
    "ReadyForRevRecDate": null,
    "ReadyToGenerate": true,
    "ReadyToPresent": true,
    "RelatedProposal": null,
    "RFPIntakeDate": null,
    "RFPResponseDueDate": null,
    "RFPStage": null,
    "RFPValue": null,
    "RiskFactors": null,
    "SalesTaxAmount": null,
    "SalesTaxPercent": null,
    "ShippingHandling": null,
    "ShipToAccount": null,
    "SingleTransactionAdjustment": false,
    "SourceChannel": "Direct",
    "SpecialTerms": null,
    "StrategicImportance": null,
    "SyncAssetChangesToQuote": true,
    "UseType": "Main",
    "ValidUntilDate": null,
    "Id": "8cae6d8a-2a3b-4c1c-bf64-8ddef14dc863",
    "Name": "Tier_2",
    "CreatedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "CreatedDate": "2022-12-27T20:04:29",
    "ModifiedBy": {
      "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
      "Name": "Test Manish User"
    },
    "ModifiedDate": "2022-12-27T21:33:46.3867949",
    "ExternalId": null,
    "QuoteAuto_PickList_CstField_c": null,
    "QuoteAuto_String_CstField_c": null,
    "QuoteAuto_Double_CstField_c": null,
    "QuoteAuto_Int_CstField_c": null,
    "QuoteAuto_Boolean_CstField_c": null,
    "QuoteAuto_Currency_CstField_c": null,
    "QuoteAuto_DateTime_CstField_c": null,
    "QuoteAuto_Multipicklist_CstField_c": null
  }
]

Example of Updating Specific Quote

The following table list the API method, endpoints, and sample codes for requests and responses, to update a specific quote:

Method

PATCH

Endpoint

quotes/{quoteId}

Request Parameter

The following URL parameter is used to pass the quote ID. This quote was generated previously using the POST/quotes API and its ID was retrieved using the GET/quotes API.

Parameters

Values

quoteID

75723d17-937e-4213-89f8-41a8f2c81594

Request URL

https://<URL_of_the_Instance>/api/quote/v1/quotes/75723d17-937e-4213-89f8-41a8f2c81594

Request Body

The below sample code updates the Billing To Account field associated with the quote named Tier_1 with 75723d17-937e-4213-89f8-41a8f2c81594 ID, which was generated in the section Creating Quotes. To update a single quote, you must pass the entire object with updated fields where required.

In this example, Billing To Account field is changed from null to the following values:

"BillToAccount": 
	{
    	"Id": "e60f1de6-6b54-4304-a600-31c226b842db",
    	"Name": "AutoQuoteRLPAccount_"
  	}
Request Body Expand source
{
  "ABOType": "New",
  "Account": {
    "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
    "Name": "AutoQuoteRLPAccount_"
  },
  "Amount": null,
  "ApprovalStage": "Draft",
  "AutoActivateOrder": false,
  "AutoCreateBill": false,
  "AutoCreateRevenue": false,
  "BillingPreference": null,
  "BillToAccount": {
    "Id": "e60f1de6-6b54-4304-a600-31c226b842db",
    "Name": "AutoQuoteRLPAccount_"
  },
  "ConfigurationEffectiveDate": null,
  "ConfigurationFinalizedDate": null,
  "ConfigurationSyncDate": null,
  "Currency": "USD",
  "Description": "AutoQuoteService_Description1667823791262_57",
  "DisableCartVersioning": false,
  "DiscountPercent": null,
  "ExpectedEndDate": null,
  "ExpectedStartDate": null,
  "GrandTotal": null,
  "Intent": null,
  "InternalDeadline": null,
  "IsAutoAccepted": false,
  "IsPrimary": true,
  "IsSystemGenerated": false,
  "IsTaskPending": false,
  "LegalEntity": null,
  "Location": {
    "Id": "7b363b21-2d8b-4277-b14e-0698ccd6bbd8",
    "Name": "Ahmedabad"
  },
  "NetAmount": null,
  "Opportunity": {
    "Id": "9129aa7e-2ad5-430f-b456-49d62eeaed87",
    "Name": "AutoQuoteRLPOpportunity"
  },
  "ParentProposal": null,
  "PartnerAccount": null,
  "ProposalPaymentTerm": "Net 30 Days",
  "PaymentTerm": null,
  "PODate": null,
  "PONumber": null,
  "PresentedDate": null,
  "PriceList": {
    "Id": "b01c1010-9381-4335-88a5-8323378b86a0",
    "Name": "Auto_IncOtoOPromptELevel2_PL001"
  },
  "PricingDate": null,
  "PrimaryContact": null,
  "ProposalApprovalDate": null,
  "ProposalCategory": "Quote",
  "ProposalExpirationDate": null,
  "ProposalName": null,
  "PurchaseId": null,
  "QTCProfile": null,
  "ReadyForActivationDate": null,
  "ReadyForBillingDate": null,
  "ReadyForFulfillmentDate": null,
  "ReadyForRevRecDate": null,
  "ReadyToGenerate": true,
  "ReadyToPresent": true,
  "RelatedProposal": null,
  "RFPIntakeDate": null,
  "RFPResponseDueDate": null,
  "RFPStage": null,
  "RFPValue": null,
  "RiskFactors": null,
  "SalesTaxAmount": null,
  "SalesTaxPercent": null,
  "ShippingHandling": null,
  "ShipToAccount": null,
  "SingleTransactionAdjustment": false,
  "SourceChannel": "Direct",
  "SpecialTerms": null,
  "StrategicImportance": null,
  "SyncAssetChangesToQuote": true,
  "UseType": "Main",
  "ValidUntilDate": null,
  "Id": "75723d17-937e-4213-89f8-41a8f2c81594",
  "Name": "Tier_1",
  "CreatedBy": {
    "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "Name": "Test Manish User"
  },
  "CreatedDate": "2022-12-27T18:54:56",
  "ModifiedBy": {
    "Id": "d717a075-9cbf-480c-b230-837e0e6dee75",
    "Name": "Test Manish User"
  },
  "ModifiedDate": "2022-12-28T07:31:08",
  "ExternalId": null,
  "QuoteAuto_PickList_CstField_c": null,
  "QuoteAuto_String_CstField_c": null,
  "QuoteAuto_Double_CstField_c": null,
  "QuoteAuto_Int_CstField_c": null,
  "QuoteAuto_Boolean_CstField_c": null,
  "QuoteAuto_Currency_CstField_c": null,
  "QuoteAuto_DateTime_CstField_c": null,
  "QuoteAuto_Multipicklist_CstField_c": null
}

Response

The API returns the updated quote object.