EnergyCAP Developer

Update all headers for a given list of bills
If a new begin date or end date is being set, bills that would have end dates on or before their begin date will not be updated
If the user does not have permission to edit exported or approved bills, those bills will not be updated
Bill audits won’t be fired

Put /api/v3/bill/approve

Operation: BillActionApproveV3 Permissions: ApproveBills (Manage)

Update approved flag for the given billIDs

Put /api/v3/bill/exporthold

Operation: BillActionExportHoldV3 Permissions: ExportHold (Manage)

Update export hold flag for the given billIDs

Post /api/v3/bill/delete

Operation: BillActionDeleteV3 Permissions: BillsAndBatches (Delete)

Delete given billIDs

Put /api/v3/bill/possibleDestinationAccounts

Operation: GetPossibleDestinationAccountsV3 Permissions: MoveExistingBills (Manage)

Retrieves a list of accounts that contain meters of ALL of the commodities represented by the given Bills

Put /api/v3/bill/moveBills

Operation: MoveBillsToAccountV3 Permissions: MoveExistingBills (Manage)

Moves the list of given bills to the specified destination account and meters. Each source Meter will be matched with
a corresponding destination Meter based on commodity.

Get /api/v3/bill/billaccountmeter/actual

Operation: GetBillAccountMetersActualV3 Permissions: BillsAndBatches (View) Paginated

Retrieves bill account meter records

Get /api/v3/bill/{billId}/billaccountmeter/actual

Operation: GetBillAccountMeterActualByBillIdV3 Permissions: BillsAndBatches (View)

Retrieves bill account meter record for a specific billId

Get /api/v3/bill/billaccountmeter/calendarized

Operation: GetBillAccountMetersCalendarizedV3 Permissions: BillsAndBatches (View) Paginated

Retrieves bill account meter calendarized records

Get /api/v3/bill/{billId}/billaccountmeter/calendarized

Operation: GetBillAccountMeterCalendarizedByBillIdV3 Permissions: BillsAndBatches (View)

Retrieves bill account meter calendarized record for a specific billId

Get /api/v3/bill/billaccountmeter/normalized

Operation: GetBillAccountMetersNormalizedV3 Permissions: BillsAndBatches (View) Paginated

Retrieves bill account meter normalized records

Get /api/v3/bill/{billId}/billaccountmeter/normalized

Operation: GetBillAccountMeterNormalizedByBillIdV3 Permissions: BillsAndBatches (View)

Retrieves bill account meter normalized record for a specific billId

Get /api/v3/bill/billaccountmeter/statistics

Operation: GetBillAccountMetersStatisticsV3 Permissions: BillsAndBatches (View) Paginated

Retrieves bill account meter statistics records

Get /api/v3/bill/{billId}/billaccountmeter/statistics

Operation: GetBillAccountMeterStatisticsByBillIdV3 Permissions: BillsAndBatches (View)

Retrieves bill account meter statistics record for a specific billId

Get /api/v3/account/{accountId}/billEntry

Operation: GetBillEntryDataV3 Permissions: BillsAndBatches (Create)

Retrieves all data necessary to load the bill entry screen

Get /api/v3/account/{accountId}/billHistory

Operation: GetAccountBillHistoryV3 Permissions: BillsAndBatches (View)

Retrieves bill history for an account

Get /api/v3/bill/{billId}/billEntry

Operation: GetBillEntryDataByBillIdV3 Permissions: BillsAndBatches (View)

Retrieves all data necessary to load the bill entry screen

Get /api/v3/bill/{billId}/billHistory

Operation: GetBillHistoryV3 Permissions: BillsAndBatches (View)

Retrieves bill history from starting at the billId billing period

Put /api/v3/bill/export

Operation: ExportBillsV3 Permissions: ExportBills (Run)

