GET /api/v3/bill/exportProfile

Retrieves the text of a standard EnergyCAP bill export ini file for AP, GL and Payment purposes. Payment details will be included in the profile if workflow settings for the bill export are configured to include payment details.

ExportBillProfileV3

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Query Parameters

Name Description Type Required
exportMode Specifies whether the profile should be for AP, GL or Payment. Pass in “AP” for AP Profile, “GL” for GL Profile or “Payment” for Payment Profile. If this is not included in the request, it defaults to AP. string Optional

Responses

200 OK The request succeeded and the response body contains the requested data.