List

GET 13 endpoints

Get the shared users and user groups for a list. You must have created the list and have SharedBillLists Create permission or have BillListAdministrator Manage permission or must have created the list and have SharedRecordsLists Create permission or have RecordsListAdministrator Manage permission

/api/v3/list GetListsV3

Get lists. For a list to be returned you must have created the list or have access to it.

/api/v3/list/{listId}/data GetListWithDataV3

Get the definition and data for a list. For a list to be returned you must have created the list or have access to it.

/api/v3/list/{listId}/data/excelexport ListExportV3

Export list data to excel spreadsheet format

/api/v3/meter/{meterId}/list/bill/excelexport MeterBillListExcelExportV3

Export list data to excel spreadsheet format

/api/v3/meter/{meterId}/list/bill MeterBillListV3

Get the meter bills list

POST 8 endpoints

/api/v3/account/{accountId}/list/bill/generateimport AccountExportHistoricalBillListV3

Generate a bill import file from all bills in an account bill list.

/api/v3/list/{listId} CreateAndCopyListV3

Create a new list as a copy of an existing list

/api/v3/list CreateDefaultListV3

Create a new list with default list settings

/api/v3/list/{listId}/bill/generateimport ExportHistoricalBillListV3

Generate a bill import file from bills in a list.

/api/v3/dynamiclist/{listTypeId} GetDynamicListWithDataV3

Get the definition and data for a list type

/api/v3/meter/{meterId}/list/bill/generateimport MeterExportHistoricalBillListV3

Generate a bill import file from all bills in a meter bill list.

/api/v3/list/{listId}/reset ResetListV3

Reset a list to its default columns and filters. For a list to be reset you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you.

/api/v3/list/{listId}/split SplitBillListV3

Split all bills eligible to be split in a bill list

PUT 39 endpoints

/api/v3/account/{accountId}/list/bill/approve AccountBillListApproveV3

Approve/unapprove account bills

/api/v3/account/{accountId}/list/bill/customAction AccountBillListCustomActionV3

Fires a custom bill action on an account bill list. Custom bill actions are setup as webhooks.

/api/v3/account/{accountId}/list/bill/exporthold AccountBillListExportHoldV3

Hold/release account bills for export

/api/v3/account/{accountId}/list/bill/export AccountBillListExportV3

Export all account bills to ap or gl Maximum of 10000 bills can be processed at one time.

/api/v3/account/{accountId}/list/bill/unexport AccountBillListUnexportV3

Unexport account bills

/api/v3/account/{accountId}/list/bill/void AccountBillListVoidV3

Void/unvoid account bills

/api/v3/list/{listId}/approve ApproveBillListV3

Approve/unapprove bill list

/api/v3/list/{listId}/customAction BillListCustomActionV3

Fires a custom bill action on a bill list

/api/v202104/list/{listId}/distributeAccountCharges DistributeAccountChargesToMetersForBillsInListV202104

For each bill in the provided list 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.

/api/v3/list/{listId}/column EditListColumnsV3

Edit the column definition for the list. For list columns to be edited you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you.

/api/v3/list/{listId}/filter EditListFiltersV3

Set list filters If a filter exists in the database, but is not passed in it will be deleted. For list filters to be edited you must have created the list or have BillListAdministrator Manage permission and the list is shared with anyone or have SharedBillList Edit permission and the list is shared with you.

/api/v3/list/{listId}/share EditListShareV3

Update the shared users and user groups for a list. To remove sharing completely set SharedWithEveryone to false, SharedUserIds to [], and SharedUserGroupIds to []. You must have created the list and have SharedBillLists Create permission or have BillListAdministrator Manage permission or must have created the list and have SharedRecordsLists Create permission or have RecordsListAdministrator Manage permission

/api/v3/list/{listId}/visible EditListShareVisibilityV3

Update the visibility of a list for the current user. You must have created the list or have access to it.

/api/v3/list/{listId} EditListV3

Edit a list

/api/v3/list/{listId}/export ExportBillListV3

Export all bills in a list to ap or gl Maximum of 10000 bills can be processed at one time.

/api/v3/list/{listId}/exporthold ExportHoldBillListV3

Hold/release bill list for export

/api/v3/list/{listId}/flagAction FlagBillListActionV3

