Waterfall Download Output

The response containing the pricing waterfall data for the requested line items.

JSON example

1{
2  "success": true,
3  "message": null,
4  "code": "200",
5  "lineItemResults": [
6    {
7      "currencyCode": "USD",
8      "error": null,
9      "executionEndTimestamp": "2023-07-31T20:11:29.625Z",
10      "executionId": "gdLVwn2x1uats2xWMAjV",
11      "executionStartTimestamp": null,
12      "lineItemId": "item1",
13      "success": true,
14      "usageType": "Pricing",
15      "output": {
16        "quantity": "10",
17        "netUnitPrice": "10",
18        "subtotal": "100"
19      },
20      "waterfall": []
21    },
22    {
23      "currencyCode": "USD",
24      "error": null,
25      "executionEndTimestamp": "2023-07-31T20:12:15.000Z",
26      "executionId": "hdMWxo3y2vbut3xXNBlW",
27      "executionStartTimestamp": null,
28      "lineItemId": "item2",
29      "success": true,
30      "usageType": "Pricing",
31      "output": {
32        "quantity": "5",
33        "netUnitPrice": "8",
34        "subtotal": "40"
35      },
36      "waterfall": []
37    }
38  ]
39}

Properties

Property Name	Type	Description
`success`	Boolean	Indicates whether the request finished normally and returned waterfall data for at least one line item (`true`), or whether the request was invalid, every line item failed, or an unhandled exception occurred (`false`).
`message`	String	A failure message, if applicable.
`code`	String	The API response code. Returns `200` when the request is processed successfully, including partial success. Returns `500` when the request is invalid, when all line items fail, or when an unhandled exception occurs.
`lineItemResults`	List<Line Item Waterfall Response>	An array of waterfall results for each requested line item.

Agentforce Life Sciences Developer Guide

Waterfall Download Output