Account
GET
12 endpoints
/api/v202105/account/{accountId}/udf/{udfId}/download
DownloadAccountCustomFieldFileV202105
Downloads the file attached to an account's custom field (UDF)
/api/v3/account/{accountId}/alert
GetAccountAlertsV3
Retrieves all alerts (notifications and notes) associated with a specific account
/api/v3/account/{accountId}/alert/{alertId}
GetAccountAlertV3
Retrieves a single alert by its identifier for a specific account
/api/v202506/account/{accountId}/auditSetting
GetAccountAuditSettingsV202506
Retrieves all account-level audit setting overrides for a specific account
/api/v3/account/{accountId}/rate
GetAccountRatesV3
Retrieves all rate/tariff assignments for an account's meters
/api/v3/account/udf
GetAccountsUdfsV3
Retrieves user-defined field (custom field) values for all accounts in a paginated, filterable list
/api/v3/account
GetAccountsV3
Retrieves a paginated list of all accounts, with optional filtering
/api/v3/account/{accountId}/template
GetAccountTemplatesV3
Retrieves all bill entry templates assigned to an account's meters
/api/v3/account/{accountId}/udf
GetAccountUdfsV3
Retrieves all user-defined field (custom field) definitions and their current values for a specific account
/api/v3/account/{accountId}
GetAccountV3
Retrieves a single account by its unique identifier
/api/v3/account/{accountId}/billingPeriod
GetDefaultBillingPeriodV3
Calculates the recommended billing period (YYYYMM) for a bill based on the account's billing cycle and the bill's date range
/api/v3/account/search
SearchAccountsV3
Searches for accounts by free-text query, matching against account code, address, old account code, meter serial number, or meter address
POST
2 endpoints
PUT
11 endpoints
/api/v3/account/{accountId}/codeversion
EditAccountCodeVersionV3
Updates an account's account code and optionally its description, preserving the previous code in the account's code history
/api/v3/account/{accountId}/udf
EditAccountUDFsV3
Updates user-defined field (custom field) values for a specific account
/api/v202401/account/{accountId}
Deprecated
EditAccountV202401
Edits an existing account's properties
/api/v202507/account/{accountId}
Deprecated
EditAccountV202507
Edits an existing account's properties
/api/v202511/account/{accountId}
EditAccountV202511
Edits an existing account's properties including account code, info, vendor, status, address, and BillCapture settings
/api/v3/account/{accountId}
Deprecated
EditAccountV3
Edits an existing account's properties such as account code, vendor, status, or address
/api/v3/parentCostCenter/{parentCostCenterId}/account
MoveAccountV3
Moves one or more accounts to a new parent cost center in the organizational hierarchy
/api/v202211/account/customAction
ProcessAccountCustomActionV202211
Fires a custom account action webhook for one or more accounts
/api/v202104/account/auditEnabled
SetAccountAuditExclusionV202104
Enables or disables bill auditing for a batch of accounts
/api/v3/account/{accountId}/alert/{alertId}
UpdateAccountAlertV3
Updates an existing alert's message text or type on an account
/api/v202506/account/{accountId}/auditSetting
UpdateAccountAuditSettingsV202506
Update audit settings for an account.
Every audit must be included but supplying null for its settings will remove them.