Create and/or update flags for all bills in a list

/api/V202502/list/{listId}/flagIssueAction FlagIssueBillListActionV202502

Update flag issuess for all issues in a list

/api/v3/account/{accountId}/list/bill/possibleDestinationAccounts GetPossibleDestinationAccountsForAccountListV3

Retrieves a list of Accounts that contain meters of ALL of the commodities represented by the given Account's Bill List

/api/v3/list/{listId}/possibleDestinationAccounts GetPossibleDestinationAccountsForListV3

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

/api/v3/meter/{meterId}/list/bill/approve MeterBillListApproveV3

Approve/unapprove meter bills

/api/v3/meter/{meterId}/list/bill/customAction MeterBillListCustomActionV3

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

/api/v3/meter/{meterId}/list/bill/exporthold MeterBillListExportHoldV3

Hold/release meter bills for export

/api/v3/meter/{meterId}/list/bill/export MeterBillListExportV3

Export all meter bills to ap or gl Maximum of 10000 bills can be processed at one time.

/api/v3/meter/{meterId}/list/bill/unexport MeterBillListUnexportV3

Unexport meter bills

/api/v3/meter/{meterId}/list/bill/void MeterBillListVoidV3

Void/unvoid meter bills

/api/v3/account/{accountId}/list/bill/moveBills MoveBillsToAccountFromAccountListV3

Moves the bills from the given Account's Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name="accountId"> Account for the Bill List containing a list of bills that should be moved. All bills from this Account's Bill List will be moved. </param><param name="dto"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param>

/api/v3/list/{listId}/moveBills MoveBillsToAccountFromListV3

Moves the bills from the given Bill List to the specified destination Account and Meters. Each source Meter will be matched with a corresponding destination Meter based on commodity. <param name="listId"> Bill List containing a list of bills that should be moved. All bills from this list will be moved. </param><param name="dto"> DTO containing the destination Account Id, the destination AcountMeter Ids, a flag indicating whether the Account GL information should be updated, a flag indicating whether the Meter GL information should be updated, and a flag indicating whether linked emissions record scope and GHG factors should be updated. WARNING: If emissions record scope categories and GHG factors are updated, any notes and/or attachments on those emissions records will be lost. </param>

/api/v3/account/{accountId}/list/bill/reverse ReverseAccountBillListV3

Reverses all bills on an account bill list

/api/v3/list/{listId}/reverse ReverseBillListV3

Reverses all bills on a bill list

/api/v3/meter/{meterId}/list/bill/reverse ReverseMeterBillListV3

Reverses all bills on a meter bill list

/api/v3/account/{accountId}/list/bill/accrualExclusion SetAccountBillListAccrualExclusionV3

Excludes or undoes exclusion of bills from accruals

/api/v3/list/{listId}/accrualExclusion SetBillListAccrualExclusionV3

Excludes or undoes exclusion of bills from accruals

/api/v3/meter/{meterId}/list/bill/accrualExclusion SetMeterBillListAccrualExclusionV3

Excludes or undoes exclusion of bills from accruals

/api/v3/list/{listId}/unexport UnexportBillListV3

Unexport bill list

/api/v3/account/{accountId}/list/bill/billHeaders UpdateAccountBillListHeadersV3

Updates bill headers for the bills for an account's bill list Audits won't be fired

/api/v3/list/{listId}/billHeaders UpdateBillListHeadersV3

Update all headers for a bill list 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 Bills audits won't be fired

/api/v3/meter/{meterId}/list/bill/billHeaders UpdateMeterBillListHeadersV3

Updates bill headers for all bills on a meter bill list Audits won't be fired

/api/v3/list/{listId}/void VoidBillListV3

Void/unvoid bill list

DELETE 4 endpoints

/api/v3/account/{accountId}/list/bill/data AccountBillListDeleteBillsV3

Delete all bills for account

/api/v3/list/{listId}/data DeleteBillsInBillListV3

Delete all bills in a bill list

/api/v3/list/{listId} DeleteListV3

Delete a list. For a list to be deleted you must have created the list or have Manage permission and the list is shared with anyone.

/api/v3/meter/{meterId}/list/bill/data MeterBillListDeleteBillsV3

Delete all bills for meter