Create Quote for Home Visits Action | Salesforce Health Cloud Developer Guide

This action is available in API version 63.0 and later.

Special Access Rules

The Create Quote for Home Visits action is available when Home Health is enabled. This action is available to users that have access to Home Health Quote perm set.

Supported REST HTTP Methods

URI: /services/data/v63/actions/standard/createQuoteForHomeVisits
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearertoken

Inputs

Input	Details
quoteName	Type String Description Required The name of the quote to be created for a patient's home visits.
priceBookId	Type String Description Required The ID of the price book to use to create the quote for a patient's home visits.
accountId	Type String Description The person account ID of the patient for whom the quote is to be created.
opportunityId	Type String Description The ID of the opportunity to use to create the quote for a patient's home visits.
startDateTime	Type DateTime Description The date and time when the quote takes effect.
endDateTime	Type DateTime Description The date and time after which the quote is no longer valid.
workTypeIds	Type List<String> Description The collection of IDs of work types that the quote is created for.
visitCount	Type Integer Description The number of home visits that the quote is created for.
isTravelInventoryIncluded	Type Boolean Description Indicates whether the travel and inventory associated with the home visit are included in the quote.
resourceTravelDistance	Type Double Description The distance that a care resource has to travel to provide home healthcare to the patient.
pricingPreference	Type String Description The attribute-based pricing preference that's used as an input in the PlaceQuote API for creating the quote. Possible values are: `System` `Force` `Skip`. The default value is `System`.
currencyCode	Type String Description The currency code to be used in the quote.
productPricingAttributeDetails	Type List<Object> Description A collection of Apex heathcloudext_productPricingAttributeDetails records that contain the pricing attribute details for the products included in the quote.

Outputs

Output	Details
quoteId	Type String Description The ID of the quote record that was created for the patient's home visits.
errorMessage	Type String Description The description of the error encountered while creating the quote.
errorCode	Type String Description The code of the error encountered while creating the quote.

Example

POST

This sample request is for the Create Quote for Home Visits action.

1 {
2  "inputs": [
3    {
4      "quoteName": "Quote For Charles",
5      "priceBookId": "01sxx0000005qWXAAY",
6      "accountId": "001xx000003GaC7AAK",
7      "startDateTime": "2024-08-18T00:00:00.000Z",
8      "endDateTime": "2024-08-25T00:00:00.000Z",
9      "workTypeIds": [
10        "08qxx0000004C92AAE"
11      ],
12      "visitCount": 2,
13      "isTravelInventoryIncluded": false,
14      "productPricingAttributeDetails": [
15        {
16          "productId": "08qxx0000004C92AAE",
17          "unitCount": 1,
18          "pricingAttributeList": [
19            {
20              "attributeDefinitionId": "dayBasedAttributeDefinitionId",
21              "attributeValue": "Sunday"
22            }
23          ]
24        }
25      ]
26    }
27  ]
28}

This sample response is for the Create Quote for Home Visits action.

1{
2  "actionName": "createQuoteForHomeVisits",
3  "isSuccess": true,
4  "outputValues": {
5    "quoteId": "0Q0XXXXXXXXXXXXXXX",
6    "errorMessage": null,
7    "errorCode": null
8  }
9}