Get Bill Details Action

Retrieve detailed line item information for a specific bill from an external billing system.

This action is available in API version 60.0 and later.

Special Access Rules

The Get Bill Details action is available in Enterprise and Unlimited Editions with Energy and Utilities Cloud.

Supported REST HTTP Methods

URI
/services/data/v60.0/actions/standard/getBillDetails
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
externalBillId
Type
string
Description

Required.

ID of the bill in the external billing system.

Outputs

Output Details
billLineItems
Type
string array[]
Description
List of JSON strings, each containing details for one line item on the bill, such as charge type, amount, usage, and unit of measure.

Example

POST

This sample request is for the Get Bill Details action.

1{
2  "inputs": [
3    {
4      "externalBillId": "B123"
5    }
6  ]
7}

This sample response is for the Get Bill Details action.

1[
2  {
3    "actionName": "getBillDetails",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outputValues": {
8      "billLineItems": [
9        "{\"lineType\":\"Energy Charge\",\"amount\":120.00,\"usage\":1000,\"uom\":\"kWh\"}",
10        "{\"lineType\":\"Service Fee\",\"amount\":25.50}"
11      ]
12    },
13    "sortOrder": -1,
14    "version": 1
15  }
16]