Retrieves text of a standard EnergyCAP bill export file for AP and GL purposes.
Maximum of 10000 bills can be processed at one time.
Only bills with the following conditions are included in the export file:
1) approved bills (if the approval system is enabled in workflow settings)
2) bill is in a closed batch (if after batch or after batch approval is set in the workflow settings)
3) bill is not held for export
4) bill is not void
5) bill is within the user’s topmost setting.
6) bill in not already exported

Put /api/v3/bill/unexport

Operation: UnexportBillsV3 Permissions: ExportBills (Run)

Marks one or more bills as unexported.

Put /api/v3/bill/unexport/{billExportGuid}

Operation: UnexportBillsByGuidV3 Permissions: ExportBills (Run)

Marks one or more bills as unexported. The bills to be unexported are selected based on the guid passed in.
The guid is generated when bills are exported via the bill export end point, and the guid is returned in the header of the response in a field named Ec-Guid.

Get /api/v3/bill/exportProfile

Operation: ExportBillProfileV3

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.

Post /api/v3/bill/split

Operation: BillActionSplitV3 Permissions: Chargebacks (Run)

Run the bill split processor on the given list of bills.
Optional note can be provided.
Optional batch settings can be provided that will allow custom batchcode and bill headers for the destination bills

Put /api/v3/bill/cleanBill

Operation: CleanDirtyBillsV3 Permissions: BillsAndBatches (Edit)

Cleans all dirty bills, and any bills created outside of version 7.

Put /api/v3/bill/cleanBill/{billId}

Operation: CleanABillV3 Permissions: BillsAndBatches (Edit)

Cleans a single bill. The dirty flag of the bill is not taken into account.

Put /api/v3/bill/customAction

Operation: ProcessBillCustomActionV3 Permissions: BillsAndBatches (Edit)

Fires a custom bill action. Custom bill actions are setup as webhooks

Put /api/v3/bill/reverse

Operation: ReverseBillsV3 Permissions: BillsAndBatches (Edit)

Creates reversal bills for the given bill ids

Put /api/v3/bill/accrualExclusion

Operation: SetBillAccrualExclusionV3 Permissions: AccrualSettings (Manage)

Excludes or undoes exclusion of bills from accruals

Get /api/v202406/bill/billLineTypeMapping

Operation: GetBillLineTypeMappingsV202406 Permissions: BillCAPture (View)

Retrieves a list of bill line type mappings

Post /api/v202405/bill/export/json

Operation: ExportBillsAsJsonV202405 Permissions: BillsAndBatches (View)

Retrieves a JSON array of bill details.

Put /api/v202401/bill/billPaymentDetails

Operation: BillPaymentDetailsV202401 Permissions: BillsAndBatches (Edit)

For each record in the request body, update the bill payment details.

Get /api/v202202/bill/{billId}/udf

Operation: GetBillCustomFieldsV202202 Permissions: BillsAndBatches (View)

Get custom field values for a bill

Put /api/v202202/bill/{billId}/udf

Operation: EditBillCustomFieldsV202202 Permissions: BillsAndBatches (Edit)

Edit the custom field values on a bill

Get /api/v202202/bill/{billId}/udf/{udfId}/download

Operation: DownloadBillCustomFieldFileV202202 Permissions: BillsAndBatches (View)

Download file for a bill custom field

Put Deprecated /api/v202108/bill/billPaymentDetails

Operation: BillPaymentDetailsV202108 Permissions: BillsAndBatches (Edit)

For each record in the request body, update the bill payment details.

Put /api/v202108/bill/billPaymentDetailsFile

Operation: BillPaymentDetailsFileV202108 Permissions: BillsAndBatches (Edit)

For each bill in the import file, update the bill payment details.

Put /api/v202104/bill/distributeAccountCharges

Operation: DistributeAccountChargesToMetersV202104 Permissions: BillsAndBatches (Edit)

For each bill in the request body which has account-level charges, distribute these account charges amongst the meters on the bill.
This is done proportionally by meter use or cost, depending on the split basis.
Maximum of 10000 bills can be processed at one time.